title | type | module | permalink | alias | order | category |
---|---|---|---|---|---|---|
<StatusBar /> |
docs |
@uppy/react |
docs/react/status-bar/ |
docs/react/statusbar/ |
2 |
React |
The <StatusBar />
component wraps the @uppy/status-bar
plugin.
Install from NPM:
npm install @uppy/react @uppy/status-bar @uppy/core
import { StatusBar } from '@uppy/react'
// Alternatively, you can also use a default import:
// import StatusBar from '@uppy/react/lib/StatusBar'
The StatusBar
component requires the following CSS for styling:
import '@uppy/core/dist/style.css'
import '@uppy/status-bar/dist/style.css'
Import general Core styles from @uppy/core/dist/style.css
first, then add the Status Bar styles from @uppy/status-bar/dist/style.css
. A minified version is also available as style.min.css
at the same path. The way to do import depends on your build system.
The <StatusBar />
component supports all @uppy/status-bar
options as props. Additionally, an Uppy instance must be provided in the uppy={}
prop: see Initializing Uppy for details.
import React from 'react'
import { StatusBar } from '@uppy/react'
export default function MyComponent (props) {
const { uppy } = props
return (
<StatusBar
// assuming `props.uppy` contains an Uppy instance:
uppy={uppy}
hideUploadButton
hideAfterFinish={false}
showProgressDetails
/>
)
}