Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/prscx/react-native-file-selector
React Native: Native File Selector
https://github.com/prscx/react-native-file-selector
andriod ios react-native
Last synced: 1 day ago
JSON representation
React Native: Native File Selector
- Host: GitHub
- URL: https://github.com/prscx/react-native-file-selector
- Owner: prscX
- License: apache-2.0
- Created: 2018-02-22T14:41:35.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2021-07-01T12:18:12.000Z (over 3 years ago)
- Last Synced: 2024-12-28T22:15:41.937Z (9 days ago)
- Topics: andriod, ios, react-native
- Language: Java
- Homepage:
- Size: 1.68 MB
- Stars: 307
- Watchers: 5
- Forks: 58
- Open Issues: 50
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
ReactNative: Native File Selector (Android/iOS)
If this project has helped you out, please support us with a star 🌟
This library is a ReactNative Bridge around native libraries. It allows you to natively select/pick file from device file system:
| **Android: [nbsp-team/MaterialFilePicker/](https://github.com/nbsp-team/MaterialFilePicker)** |
| ----------------- |
| 
|
> **Note**: It allows you to pick file without using Intent/Third Party Software
| **iOS: [marmelroy/FileBrowser](https://github.com/marmelroy/FileBrowser)** |
| ----------------- |
| 
|
> **Note**: It allows you to select only local files associate to app sandbox.
## 📖 Getting started
`$ npm install react-native-file-selector --save`
> This library is supports RN60 and above
- **iOS**
> **iOS Prerequisite:** Please make sure `CocoaPods` is installed on your system
- Add the following to your `Podfile` -> `ios/Podfile` and run pod update:
```
use_native_modules!
pod 'RNFileSelector', :path => '../node_modules/react-native-file-selector/ios'
use_frameworks! :linkage => :static
pod 'FileBrowser', :git => 'https://github.com/prscX/FileBrowser'
# Follow [Flipper iOS Setup Guidelines](https://fbflipper.com/docs/getting-started/ios-native)
# This is required because iOSPhotoEditor is implemented using Swift and we have to use use_frameworks! in Podfile
$static_framework = ['FlipperKit', 'Flipper', 'Flipper-Folly',
'CocoaAsyncSocket', 'ComponentKit', 'Flipper-DoubleConversion',
'Flipper-Glog', 'Flipper-PeerTalk', 'Flipper-RSocket', 'Yoga', 'YogaKit',
'CocoaLibEvent', 'OpenSSL-Universal', 'boost-for-react-native']
pre_install do |installer|
Pod::Installer::Xcode::TargetValidator.send(:define_method, :verify_no_static_framework_transitive_dependencies) {}
installer.pod_targets.each do |pod|
if $static_framework.include?(pod.name)
def pod.build_type;
Pod::BuildType.static_library
end
end
end
end
```
- Please make sure [**Flipper iOS Setup Guidelines**](https://fbflipper.com/docs/getting-started/ios-native/) steps are added to Podfile, since iOSPhotoEditor is implemented using Swift and we have to use use_frameworks! in Podfile
- **Android**
- Add below color attributes in your app's `android/app/src/main/res/values/color.xml` file. You can provide your own color codes.
```
#3F51B5
#303F9F
#FF4081
```
## 💻 Usage
`import RNFileSelector from 'react-native-file-selector';`
- API Way
```javascript
RNFileSelector.Show(
{
title: 'Select File',
onDone: (path) => {
console.log('file selected: ' + path)
},
onCancel: () => {
console.log('cancelled')
}
}
)
```
- React Way
```javascript
{
console.log("file selected: " + path);
}} onCancel={() => {
console.log("cancelled");
}}/>
```
## 💡 Props
| Prop | Type | Default | Note |
| ----------------- | ---------- | ------- | ---------------------------------------------------------------------------------------------------------- |
| `title` | `string` | | Title on the toolbar
| `closeMenu` | `string` | true | Color of tint
| `hiddenFiles: Android` | `bool` | false | If true it shows hidden files as well |
| `path` | `string` | | Path of directory | |
| `filter` | `string` | | Filter to sort the files | |
| `filterDirectories: Android` | `bool` | | Filter should be applied on directories or not
| `onDone` | `func` | | Function called when file is selected | |
| `onCancel` | `func` | | Function called when file selector is closed without selecting any file | |
| `visible` | `bool` | false | To invoke file selector | |
> **Note**
> - **Filter**
> - **Android:** Please find [regex/Pattern](https://developer.android.com/reference/java/util/regex/Pattern.html) for defining filter
> - **iOS:** Array of file extension needs to be ignore
## ✨ Credits
- Android: [nbsp-team/MaterialFilePicker/](https://github.com/nbsp-team/MaterialFilePicker)
- iOS: [marmelroy/FileBrowser](https://github.com/marmelroy/FileBrowser)
## 🤔 How to contribute
Have an idea? Found a bug? Please raise to [ISSUES](https://github.com/prscX/react-native-file-selector/issues).
Contributions are welcome and are greatly appreciated! Every little bit helps, and credit will always be given.
## 💫 Where is this library used?
If you are using this library in one of your projects, add it in this list below. ✨
## 📜 License
This library is provided under the Apache License.
RNFileSelector @ [prscX](https://github.com/prscX)
## 💖 Support my projects
I open-source almost everything I can, and I try to reply everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).
However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:
* Starring and sharing the projects you like 🚀
* If you're feeling especially charitable, please follow [prscX](https://github.com/prscX) on GitHub.
Thanks! ❤️
[prscX.github.io](https://prscx.github.io)
Pranav >