zetbaitsu / floatingsearchview

A search view that implements a floating search bar also known as persistent search

Floating Search View

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

Usage

1. In your dependencies, add

        compile 'com.github.arimorty:floatingsearchview:2.0.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"/>

  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() { ...} );          

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]"

never	Puts the menu item in the overflow options popup
ifRoom	Shows 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.
always	Shows an action icon for the menu if there is room, regardless of whether the search is focused or not.

Listen for item selections

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

Configure suggestion item:

First, implement SearchSuggestion

Optional:

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

   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. 
            }

        });

Styling:

Available styling:

   <style name="SearchView">
           <item name="floatingSearch_backgroundColor"></item>
           <item name="floatingSearch_viewTextColor"></item>
           <item name="floatingSearch_hintTextColor"></item>
           <item name="floatingSearch_dividerColor"></item>
           <item name="floatingSearch_clearBtnColor"></item>
           <item name="floatingSearch_leftActionColor"></item>
           <item name="floatingSearch_menuItemIconColor"></item>
           <item name="floatingSearch_suggestionRightIconColor"></item>
           <item name="floatingSearch_actionMenuOverflowColor"></item>
    </style>

Are you using this library?

If you have any questions, issues, or just want to let me know how you are using this library, feel free to create a new issue and let me know. All feedback is well appreciated!

License

Copyright (C) 2015 Ari C.

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.