@filerobot/progress-panel
TypeScript icon, indicating that this package has built-in type declarations

3.36.6 • Public • Published

@filerobot/progress-panel

Plugins Website Version Scaleflex team License CodeSandbox

Filerobot Widget logo

A panel showing the progress of uploading, downloading, transforming with possibility to cancel/retry/show location in Filerobot Media Asset Widget.

Usage

NPM

npm install --save @filerobot/progress-panel

YARN

yarn add @filerobot/progress-panel

then

import ProgressPanel from '@filerobot/progress-panel'
...
...
...
filerobot.use(ProgressPanel, propertiesObject)

From CDN

The plugin from CDN is found inside Filerobot global object Filerobot.ProgressPanel

const ProgressPanel = window.Filerobot.ProgressPanel
...
...
...
filerobot.use(ProgressPanel, propertiesObject)

If you are using @filerobot/explorer plugin you don't need to manually import this plugin as it is being imported automatically there with its styles and the default id ProgressPanel.

Plugin's styles

import '@filerobot/core/dist/style.css'

or if you prefer the minified version

import '@filerobot/core/dist/style.min.css'

The plugin's css file should be imported after the Core's css file for having the styles shown correctly.

Properties

locateFile

Type: function.

Default: undefined

Locates the file after it was uploaded.

hideLocateButton

Type: boolean.

Default: false

hide locate button after upload complete.

locale

Type: object.

Default:

strings: {
  progressPanelProcessingHeaderLabel: 'Processing',
  progressPanelProcessedHeaderLabel: 'Processed',
  progressPanelHeaderItemsText: {
    0: 'item',
    1: 'items'
  },
  progressPanelEtaLeftText: '%{time} left',
  progressPanelActivityCompleteLabel: 'Uploaded',
  progressPanelActivityErrorLabel: 'Uploading failed',
  progressPanelActivityProgressLabel: 'Uploading',
  progressPanelCompleteActionTitle: 'show file location',
  progressPanelErrorActionTitle: 'retry',
  progressPanelProgressActionTitle: 'cancel'
}

Customizing some of the translations or the language's strings and replace the default locale.

Readme

Keywords

none

Package Sidebar

Install

npm i @filerobot/progress-panel

Weekly Downloads

586

Version

3.36.6

License

MIT

Unpacked Size

126 kB

Total Files

29

Last publish

Collaborators

  • philipka
  • amrw.js
  • amr26
  • ahmeeedmostafa
  • vitaly.shaposhnik