aboutsummaryrefslogtreecommitdiff
path: root/adapter/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'adapter/README.md')
-rw-r--r--adapter/README.md19
1 files changed, 16 insertions, 3 deletions
diff --git a/adapter/README.md b/adapter/README.md
index 6d59777..7df9713 100644
--- a/adapter/README.md
+++ b/adapter/README.md
@@ -4,8 +4,21 @@ Collection of kotlin bindings and custom IItems for [Fast Adapter](https://githu
## KauIItems
-Extends `AbstractIItems` and contains the arguments (layoutRes, ViewHolder lambda, idRes)
-In that order. Those variables are used to override the default abstract functions.
+Abstract base that extends `AbstractIItems` and contains the arguments `(layoutRes, ViewHolder lambda, idRes)` in that order.
+Those variables are used to override the default abstract functions.
If a layout is only used for one item, it may also be used as the id, which you may leave blank in this case.
The ViewHolder lambda is typically of the form `{ ViewHolder(it) }`
-Where you will have a nested class `ViewHolder(v: View) : RecyclerView.ViewHolder(v)` \ No newline at end of file
+Where you will have a nested class `ViewHolder(v: View) : RecyclerView.ViewHolder(v)`
+
+## IItem Templates
+
+* CardIItem - generic all encompassing card item with a title, description, imageview, and button.
+All items except for the title are optional.
+* HeaderIItem - simple title container with a big top margin
+
+## KauAnimator
+
+Abstract base that decouples the animations into three parts: `add`, `remove`, and `change`.
+Each component extends `KauAnimatorAdd`, `KauAnimatorRemove`, or `KauAnimatorChange` respectively.
+All the changes in the original animator are removed, so you have complete control over the transitions.
+There are a couple base animators, such as fade scale and slide, which can be mix and matched and added to `KauAnimator` \ No newline at end of file