aboutsummaryrefslogtreecommitdiff
path: root/core-ui/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 /core-ui/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 'core-ui/README.md')
-rw-r--r--core-ui/README.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/core-ui/README.md b/core-ui/README.md
new file mode 100644
index 0000000..8abf05e
--- /dev/null
+++ b/core-ui/README.md
@@ -0,0 +1,29 @@
+# KAU :core-ui
+
+Holds a collection of generic UIs.
+This submodule takes heavy influence from [Plaid](https://github.com/nickbutcher/plaid), a beautiful showcase for Material Design.
+
+## BoundedCardView
+
+Extends a CardView and provides `maxHeight` and `maxHeightPercentage` attributes.
+These values are judged once the view it attached and can be helpful to limit the size with respect to its parent.
+
+One example is in KAU's `:searchview`, where the search results will always allow some space below it for the user to tap and exit.
+
+## CutoutView
+
+Given a background and a text/vector, will "erase" the text/vector from the background.
+This can be seen in effect in KAU's `:about` submodule.
+
+## ElasticDragDismissFrameLayout
+
+When scrolling vertically, this frame will allow for overscrolling and will pull the layout out of view and exit if a threshold is reached.
+Note that Activities with this frame must be translucent. `@style/Kau.Translucent` can be used as a base.
+
+## InkPageIndicator
+
+A beautiful viewpager indicator
+
+## TextSlider
+
+An animated and themable Text Switcher. Specify its direction and set a new text value and it will slide it into view. \ No newline at end of file