Skip to content

Commit

Permalink
update Readme with new configs
Browse files Browse the repository at this point in the history
  • Loading branch information
codekidX committed Oct 26, 2017
1 parent fc7e7b6 commit c086e22
Showing 1 changed file with 24 additions and 20 deletions.
44 changes: 24 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,30 @@ Before you implement this library here are some notes that you can follow to avo
Implementation
-------------


## List of configuration for StorageChooser.Builder

You can have the following configuration of builder.

| methods | parameters | compulsary? |
| ------ | ------ | ------ |
| withActivity | Activity | Yes |
| withFragmentManager | FragmentManager _(legacy)_ | Yes |
| withMemoryBar | boolean | No |
| withPreference | SharedPreferences | actionSave(true) |
| withPredefinedPath | String | No |
| **setType** | StoragChooser.DIRECTORY_CHOOSER **_or_** StorageChooser.FILE_PICKER| allowCustomPath(true) |
| showHidden | boolean | No |
| setTheme | StorageChooser.Theme | No |
| skipOverview | boolean, String | No |
| skipOverview | boolean | No |
| withContent | com.codekidlabs.storagechooser.Content | No |
| filter | StorageChooser.FileType | No |
| shouldResumeSession | boolean | No |
| setHeadingTypeface | String, boolean | No |
| setListTypeface | String, boolean | No |
| disableMultiSelect | NONE | No |

### Simple Type

- Let's you toggle between inernal/external root directory.
Expand Down Expand Up @@ -154,26 +178,6 @@ Here are some filters available in storage-chooser. Want any other filter types

![](https://media.giphy.com/media/7AWKkgm9Nozw4/giphy.gif)

## List of configuration for StorageChooser.Builder _(including 2.0)_

You can have the following configuration of builder.

| methods | parameters | compulsary? |
| ------ | ------ | ------ |
| withActivity | Activity | Yes |
| withFragmentManager | FragmentManager _(legacy)_ | Yes |
| withMemoryBar | boolean | No |
| withPreference | SharedPreferences | actionSave(true) |
| withPredefinedPath | String | No |
| **setType** | StoragChooser.DIRECTORY_CHOOSER **_or_** StorageChooser.FILE_PICKER| allowCustomPath(true) |
| showHidden | boolean | No |
| setTheme | StorageChooser.Theme | No |
| skipOverview | boolean, String | No |
| skipOverview | boolean | No |
| withContent | com.codekidlabs.storagechooser.Content | No |
| filter | StorageChooser.FileType | No |
| shouldResumeSession | boolean | No |

## Localization

A seperate localization wiki is posted [here](https://github.com/codekidX/storage-chooser/wiki/Localizing-your-chooser-using-Content)
Expand Down

0 comments on commit c086e22

Please sign in to comment.