uppy/website/src/docs/react-native.md
Pedro Fernandes Steimbruch f54c6dad99
Improve react docs (#1936)
Co-authored-by: Renée Kooi <renee@kooi.me>
2020-07-13 12:51:30 +02:00

1.5 KiB
Raw Blame History

title type module permalink order category
React Native docs @uppy/react-native docs/react/native/ 8 React

⚠️ In Beta

@uppy/react-native is a basic Uppy component for React Native with Expo. It is in Beta, and is not full-featured. You can select local images or videos, take pictures with a camera or add any files from remote urls with the help of a server-side component, Uppy Companion.

Make sure to check out the example in examples/react-native-expo.

Installation

Install from NPM:

npm install @uppy/react-native
import UppyFilePicker from '@uppy/react-native'

render () {
  <UppyFilePicker
    uppy={this.uppy}
    show={this.state.isFilePickerVisible}
    onRequestClose={this.hideFilePicker}
    companionUrl="https://server.uppy.io" />
}

Props

The <UppyFilePicker> component supports the following props:

uppy

The uppy instance. Initialize in constructor, add all the nessesary plugins, set up event listeners, before passing as a prop.

show

Boolean — the <UppyFilePicker> modal component will be rendered when set to true.

onRequestClose

A callback thats called when a file is picked or a “close” button is pressed. Use it to hide <UppyFilePicker>, like in the example above.

companionUrl

Uppy Companion url.