Skip to content

Simple Android library search extension for your WebView

Notifications You must be signed in to change notification settings

Y-E-P/BrowserFiP

Repository files navigation

BrowserFiP

An Android library that lets you extend your WebView with Search Bar like in Chrome Browser function "Find in page".

Setup

First of all, include the dependency in your app build.gradle: Add it to your build.gradle with:

allprojects {
    repositories {
        maven { url "https://jitpack.io" }
    }
}

and:

dependencies {
    implementation 'com.github.Y-E-P:BrowserFiP:1.0.5'
}

Add View

After successfully installing dependencies add FiPSearchView in your xml:

<com.yupo.browserfiplib.FiPSearchView
    android:id="@+id/search"
    android:layout_width="match_parent"
    android:layout_height="?attr/actionBarSize"
    app:fip_hint="Your hint"
    app:fip_next_icon="@drawable/ic_your_icon"
    app:fip_previous_icon="@drawable/ic_your_icon"
    app:fip_close_icon="@drawable/ic_your_icon"
    app:fip_divider_color="@color/your_color"
    app:fip_divider_visible="true"
    app:fip_counter_empty_color="@color/your_color"
    app:fip_counter_matched_color="@color/your_color"
    app:fip_hint_color="@color/your_hint_color"
    app:fip_text_color="@color/your_text_color"
/>

All attributes are optional.

Usage

To use lib with your WebView you should pass WebView ass parameter.

val fip : FiPSearchView = findViewById(R.id.fipSearch)
fip.setupSearchComponent(yorWebView)

FiP has a builder method that allowed you to customize the appearance

fip?.setupView {
        hint = //your hint
        nextArrowIcon = //your next arrow icon
        previousArrowIcon = //your previous arrow icon
        closeArrowIcon = //your close arrow icon
        dividerVisibility = //your divider visibility state true or false
        dividerColor = //your divider color
        counterEmptyColor = //your couter color
        counterMatchedColor = //your counter matched color 
        textColor = // your text color
        hintColor = // your hint color
}

Release resources after using FiPSearch(for example in onDestroy(Activity) or onDestroyView(Fragment))

fip.release()

Also there are ability to subscribe on actions, like clicking on button NEXT, PREVIOUS and CLOSE. For this add following line of code:

fip.onNavigationClicked = { event->
    when (event) {
        FiPSearchView.ClickEvent.NEXT -> {}
        FiPSearchView.ClickEvent.PREVIOUS -> {}
        FiPSearchView.ClickEvent.CLOSE -> {}
    }
}

Also you can check sample app code.

Contribute

Feel free to contribute, let's make library more better.

License

  Copyright (c) 2023 Yurii Poudanien
 
  Licensed under the Apache License, Version 2.0 (the "License");
  you may not use this file except in compliance with the License.
  You may obtain a copy of the License at
 
  http://www.apache.org/licenses/LICENSE-2.0
 
  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.