diff options
Diffstat (limited to 'imagepicker/README.md')
| -rw-r--r-- | imagepicker/README.md | 36 |
1 files changed, 29 insertions, 7 deletions
diff --git a/imagepicker/README.md b/imagepicker/README.md index e37e417..f70de2b 100644 --- a/imagepicker/README.md +++ b/imagepicker/README.md @@ -1,12 +1,35 @@ # KAU :imagepicker ImagePicker is a beautiful gallery activity that allows you to pick images -from your storage. It is backed by FastAdapter and Glide, and offers blur and fade transitions. +from your storage. It is backed by FastAdapter and Glide, and stems from the ImagePickerCore model -`ImagePickerActivityBase` is already fully functional, so you may directly extend it with no further changes -and add the activity to your manifest +Currently, there are two options: -You may also easily launch the activity through the simple binder: +-------------------------------- + +## ImagePickerActivityBase + +A full screen multi image picker with beautiful animations. +Images 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.ImagePicker` is added for your convenience. + +## ImagePickerActivityOverlayBase + +This overlaying activity makes use of transitions and nested scrolling, and is only for Lollipop and up. +Only one image 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.ImagePicker.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.kauLaunchImagePicker(YourClass::class.java, yourRequestCode) ``` @@ -14,6 +37,5 @@ Activity.kauLaunchImagePicker(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 `kauOnImagePickerResult` - -This module also has a template style `Kau.ImagePicker` that defaults to a slide up animation.
\ No newline at end of file +to first verify that the request code matches and then call `kauOnImagePickerResult`, +which will return the list of ImageModels.
\ No newline at end of file |