aboutsummaryrefslogtreecommitdiff
path: root/searchview/README.md
diff options
context:
space:
mode:
authorAllan Wang <me@allanwang.ca>2017-07-09 11:28:59 -0700
committerGitHub <noreply@github.com>2017-07-09 11:28:59 -0700
commite6ec9c5dd677be298430cb2b694f047c67b03239 (patch)
treef0bc2a630c9335b608ac9076ca868f5a5658c75c /searchview/README.md
parent0af8b379fc0968c830c8938e1998b5bd3dd7e0aa (diff)
downloadkau-e6ec9c5dd677be298430cb2b694f047c67b03239.tar.gz
kau-e6ec9c5dd677be298430cb2b694f047c67b03239.tar.bz2
kau-e6ec9c5dd677be298430cb2b694f047c67b03239.zip
KAU 2.0 (#1) - Update docs and finish up refractoring
* Update readme * Add docs for remaining submodules * Update searchview * Update links 1/3 * Update links 2/3 * Update links 3/3 * update changelog * Update readme * Test rename to readme * Rename remaining to readme * Link readme to repo
Diffstat (limited to 'searchview/README.md')
-rw-r--r--searchview/README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/searchview/README.md b/searchview/README.md
new file mode 100644
index 0000000..7274f6e
--- /dev/null
+++ b/searchview/README.md
@@ -0,0 +1,13 @@
+# KAU :searchview
+
+KAU contains a fully functional SearchView that can be added programmatically with one line.
+It contains a `bindSearchView` extension functions for both activities and viewgroups.
+
+![Search View Gif](https://github.com/AllanWang/Storage-Hub/blob/master/kau/kau_search_view.gif)
+
+The searchview is:
+* Fully themable - set the foreground or background color to style every portion, from text colors to backgrounds to ripples
+* Complete - binding the search view to a menu id will set the menu icon (if not previously set) and attach all the necessary listeners
+* Configurable - modify any portion of the inner Config class when binding the search view
+* Thread friendly - the search view is built with observables and emits values in a separate thread,
+which means that you don't have to worry about long processes in the text watcher. Likewise, all adapter changes are automatically done on the ui thread.