Floating Search View

Additional

Language
Java
Version
N/A
Created
Nov 22, 2015
Updated
Jan 22, 2019
Owner
Ari Cheshin (arimorty)
Contributors
robbypond
Ari Cheshin (arimorty)
aulisius
CillianMyles
Gloix
Permusoft
6
Activity
Badge
Generate
Download
Source code
APK file

Commercial

Floating Search View

An implementation of a floating search box with search suggestions, also called persistent search bar.

Note

This project is not being actively maintained. Have a look here for information that might help you make changes to your own copy of the code base.

...

Usage

  1. In your dependencies, add
         compile 'com.github.arimorty:floatingsearchview:2.1.1'
    
  2. Add a FloatingSearchView to your view hierarchy, and make sure that it takes up the full width and height of the screen
  3. Listen to query changes and provide suggestion items that implement SearchSuggestion

Example:

       <com.arlib.floatingsearchview.FloatingSearchView
                android:id="@+id/floating_search_view"
                android:layout_width="match_parent"
                android:layout_height="match_parent"
                app:floatingSearch_searchBarMarginLeft="@dimen/search_view_inset"
                app:floatingSearch_searchBarMarginTop="@dimen/search_view_inset"
                app:floatingSearch_searchBarMarginRight="@dimen/search_view_inset"
                app:floatingSearch_searchHint="Search..."
                app:floatingSearch_suggestionsListAnimDuration="250"
                app:floatingSearch_showSearchKey="false"
                app:floatingSearch_leftActionMode="showHamburger"
                app:floatingSearch_menu="@menu/menu_main"
                app:floatingSearch_close_search_on_keyboard_dismiss="true"/>
  mSearchView.setOnQueryChangeListener(new FloatingSearchView.OnQueryChangeListener() {
              @Override
              public void onSearchTextChanged(String oldQuery, final String newQuery) {

                  //get suggestions based on newQuery

                  //pass them on to the search view
                  mSearchView.swapSuggestions(newSuggestions);
              }
          });

Left action mode:

The left action can be configured as follows:

Add

   app:floatingSearch_leftActionMode="[insert one of the options from table below]"



showHamburger
showSearch
showHome
noLeftAction

Listen to hamburger button clicks:

 mSearchView.setOnLeftMenuClickListener(
        new FloatingSearchView.OnLeftMenuClickListener() { ...} );          

To quickly connect your NavigationDrawer to the hamburger button:

   mSearchView.attachNavigationDrawerToMenuButton(mDrawerLayout);

Listen to home (back arrow) button clicks:

  mSearchView.setOnHomeActionClickListener(
         new FloatingSearchView.OnHomeActionClickListener() { ... });       

Configure menu items:

Add a menu resource

 app:floatingSearch_menu="@menu/menu_main"

In the menu resource, set items'

app:showAsAction="[insert one of the options described in the table below]"neverPuts the menu item in the overflow options popupifRoomShows an action icon for the menu if the following conditions are met: 1. The search is not focused. 2. There is enough room for it. alwaysShows an action icon for the menu if there is room, regardless of whether the search is focused or not.

Listen for item selections

Configure suggestion item:

First, implement SearchSuggestion

Optional:

Set a callback for when a given suggestion is bound to the suggestion list.

For the history icons to show, you would need to implement this. Refer to the sample app for an example implementation.

Styling:

Available styling:

mSearchView.setOnBindSuggestionCallback(new SearchSuggestionsAdapter.OnBindSuggestionCallback() { @Override public void onBindSuggestion(View suggestionView, ImageView leftIcon, TextView textView, SearchSuggestion item, int itemPosition) { //here you can set some attributes for the suggestion's left icon and text. For example, //you can choose your favorite image-loading library for setting the left icon's image. } });

mSearchView.setOnMenuItemClickListener(new FloatingSearchView.OnMenuItemClickListener() { @Override public void onMenuItemSelected(MenuItem item) { } });