https://github.com/sangcomz/FishBun
:blowfish:FishBun is Image Picker for android.
https://github.com/sangcomz/FishBun
android image-picker multi-image-picker photopicker
Last synced: 23 days ago
JSON representation
:blowfish:FishBun is Image Picker for android.
- Host: GitHub
- URL: https://github.com/sangcomz/FishBun
- Owner: sangcomz
- License: apache-2.0
- Created: 2015-11-06T09:34:25.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2023-09-22T05:59:05.000Z (over 1 year ago)
- Last Synced: 2024-11-01T21:05:40.610Z (6 months ago)
- Topics: android, image-picker, multi-image-picker, photopicker
- Language: Kotlin
- Homepage:
- Size: 49.9 MB
- Stars: 671
- Watchers: 24
- Forks: 144
- Open Issues: 52
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-list - sangcomz/FishBun - :blowfish:FishBun is Image Picker for android. (Kotlin)
- awesome-github-android-ui - FishBun - Android图片选择器 (图片)
README
# FishBun
[](https://android-arsenal.com/details/1/2785)
[](https://travis-ci.org/sangcomz/FishBun)
[](https://codecov.io/gh/sangcomz/FishBun)
[](https://search.maven.org/artifact/io.github.sangcomz/fishbun)
_FishBun_ is a highly customizable image picker for Android.
## What's New in _FishBun_? :tada:
- fix crash issue [#234](https://github.com/sangcomz/FishBun/issues/234) [#253](https://github.com/sangcomz/FishBun/issues/253)
## Customizable Styles
_FishBun_ supports various visual styles and allows fine-tuning for details. Just to show some examples:
#### Default
##### Code
```java
FishBun.with(WithActivityActivity.this)
.setImageAdapter(new GlideAdapter())
.startAlbumWithOnActivityResult(requestCode) or startAlbumWithActivityResultCallback(activityResultLauncher);
```
##### Screenshots
#### Dark
##### Code
```java
FishBun.with(WithActivityActivity.this)
.setImageAdapter(new GlideAdapter())
.setMaxCount(5)
.setMinCount(3)
.setPickerSpanCount(5)
.setActionBarColor(Color.parseColor("#795548"), Color.parseColor("#5D4037"), false)
.setActionBarTitleColor(Color.parseColor("#ffffff"))
.setArrayPaths(path)
.setAlbumSpanCount(2, 3)
.setButtonInAlbumActivity(false)
.setCamera(true)
.exceptGif(true)
.setReachLimitAutomaticClose(true)
.setHomeAsUpIndicatorDrawable(ContextCompat.getDrawable(this, R.drawable.ic_custom_back_white))
.setDoneButtonDrawable(ContextCompat.getDrawable(this, R.drawable.ic_custom_ok))
.setAllDoneButtonDrawable(ContextCompat.getDrawable(this, R.drawable.ic_custom_ok))
.setIsUseAllDoneButton(ContextCompat.getDrawable(this, R.drawable.ic_custom_ok))
.setAllViewTitle("All")
.setMenuAllDoneText("All Done")
.setActionBarTitle("FishBun Dark")
.textOnNothingSelected("Please select three or more!")
.exceptMimeType(listOf(MimeType.GIF))
.setSpecifyFolderList(arrayListOf("Screenshots", "Camera"))
.startAlbumWithOnActivityResult(requestCode);
```
##### Screenshots
#### Light
##### Code
```java
FishBun.with(WithActivityActivity.this)
.setImageAdapter(new GlideAdapter())
.setPickerCount(50)
.setPickerSpanCount(4)
.setActionBarColor(Color.parseColor("#ffffff"), Color.parseColor("#ffffff"), true)
.setActionBarTitleColor(Color.parseColor("#000000"))
.setArrayPaths(path)
.setAlbumSpanCount(1, 2)
.setButtonInAlbumActivity(true)
.setCamera(false)
.exceptGif(true)
.setReachLimitAutomaticClose(false)
.setHomeAsUpIndicatorDrawable(ContextCompat.getDrawable(this, R.drawable.ic_arrow_back_black_24dp))
.setOkButtonDrawable(ContextCompat.getDrawable(this, R.drawable.ic_check_black_24dp))
.setAllViewTitle("All of your photos")
.setActionBarTitle("FishBun Light")
.textOnImagesSelectionLimitReached("You can't select any more.")
.textOnNothingSelected("I need a photo!")
.startAlbumWithOnActivityResult(requestCode);
```
##### Screenshots
## How to Setup
Fishbun 0.10.0 and above only supports projects that have been migrated to [androidx](https://developer.android.com/jetpack/androidx/). For more information, read Google's [migration guide](https://developer.android.com/jetpack/androidx/migrate).
Setting up _FishBun_ requires to add this Gradle configuration:
dependencies {
implementation 'io.github.sangcomz:fishbun:x.x.x'
implementation 'io.coil-kt:coil:0.11.0'
or
implementation 'com.github.bumptech.glide:glide:4.11.0'
}
and to allow the following permissions in your `Manifest`:
If your app targets Android 11 with compileSdk/targetSdk >= 30 then you will need to add this to the manifest (outside of the application block) in order to capture pictures with the device camera. [Android documentation here](https://developer.android.com/about/versions/11/privacy/package-visibility):
If your app targets Android 13 with compileSdk/targetSdk >= 33 then you will need to add this to the manifest. [Android documentation here](https://developer.android.com/about/versions/13/behavior-changes-13#granular-media-permissions):
## How to Use
Use _FishBun_ in an activity:
FishBun.with(YourActivity).setImageAdapter(new GlideAdapter()).startAlbumWithOnActivityResult(requestCode);
or in a fragment:
FishBun.with(YourFragment).setImageAdapter(new CoilAdapter()).startAlbumWithOnActivityResult(reqeustCode);
and implement `OnActivityResult`:
protected void onActivityResult(int requestCode, int resultCode,
Intent imageData) {
super.onActivityResult(requestCode, resultCode, imageData);
switch (requestCode) {
case FishBun.FISHBUN_REQUEST_CODE:
if (resultCode == RESULT_OK) {
// path = imageData.getStringArrayListExtra(Define.INTENT_PATH);
// you can get an image path(ArrayList) on <0.6.2
path = imageData.getParcelableArrayListExtra(INTENT_PATH);
// you can get an image path(ArrayList) on 0.6.2 and later
break;
}
}
}
Various customizable features can be controlled by chained methods as in:
FishBun.with(YourActivity or YourFragment)
.setImageAdapter(new GlideAdapter())
.setIsUseDetailView(false)
.setPickerCount(5) //Deprecated
.setMaxCount(5)
.setMinCount(1)
.setPickerSpanCount(6)
.setActionBarColor(Color.parseColor("#795548"), Color.parseColor("#5D4037"), false)
.setActionBarTitleColor(Color.parseColor("#ffffff"))
.setArrayPaths(path)
.setAlbumSpanCount(2, 4)
.setButtonInAlbumActivity(false)
.setCamera(true)
.setReachLimitAutomaticClose(true)
.setHomeAsUpIndicatorDrawable(ContextCompat.getDrawable(this, R.drawable.ic_custom_back_white))
.setOkButtonDrawable(ContextCompat.getDrawable(this, R.drawable.ic_custom_ok))
.setAllViewTitle("All")
.setActionBarTitle("Image Library")
.textOnImagesSelectionLimitReached("Limit Reached!")
.textOnNothingSelected("Nothing Selected")
.setSelectCircleStrokeColor(Color.BLACK)
.isStartInAllView(false)
.exceptMimeType(listOf(MimeType.GIF))
.setSpecifyFolderList(arrayListOf("Screenshots", "Camera"))
.startAlbumWithOnActivityResult(requestCode);
### attribute
| Method Name | Description | Default Value |
|:---------------------------------:|-----------------------------------------------------------------------|:------------------------:|
| setSelectedImages | Set the already selected image | null |
| setMaxCount | Maximum number of images selected | 10 |
| setMinCount | Minimum number of images selected | 1 |
| setRequestCode | Set RequestCode | 27 |
| setReachLimitAutomaticClose | Picker automatically ends when the number of images is selected | false |
| exceptMimeType | Set file type to exclude(gif, png, jpeg, bmp, webp) | NONE |
| setAlbumThumbnailSize | Thumbnail size of album screen | 70dp |
| setPickerSpanCount | Set the picker's span count | 4 |
| setActionBarColor | Set background color of action bar, statusBar color, set light theme | #3F51B5, #303F9F, false |
| setActionBarTitleColor | Set the title color of the action bar | #ffffff |
| textOnNothingSelected | Message when nothing is selected | "There is no selected image." |
| textOnImagesSelectionLimitReached | Message when the image is already all selected | "Selection full. Deselect an image to choose another." |
| setButtonInAlbumActivity | Set Selected button visibility in album screen | false |
| setAlbumSpanCount | Set the album's span count | 1, 2 |
| setAlbumSpanCountOnlyLandscape | Set the album's span count when landscape | 2 |
| setAlbumSpanCountOnlPortrait | Set the album's span count when portrait | 1 |
| setAllViewTitle | Set the name of all views | "All view" |
| setActionBarTitle | Set the title of the action bar | "Album" |
| setHomeAsUpIndicatorDrawable | Customizing back button of the action bar | null |
| setDoneButtonDrawable | Customizing done button of the action bar | null |
| setAllDoneButtonDrawable | Customizing all done button of the action bar | null |
| setIsUseAllDoneButton | Set whether to use the all select button | false |
| setMenuDoneText | Set text for Done button | null |
| setMenuAllDoneText | Set text for All Done button | null |
| setMenuTextColor | Set text color for menu | Integer.MAX_VALUE |
| setIsUseDetailView | Set whether to use detail screen | false |
| setIsShowCount | Set whether to show counting numbers | false |
| setSelectCircleStrokeColor | Set select circle color | #c1ffffff |
| isStartInAllView | Set to start with all view | false |
| setSpecifyFolderList | Set folder to show | NONE |
| hasCameraInPickerPage | Set whether to use the camera button on picker screen | false |
## Android M Permission
Running on Android M, _FishBun_ checks if it has proper permission for you before reading an external storage.
# Apps using FishBun
## If you are using this library in your app, let me know.
| Project Name | Result Screen |
|:---------:|---|
| Pandaz(unavailable now)
| 
|
| Multi photo resize compress crop in batch PicTools
| 
|
# Contribution
Any suggestions or contributions would be welcomed.
[CONTRIBUTING](https://github.com/sangcomz/FishBun/blob/master/CONTRIBUTING.md)
# Feedback
Bug reports and feature requests can be submitted [here](https://github.com/sangcomz/FishBun/issues)
(please read the [instructions](https://github.com/sangcomz/FishBun/blob/master/CONTRIBUTING.md) on how to report a bug and request feature).
# License
Copyright 2019 Seokwon Jeong
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.