aboutsummaryrefslogtreecommitdiff
path: root/mediapicker/README.md
diff options
context:
space:
mode:
authorAllan Wang <me@allanwang.ca>2017-07-31 23:02:01 -0700
committerGitHub <noreply@github.com>2017-07-31 23:02:01 -0700
commit48213d0b427c478865c75fee912ff1ae8bbaffb5 (patch)
tree7aef1d8400fc3403ee5a40aba945f33a95319359 /mediapicker/README.md
parent8a4e9fd44dfbcf58aa7ab63167dcbdf8752db7d0 (diff)
downloadkau-48213d0b427c478865c75fee912ff1ae8bbaffb5.tar.gz
kau-48213d0b427c478865c75fee912ff1ae8bbaffb5.tar.bz2
kau-48213d0b427c478865c75fee912ff1ae8bbaffb5.zip
Major update to core and kotterknife; create mediapicker (#15)
* Readme * Fix kau direction bits * Truly support transparent ripples * Update changelog * Test rect as base * Replace fab transition with generic fade scale transition * Add scalexy func * Add scaleXY * Add arguments to fadeScaleTransition * Clean up ink indicator * Create setOnSingleTapListener * Fix lint and add rndColor * Create kotterknife resettables * Add readme and missing object * Create lazy resettable registered * Update core docs * Opt for separate class for resettable registry * Clean up resettable registry * Rename functions * Add ripple callback listener * Adjust kprefactivity desc color * Add more transitions * Add delete keys option * Add instrumentation tests * switch id * Revert automatic instrumental tests * Generify imagepickercore and prepare video alternative * Create working video picker * Address possible null issue * Update searchview * Make layouts public * Add changelog test * Update logo link * Add custom color gif
Diffstat (limited to 'mediapicker/README.md')
-rw-r--r--mediapicker/README.md43
1 files changed, 43 insertions, 0 deletions
diff --git a/mediapicker/README.md b/mediapicker/README.md
new file mode 100644
index 0000000..a743a47
--- /dev/null
+++ b/mediapicker/README.md
@@ -0,0 +1,43 @@
+# KAU :mediapicker
+
+MediaPicker is a beautiful collection of gallery activities that allow you to pick images or videos
+from your storage. It is backed by FastAdapter and Glide, and stems from the PickerCore model.
+
+
+Currently, there are two options:
+Each takes in a MediaType argument, to specify whether it queries images or videos
+
+--------------------------------
+
+## MediaPickerActivityBase
+
+A full screen multi media picker with beautiful animations.
+Items are blurred when selected, and there is a counter on the top right.
+There is a FAB to send back the response.
+
+`R.style.Kau.MediaPicker` is added for your convenience.
+
+## MediaPickerActivityOverlayBase
+
+This overlaying activity makes use of transitions and nested scrolling, and is only for Lollipop and up.
+Only one item can be selected, so the overlay exists immediately upon the first selection.
+Having this model also means that each item is only one simple image, as opposed to the blurrable image view above.
+As a result, this activity has faster loading on scrolling.
+
+`R.style.Kau.MediaPicker.Overlay` is added for your convenience.
+
+--------------------------------
+
+Both activities work out of the box and can be extended without needing further modifications.
+Their convenience styles default to a slide in slide out animation from the bottom edge.
+
+You may also easily launch either activity through the simple binder:
+```
+Activity.kauLaunchMediaPicker(YourClass::class.java, yourRequestCode)
+```
+
+Note that this launches the activity through a `startActivityForResult` call
+
+You may get the activity response by overriding your `onActivityResult` method
+to first verify that the request code matches and then call `kauOnMediaPickerResult`,
+which will return the list of MediaModels. \ No newline at end of file