PersistentSearch

An Android Persistent Search Bar like the one in Google Now and the Google Play Store. It follows Google's Material Design while highly customizable

Features

• PersistentSearchView that is the Persistent Search Bar
• Support for LTR and RTL layouts
• Support for custom drawables in all image locations
• Support for showing up to 5 items in a Search Menu that is active when the Search Bar is active
• Search Menu Items are customizable with 2 icons and a title
• Option to turn off the Search Menu

Examples

Include in your project

It is hosted on Jcenter, so it is easy to add to your android project. Just follow the step below.

Add a dependency to your build.gradle:

dependencies {
    compile 'com.wanderingcan.widget:persistentsearch:1.2.2'
}

Change Log

1.2.2

• Fixed layout issue when increasing the card elevation
• Fixed layout issue for the text inside the search bar

1.2.0

• Added Drawable Tinting to SearchMenuItem
• Updated Support Library to 25.1.0

1.1.0

• Added a DrawerArrowDrawable to allow easy use of a drawable that animates between "Drawer hamburger" menu or an arrow
• Added new samples to show how to use the DrawerArrowDrawable (DrawerActivity)
• Added Voice Recognition to the main sample (SearchActivity)

1.0.1

• Added missing methods for setting if the hint should be shown at all times in the PersistentSearchView
• Changed SearchMenuItem order to be mutable instead of having it mutable

Usage

Persistent Search View

The PersistentSearchView has been created to be easy to use and highly customizable. But due to the customizability, it doesn't do much hand holding when it comes to drawables.

XML

Here is an example of PersistentSearchView's xml attributes:

    <com.wanderingcan.persistentsearch.PersistentSearchView
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:id="@+id/search_bar"
        app:navSrc="@drawable/someDrawable"
        app:endSrc="@drawable/someOtherDrawable"
        app:hint="Enter some text to search"
        app:hintAlwaysActive="true"
        app:showMenu="true/>

You can set the icons for both of the main icons on the PersistentSearchView in the xml by using the app:navSrc xml attribute for the left icon. And for the right icon by using the app:endSrc xml attribute.

The app:hint attribute allows a text hint to be added to the PersistentSearchView. The app:hintAlwaysActive allows the hint to be active when the user does not have the searchbar active or to only show it when there is no text in the searchbar and the user has the searchbar active.

The app:showMenu determines if the PersistentSearchView should show the menu below the searchbar when active if there are items in the search menu. If set to false it will never show the menu even if there are items in the menu.

Java

Inside the activity, there are a few listeners that will have to be set for the PersistentSearchView to be useful. And each xml attribute has a corresponding method to set the value in java code. To open or close the search in code can be done by calling persistentSearchView.openSearch() and persistentSearchView.closeSearch(), respectively.

persistentSearchView.setOnSearchListener(new PersistentSearchView.OnSearchListener() {
            @Override
            public void onSearchOpened() {
                //Called when the Searchbar is opened by the user or by something calling
                //persistentSearchView.openSearch();
            }

            @Override
            public void onSearchClosed() {
                //Called when the searchbar is closed by the user or by something calling
                //persistentSearchView.closeSearch();
            }

            @Override
            public void onSearchCleared() {
                //Called when the searchbar has been cleared by the user by removing all 
                //the text or hitting the clear button. This also will be called if 
                //persistentSearchView.populateSearchText() is set with a null string or
                //an empty string
            }

            @Override
            public void onSearchTermChanged(CharSequence term) {
                //Called when the text in the searchbar has been changed by the user or 
                //by persistentSearchView.populateSearchText() with text passed in.
                //Best spot to handle giving suggestions to the user in the menu
            }

            @Override
            public void onSearch(CharSequence text) {
                //Called when the user hits the IME Action Search on the keyboard to search
                //Here is the best spot to handle searches
            }
        });

To handle on click events for the icons on the searchbar, there is the an OnIconClickListener

persistentSearchView.setOnIconClickListener(new PersistentSearchView.OnIconClickListener() {
            @Override
            public void OnNavigationIconClick() {
                //Called when the Left/Navigation Icon is clicked
            }

            @Override
            public void OnEndIconClick() {
                //Called when the End Icon is clicked
            }
        });

The SearchMenu also has an OnMenuItemClickListener

persistentSearchView.setOnMenuItemClickListener(new PersistentSearchView.OnMenuItemClickListener() {
            @Override
            public void onMenuItemClick(SearchMenuItem item) {
            //Called when an Item in the SearchMenu is clicked, it passes in the 
            //SearchMenuItem that was clicked
            }
        });

SearchMenu

The SearchMenu is built to behave close to the built in menu objects in Android. To get access to the SearchMenu by calling persistentSearchView.getSearchMenu(). To add an item searchMenu.addSearchMenuItem() is used. If there are 5 items already inside the menu, calling searchMenu.addSearchMenuItem() will return null. Otherwise a SearchMenuItem is returned.

The SearchMenuItem allows you to set the Left Icon with setIcon() and the Right Icon with setActionIcon(). Setting the text is done by setTitle(). The SearchMenu also allows you to remove items and clear all items.

Caveats

Much of this has been made to be highly customizable, so there is very little hand holding. But it has been made as easy as possible to use. In the future some things might be automatically handled by the library but only if it is found useful and highly requested (or if I feel like it).

This library is minSdkVersion=14 and if that changes, the version number will be increased, not decreased.

License

Copyright 2015 Christopher Beda

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.