Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/codekidx/storage-chooser
Lets user choose files in internal or external storage with just few lines of code.
https://github.com/codekidx/storage-chooser
android-filepicker file-picker picker storage-chooser
Last synced: 1 day ago
JSON representation
Lets user choose files in internal or external storage with just few lines of code.
- Host: GitHub
- URL: https://github.com/codekidx/storage-chooser
- Owner: codekidX
- License: mpl-2.0
- Created: 2016-12-08T16:12:39.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2022-03-21T09:55:05.000Z (almost 3 years ago)
- Last Synced: 2025-01-09T17:39:06.898Z (6 days ago)
- Topics: android-filepicker, file-picker, picker, storage-chooser
- Language: Java
- Homepage:
- Size: 679 KB
- Stars: 720
- Watchers: 31
- Forks: 153
- Open Issues: 47
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Storage Chooser [!News](https://github.com/codekidX/storage-chooser/tree/inline-3.0#android-10-news)
| **`Documentation`** | **`Version`** |
|-----------------| --------------|
| [](https://ashishshekar.com/projects/sc/) | [](https://jitpack.io/#codekidX/storage-chooser) |
A pretty and simple directory chooser and file picker library for 4.4+ devices. This library was created to be included in [OpenGApps App](https://play.google.com/store/apps/details?id=org.opengapps.app). There are too many storage chooser out there but this one is too materially :stuck_out_tongue: . Easy to implement and does not take a lot of your valueable time in setting-up all the other necessary things that every developer seeks, like
- saving path to sharedPreference
- event when path is selected and act upon that path
- and much more.
There are also some really nice features that I thought would come in handy:
- You show a quick overview of the storages present and their memory available before choosing so that users know which storage to choose.
- you can choose between _sheet and sleek_ layouts.
- Inline create folder view _(not another dialog to handle)_
- Full localization. I mean literally every strings can be localized to your desired language.
- Memory thresholding - a restriction or a toast that it shows when user's memory is less than your defined memory of operations.
- and more will be added soon.
## Installation
Add this to your root build.gradle file under repositories:
allprojects {
repositories {
maven { url "https://jitpack.io" }
}
}
Add this to your app level build.gradle as dependency:
com.github.codekidX:storage-chooser:2.0.4.4
Add this to your gradle.properties file:
```gradle
android.enableJetifier=true
android.useAndroidX=true
```
## Android 10 News
You can currently use this library on Android 10 devices by adding `android:requestLegacyExternalStorage="true"` to your AndroidManifest.xml.
The release of 3.0 was to happen by December 2019 but was put to hold in light of new situations and re-evaluation of what is more important to this library, features? stability? future-ready?.
There is an implementation of [SAF](https://developer.android.com/guide/topics/providers/document-provider) going on in [inline-3.0](https://github.com/codekidX/storage-chooser/tree/inline-3.0)
branch and would surface in this release as a **breaking change**.
## Notes
In order to save state between orientation, storage-chooser requires you to add this to AndroidManifest.xml `activity` tag
Before you implement this library here are some notes that you can follow to avoid errors.
```xml
android:configChanges="orientation|screenSize"
```
**Confirm:**
> - You have asked for **Runtime Permission** from the user in the past to avoid read errors.
> - Permissions with "READ_EXTERNAL_STORAGE" and "WRITE_EXTERNAL_STORAGE" is enough for this library to work.
> - This library follows same color scheme as that of the parent app to maintain the aesthetic of the parent app. _See the color scheme section below_
## Implementation
### Simple Type
- Let's you toggle between internal/external root directory.
```java
// Initialize Builder
StorageChooser chooser = new StorageChooser.Builder()
.withActivity(MainActivity.this)
.withFragmentManager(getFragmentManager())
.withMemoryBar(true)
.build();
// Show dialog whenever you want by
chooser.show();
// get path that the user has chosen
chooser.setOnSelectListener(new StorageChooser.OnSelectListener() {
@Override
public void onSelect(String path) {
Log.e("SELECTED_PATH", path);
}
});
```
> OUTPUT: **/storage/emulated/0**
### Pre-defined Type
- Let's you append a specific path to the root of internal or external directory.
```java
// --- ADD --
.withPredefinedPath(STATIC_PATH)
```
> OUTPUT: **/storage/emulated/0/Downloads/CodekidLabs**
### Custom Type
- Let's your user choose custom directory/file.
#### Directory Chooser
```java
// --- ADD ---
.allowCustomPath(true)
.setType(StorageChooser.DIRECTORY_CHOOSER)
```
#### File Picker
```java
// --- ADD ---
.allowCustomPath(true)
.setType(StorageChooser.FILE_PICKER)
```
### Save directly to preference
```java
// --- ADD ---
.actionSave(true)
.withPreference(sharedPreferences)
```
### Get path from preference
```java
String path = sharedPreferences.getString(DiskUtil.SC_PREFERENCE_KEY,"");
```
### (2.0+) Multiselect
It's already in there you don't need to write any special code for it. Just make sure your type of chooser is of type FILE_PICKER.
`builder.setType(StorageChooser.FILE_PICKER);`
### More information
- [A Look at StorageChooser.Theme](https://github.com/codekidX/storage-chooser/wiki/A-Look-at-Storage-Chooser.Theme).
- [Localizing your chooser with Content](https://github.com/codekidX/storage-chooser/wiki/Localizing-your-chooser-using-Content)
## License
This project is licensed with the Mozilla Public License v2.
In practice, you can use this library as-is, with a notification of it being used. If you make any changes, you are required to publish your changes under a compatible license.
### Contributing
Branch status:
| **`Production`** | **`Development`** |
|------------------|-------------------|
| master | inline-3.0 |
You can contribute to this library by [creating a pull request](https://github.com/codekidX/storage-chooser/pull/new/master).