Skip to content

Commit 97e3354

Browse files
committed
Updated ReadMe
1 parent 0bb2f93 commit 97e3354

File tree

1 file changed

+29
-25
lines changed

1 file changed

+29
-25
lines changed

README.md

Lines changed: 29 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
# File Manager
22

3-
<img src="https://i.imgur.com/NNaUK60.png"></img>
3+
![FileManager](https://i.imgur.com/NNaUK60.png)
44

5-
![GitHub](https://img.shields.io/github/license/DevsOnFlutter/file_manager?style=plastic) ![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/DevsOnFlutter/file_manager?style=plastic) ![GitHub top language](https://img.shields.io/github/languages/top/DevsOnFlutter/file_manager?style=plastic) ![GitHub language count](https://img.shields.io/github/languages/count/DevsOnFlutter/file_manager?style=plastic) ![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/DevsOnFlutter/file_manager?style=plastic) ![GitHub issues](https://img.shields.io/github/issues/DevsOnFlutter/file_manager?style=plastic)
5+
![GitHub](https://img.shields.io/github/license/DevsOnFlutter/file_manager?style=plastic) ![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/DevsOnFlutter/file_manager?style=plastic) ![GitHub top language](https://img.shields.io/github/languages/top/DevsOnFlutter/file_manager?style=plastic) ![GitHub language count](https://img.shields.io/github/languages/count/DevsOnFlutter/file_manager?style=plastic) ![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/DevsOnFlutter/file_manager?style=plastic) ![GitHub issues](https://img.shields.io/github/issues/DevsOnFlutter/file_manager?style=plastic)
66

77
![GitHub Repo stars](https://img.shields.io/github/stars/DevsOnFlutter/file_manager?style=social) ![GitHub forks](https://img.shields.io/github/forks/DevsOnFlutter/file_manager?style=social)
88

99
FileManager is a wonderful widget that allows you to manage files and folders, pick files and folders, and do a lot more.
1010
Designed to feel like part of the Flutter framework.
1111

12-
## Compatibility
12+
## Compatibility
1313

1414
&nbsp; Android </br>
15-
&nbsp; Windows </br>
1615
&nbsp; Linux </br>
17-
&nbsp; Web </br>
16+
&nbsp; Windows ([in progress](https://github.com/4-alok/file_manager/tree/windows-support))</br>
17+
&nbsp; Web </br>
1818
&nbsp; MacOS (active issue: [MacOS support](https://github.com/DevsOnFlutter/file_manager/issues/8)) </br>
1919
&nbsp; iOS (active issue: [iOS support](https://github.com/DevsOnFlutter/file_manager/issues/7)) </br>
2020

@@ -33,15 +33,13 @@ Beside needing to add **WRITE_EXTERNAL_STORAGE** and **READ_EXTERNAL_STORAGE** t
3333
package="com.xxx.yyy">
3434
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>
3535
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"/>
36-
37-
<application
38-
android:requestLegacyExternalStorage="true"
39-
...
4036
...
4137
</manifest>
4238
```
39+
4340
also add for Android 10
44-
```
41+
42+
```xml
4543
<application
4644
android:requestLegacyExternalStorage="true"
4745
...
@@ -57,20 +55,24 @@ dependencies:
5755
file_manager: ^1.0.0
5856
```
5957

58+
</hr>
59+
6060
### Basic setup
6161

6262
*The complete example is available [here](https://github.com/DevsOnFlutter/file_manager/blob/main/example/lib/main.dart).*
6363

6464
Required parameter for **FileManager** are `controller` and `builder`
65+
6566
* `controller` The controller updates value and notifies its listeners, and FileManager updates itself appropriately whenever the user modifies the path or changes the sort-type with an associated FileManagerController.
66-
```
67+
68+
```dart
6769
final FileManagerController controller = FileManagerController();
6870
```
69-
* `builder` This function allows you to create custom widgets and retrieve a list of entities `List<FileSystemEntity>.`
7071

72+
* `builder` This function allows you to create custom widgets and retrieve a list of entities `List<FileSystemEntity>.`
7173

74+
## Sample code
7275

73-
Sample code
7476
```dart
7577
FileManager(
7678
controller: controller,
@@ -100,7 +102,10 @@ FileManager(
100102
),
101103
```
102104

105+
</hr>
106+
103107
## FileManager
108+
104109
| Properties | Description |
105110
|--------------|-----------------|
106111
| `loadingScreen` | For the loading screen, create a custom widget. A simple Centered CircularProgressIndicator is provided by default. |
@@ -110,6 +115,7 @@ FileManager(
110115
| `builder` | This function allows you to create custom widgets and retrieve a list of entities `List<FileSystemEntity>.` |
111116

112117
## FileManagerContoller
118+
113119
| Properties | Description |
114120
|--------------|-----------------|
115121
| `getSortedBy` | The sorting type that is currently in use is returned. |
@@ -121,11 +127,13 @@ FileManager(
121127
| `openDirectory` | Open directory by providing `Directory`. |
122128

123129
## Others
130+
124131
| Properties | Description |
125132
|--------------|-----------------|
126133
| `isFile` | check weather FileSystemEntity is File. |
127134
| `isDirectory` | check weather FileSystemEntity is Directory. |
128-
| `basename` | Get the basename of Directory or File. Provide `File`, `Directory` or `FileSystemEntity` and returns the name as a `String`. If you want to hide the extension of a file, you may use optional parameter `showFileExtension`. ie ```controller.dirName(dir, true)``` |
135+
| `basename` | Get the basename of Directory or File. Provide `File`, `Directory` or `FileSystemEntity` and returns the name as a `String`. If you want to hide the extension of a file, you may use optional parameter `showFileExtension`. ie ```controller.dirName(dir, true)```
136+
|
129137
| `formatBytes` | Convert bytes to human readable size.[getCurrentDirectory]. |
130138
| `setCurrentPath` | Set current directory path by providing `String` of path, similar to [openDirectory]. `List<FileSystemEntity>.` |
131139
| `getStorageList` | Get list of available storage in the device, returns an empty list if there is no storage `List<Directory>`|
@@ -134,13 +142,9 @@ FileManager(
134142

135143
## Project Created & Maintained By
136144

137-
### Alok Kumar
138-
139-
[![GitHub followers](https://img.shields.io/github/followers/4-alok?style=social)](https://github.com/4-alok/)
140-
141-
### Arpit Sahu
145+
### [DevsOnFlutter](https://github.com/DevsOnFlutter)
142146

143-
[![GitHub followers](https://img.shields.io/github/followers/Arpit-Sahu?style=social)](https://github.com/Arpit-Sahu/)
147+
</hr>
144148

145149
## Contributions
146150

@@ -150,15 +154,15 @@ If you feel that a hook is missing, feel free to open a pull-request.
150154

151155
For a custom-hook to be merged, you will need to do the following:
152156

153-
- Describe the use-case.
157+
* Describe the use-case.
154158

155-
- Open an issue explaining why we need this hook, how to use it, ...
159+
* Open an issue explaining why we need this hook, how to use it, ...
156160
This is important as a hook will not get merged if the hook doens't appeal to
157161
a large number of people.
158162

159-
- If your hook is rejected, don't worry! A rejection doesn't mean that it won't
163+
* If your hook is rejected, don't worry! A rejection doesn't mean that it won't
160164
be merged later in the future if more people shows an interest in it.
161-
In the mean-time, feel free to publish your hook as a package on https://pub.dev.
165+
In the mean-time, feel free to publish your hook as a package on <https://pub.dev>.
162166

163-
- A hook will not be merged unles fully tested, to avoid breaking it inadvertendly
167+
* A hook will not be merged unles fully tested, to avoid breaking it inadvertendly
164168
in the future.

0 commit comments

Comments
 (0)