Git Product home page Git Product logo

browserfip's Introduction

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.
 

browserfip's People

Contributors

sdex avatar y-e-p avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Forkers

sdex dhayananthv

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.