uppy/website/src/docs/react-statusbar.md
Antoine du Hamel c48064ba56
doc: lint JS code snippets (#2954)
* doc: lint JS code snippets

* deps: update `lint-staged` deps

* Fix remaining lint warnings and errors

Co-authored-by: Artur Paikin <artur@arturpaikin.com>
2021-07-04 19:32:50 +02:00

1.3 KiB

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.

Installation

Install from NPM:

npm install @uppy/react
import { StatusBar } from '@uppy/react'

// Alternatively, you can also use a default import:
// import StatusBar from '@uppy/react/lib/StatusBar'

CSS

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.

Props

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'

  <StatusBar
    uppy={uppy}
    hideUploadButton
    hideAfterFinish={false}
    showProgressDetails
  />