From e6ec9c5dd677be298430cb2b694f047c67b03239 Mon Sep 17 00:00:00 2001
From: Allan Wang <me@allanwang.ca>
Date: Sun, 9 Jul 2017 11:28:59 -0700
Subject: 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
---
 kpref-activity/README.md | 69 ++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 69 insertions(+)
 create mode 100644 kpref-activity/README.md

(limited to 'kpref-activity/README.md')

diff --git a/kpref-activity/README.md b/kpref-activity/README.md
new file mode 100644
index 0000000..3c3266c
--- /dev/null
+++ b/kpref-activity/README.md
@@ -0,0 +1,69 @@
+# KAU :kpref-activity
+
+KAU supports Preferences that are created without xmls and through AppCompat. 
+The items are backed by a [FastAdapter](https://github.com/mikepenz/FastAdapter) and support [iicons](https://github.com/mikepenz/Android-Iconics)
+
+![KPref Items Gif](https://github.com/AllanWang/Storage-Hub/blob/master/kau/kau_kpref_items.gif)
+
+The easiest way to create the settings is to extend `KPrefActivity`.
+
+We will then override `onCreateKPrefs` to generate our adapter builder.
+
+The adapter builder can easily add items using defined functions. 
+Each item added extends one or more contracts to configure it.
+
+The contracts are as follows:
+
+Contract | Mandatory | Optional | Description
+:--- | :--- | :--- | :---
+`CoreAttributeContract` | `NA` | `textColor` `accentColor` | Defines stylings that are added in every item
+`CoreContract` | `titleRes` | `descRes` `iicon` | Implemented by every item
+`BaseContract` | `getter` `setter` | `enabler` `onClick` `onDisabledClick` | Implemented by every preference item
+`KPrefColorContract` | `NA` | `showPreview` | Additional configurations for the color picker
+`KPrefTextContract` | `NA` | `textGetter` | Additional configurations for the text item
+`KPrefSubItemsContract` | `itemBuilder` | `NA` | Contains a new list for the adapter to load when clicked
+
+The kpref items are as followed:
+
+Item | Implements | Description
+:--- | :--- | :---
+`checkbox` | `CoreContract` `BaseContract` | Checkbox item; by default, clicking it will toggle the checkbox and the kpref
+`colorPicker` | `CoreContract` `BaseContract` `KPrefColorContract` | Color picker item; by default, clicking it will open a dialog which will change the color (int)
+`header` | `CoreContract` | Header; just a title that isn't clickable
+`text` | `CoreContract` `BaseContract` `KPrefTextContract` | Text item; displays the kpref as a String on the right; does not have click implementation by default
+`plainText` | `BaseContract` | Plain text item; like `text` but does not deal with any preferences directly, so it doesn't need a getter or setter
+This can be used to display text or deal with preference that are completely handed within the click event (eg a dialog).
+`subItems` | `CoreContract` `KPrefSubItemsContract` | Sub items; contains a new page for the activity to load when clicked
+ 
+An example of the adapter builder:
+ 
+```kotlin
+override fun onCreateKPrefs(savedInstanceState: android.os.Bundle?): KPrefAdapterBuilder.() -> Unit = {
+	
+	textColor = { KPrefSample.textColor } // getter function so the new text color will be retrieved for every reload
+	accentColor = { KPrefSample.accentColor }
+
+	header(R.string.header)
+
+	/**
+	 * This is how the setup looks like with all the proper tags
+	 */
+	checkbox(title = R.string.checkbox_1, getter = { KPrefSample.check1 }, setter = { KPrefSample.check1 = it },
+			builder = {
+				descRes = R.string.desc
+			})
+			
+	/**
+	 * This is how it looks like without the tags
+	 */
+	checkbox(R.string.checkbox_3, { KPrefSample.check3 }, { KPrefSample.check3 = it }) {
+		descRes = R.string.desc_dependent
+		enabler = { KPrefSample.check2 }
+		onDisabledClick = {
+			itemView, _, _ ->
+			itemView.context.toast("I am still disabled")
+			true
+		}
+	}
+}
+```
\ No newline at end of file
-- 
cgit v1.2.3