{"id":13676846,"url":"https://github.com/SimformSolutionsPvtLtd/SSImagePicker","last_synced_at":"2025-04-29T07:33:37.629Z","repository":{"id":44145848,"uuid":"346382920","full_name":"SimformSolutionsPvtLtd/SSImagePicker","owner":"SimformSolutionsPvtLtd","description":"Easy to use and configurable library to Pick an image from the Gallery or Capture an image using a Camera... 📸","archived":false,"fork":false,"pushed_at":"2025-04-23T09:03:08.000Z","size":286754,"stargazers_count":303,"open_issues_count":4,"forks_count":36,"subscribers_count":8,"default_branch":"main","last_synced_at":"2025-04-23T09:20:04.873Z","etag":null,"topics":["android","android-library","bottomsheet","camera","capture-image","crop","crop-image","gallery","gallery-images","image","imagepicker","imagepicker-bottomsheet","kotlin","kotlin-android","kotlin-library","pick","pickimage","rotate","rotate-image","ucrop"],"latest_commit_sha":null,"homepage":"","language":"Kotlin","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/SimformSolutionsPvtLtd.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2021-03-10T14:28:06.000Z","updated_at":"2025-04-17T12:42:44.000Z","dependencies_parsed_at":"2025-04-23T09:30:13.467Z","dependency_job_id":null,"html_url":"https://github.com/SimformSolutionsPvtLtd/SSImagePicker","commit_stats":null,"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SimformSolutionsPvtLtd%2FSSImagePicker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SimformSolutionsPvtLtd%2FSSImagePicker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SimformSolutionsPvtLtd%2FSSImagePicker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SimformSolutionsPvtLtd%2FSSImagePicker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SimformSolutionsPvtLtd","download_url":"https://codeload.github.com/SimformSolutionsPvtLtd/SSImagePicker/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251456066,"owners_count":21592287,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["android","android-library","bottomsheet","camera","capture-image","crop","crop-image","gallery","gallery-images","image","imagepicker","imagepicker-bottomsheet","kotlin","kotlin-android","kotlin-library","pick","pickimage","rotate","rotate-image","ucrop"],"created_at":"2024-08-02T13:00:33.773Z","updated_at":"2025-04-29T07:33:32.602Z","avatar_url":"https://github.com/SimformSolutionsPvtLtd.png","language":"Kotlin","funding_links":[],"categories":["Kotlin","Android"],"sub_categories":["Kotlin"],"readme":"![](library_banner.png)\n\n# 📸 SSImagePicker\n\n[![](https://jitpack.io/v/SimformSolutionsPvtLtd/SSImagePicker.svg)](https://jitpack.io/#SimformSolutionsPvtLtd/SSImagePicker)\n[![API](https://img.shields.io/badge/API-21%2B-brightgreen.svg?style=flat)](https://android-arsenal.com/api?level=21)\n[![Kotlin Version](https://img.shields.io/badge/Kotlin-v1.9.23-blue.svg)](https://kotlinlang.org)\n[![Android Weekly](https://img.shields.io/badge/Android%20Weekly-%23473-orange)](https://androidweekly.net/issues/issue-473)\n[![Android Arsenal]( https://img.shields.io/badge/Android%20Arsenal-SSImagePicker-green.svg?style=flat )]( https://android-arsenal.com/details/1/8243 )\n\nEasy to use and configurable library to **Pick multiple images from the Gallery or Capture an image\nusing Camera with maximum size, extension, crop, rotate, zoom and compress features**.\n\n* You can easily select image from camera and gallery and upload it wherever you want. We have\n  created this library to simplify pick or capture image feature.\n* Handled permissions for camera and gallery, also supports scoped storage.\n* Returns contentUri of selected image.\n* Easy to use and supports all major devices.\n* Support for\n  new [Photo Picker](https://developer.android.com/training/data-storage/shared/photopicker) for\n  Android 11+.\n\n# :zap: Features :\n\n* Capture Image Using Camera\n* Pick Image From Gallery\n* Multiple image pick support with pick limit\n* Handle Runtime Permission For Storage And Camera\n* ImagePicker Options Bottom Sheet\n* Retrieve Image Result In Uri Format\n* Crop Image with support of free hand cropping\n* Rotate Image\n* Image Zoom In, Zoom Out\n* Size filter for images\n* Extension filter for images\n* Compress image\n* Customize entire Image Picker screen UI with your own options and style\n* New Photo picker for the Android 11+.\n\n# 🎬Preview\n\n| Camera Picker               | Gallery Picker               | Multi Selection Gallery Picker        |\n|-----------------------------|------------------------------|---------------------------------------|\n| ![](gifs/camera_picker.gif) | ![](gifs/gallery_picker.gif) | ![](gifs/gallery_multi_selection.gif) |\n\n| Picker Option Bottom Sheet               | Crop Options               | Extension Options               |\n|------------------------------------------|----------------------------|---------------------------------|\n| ![](gifs/picker_option_bottom_sheet.gif) | ![](gifs/crop_options.gif) | ![](gifs/extension_options.gif) |\n\n| System Photo Picker (Android 11+) |\n|-----------------------------------|\n| ![](gifs/system_photo_picker.gif) |\n\n# :books: How it works:\n\n1. Gradle Dependency\n\n* Add the JitPack repository to your project's build.gradle file\n    - For Gradle version 5.x.x or less\n\n   ```kotlin\n        allprojects {\n            repositories {\n                ...\n    \t         maven { url = \"https://jitpack.io\" }\n            }\n        }\n   ```\n    - For latest Android Studio, in **settings.gradle** file\n      inside **`dependencyResolutionManagement`** block\n\n   ```kotlin\n        dependencyResolutionManagement {\n            repositories {\n                ...\n                 maven { url = \"https://jitpack.io\" }\n            }\n        }\n    ```\n\n* Enable data binding feature in your app's build.gradle\n  file [(More Details)](https://developer.android.com/topic/libraries/data-binding/start#build_environment)\n  .\n    ```kotlin\n        android {\n            ...\n            buildFeatures {\n                dataBinding=true\n            }\n        }\n    ```\n\n* Add the dependency in your app's build.gradle file\n\n    ```kotlin\n        dependencies {\n            implementation(\"com.github.SimformSolutionsPvtLtd:SSImagePicker:2.3\")\n        }\n    ```\n\n2. Add ImagePickerActivity into your AndroidManifest.xml. **`SSImagePicker`** is default theme for\n   image picker activity. If you want to set custom theme check\n   out [customization guide](docs/picker_ui_customization.md). Make sure to add\n   the **`android:configChanges`** to handle the rotation.\n\n```xml\n\n\u003cactivity android:name=\"com.app.imagepickerlibrary.ui.activity.ImagePickerActivity\"\n    android:configChanges=\"orientation|screenSize\" android:theme=\"@style/SSImagePicker\" /\u003e\n```\n\n3. If you want to use Picker options bottom sheet then\n   implement **`SSPickerOptionsBottomSheet.ImagePickerClickListener`** in your fragment or\n   activity. **`onImageProvider`** method will give the selected provider type.\n\n```kotlin\n    val pickerOptionBottomSheet = SSPickerOptionsBottomSheet.newInstance()\npickerOptionBottomSheet.show(supportFragmentManager, \"tag\")\n....\noverride fun onImageProvider(provider: ImageProvider) {\n    when (provider) {\n        ImageProvider.GALLERY -\u003e {\n            //Open gallery\n        }\n        ImageProvider.CAMERA -\u003e {\n            //Open camera\n        }\n        ImageProvider.NONE -\u003e {}\n    }\n}\n```\n\n4. Open Image Picker from activity or fragment via registering the image picker. It will give object\n   of **`ImagePicker`** class.\n\n```kotlin\n    private val imagePicker: ImagePicker by lazy {\n    registerImagePicker(this)\n}\n\noverride fun onCreate(savedInstanceState: Bundle?) {\n    super.onCreate(savedInstanceState)\n    ...\n}\n\n//To display the picker screen call open method on image picker object passing the picker type.\nimagePicker.open(PickerType.GALLERY)\n```\n\n5. Add customization to image picker via the image picker object. Checkout all the methods and\n   default values for customization from the [picker config customization](docs/picker_config.md)\n   section.\n\n```kotlin\n    imagePicker\n    .title(\"My Picker\")\n    .multipleSelection(enable = true, maxCount = 5)\n    .showCountInToolBar(false)\n    .showFolder(true)\n    .cameraIcon(true)\n    .doneIcon(true)\n    .allowCropping(true)\n    .compressImage(false)\n    .maxImageSize(2)\n    .extension(PickExtension.JPEG)\nimagePicker.open(PickerType.GALLERY)\n```\n\n6. To get result in activity or fragment implement **`ImagePickerResultListener`**.\n\n```kotlin\n    class MainActivity : AppCompatActivity(), ImagePickerResultListener {\n    ...\n}\n```\n\n7. Single Selection and the image captured from camera will be received in\n   **`onImagePick(uri: Uri?)`** callback.\n\n```kotlin\n    override fun onImagePick(uri: Uri?) {\n    //Do something with uri\n}\n```\n\n8. Multiple Selection uris will be received in **`onMultiImagePick(uris: List\u003cUri\u003e?)`** callback.\n\n```kotlin\n    override fun onMultiImagePick(uris: List\u003cUri\u003e?) {\n    //Do something with uris\n}\n```\n\n# :art: Customization\n\n- Customize picker config for different available options\n    - [:books: Picker Config Guide](docs/picker_config.md)\n- Customize UI of picker screen with different style attributes\n    - [:books: Picker Screen UI Guide](docs/picker_ui_customization.md)\n- Customize UI of picker options bottom sheet with different style attributes\n    - [:books: Picker Options Bottom Sheet Guide](docs/options_bottom_sheet_customization.md)\n\n# :pencil: Permissions\n\n**SSImagePicker** Uses following permissions to display images. For\nsystem [Photo Picker](https://developer.android.com/training/data-storage/shared/photopicker) on\nAndroid 11+ no permission is required.\n\n* API **21(Android 5)** to API **32(Android 12L)**: `android.permission.READ_EXTERNAL_STORAGE`\n* API **33(Android 13)** onwards: `android.permission.READ_MEDIA_IMAGES`\n\n# :rocket: Migration\n\n- Checkout the migration [guide](docs/migration.md) for migration to the latest version.\n\n## Other Library used:\n\n* __[UCrop Library](https://github.com/Yalantis/uCrop)__\n\n## Find this library useful? :heart:\n\nSupport it by\njoining __[stargazers](https://github.com/SimformSolutionsPvtLtd/SSImagePicker/stargazers)__ for\nthis repository. :star:\n\n## 🤝 How to Contribute\n\nWhether you're helping us fix bugs, improve the docs, or a feature request, we'd love to have you! :\nmuscle:\n\nCheck out our [**Contributing\nGuide**](https://github.com/SimformSolutionsPvtLtd/SSImagePicker/blob/master/CONTRIBUTING.md) for\nideas on contributing.\n\n## Bugs and Feedback\n\nFor bugs, feature requests, and discussion please\nuse [GitHub Issues](https://github.com/SimformSolutionsPvtLtd/SSImagePicker/issues).\n\n## Awesome Mobile Libraries\n\n- Check out our other\n  available [awesome mobile libraries](https://github.com/SimformSolutionsPvtLtd/Awesome-Mobile-Libraries)\n\n## License\n\n```\nMIT License\n\nCopyright (c) 2022 Simform Solutions\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FSimformSolutionsPvtLtd%2FSSImagePicker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FSimformSolutionsPvtLtd%2FSSImagePicker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FSimformSolutionsPvtLtd%2FSSImagePicker/lists"}