mirror of
https://github.com/transloadit/uppy.git
synced 2026-07-18 00:55:35 +00:00
9a213b59da
- `@uppy/aws/s3-multipart`: remove `client` getter and setter. - reason: internal usage only - migrate: use exposed options only - `@uppy/core`: remove `AggregateError` polyfill - reason: [should be polyfilled by the user](https://github.com/transloadit/uppy/pull/3532#discussion_r818602636) - migrate: install `AggregateError` polyfill or use `core-js` - `@uppy/core`: remove `reset()` method - reason: it's a duplicate of `cancelAll`, but with a less intention revealing name - migrate: use `cancelAll` - `@uppy/core`: remove backwards compatible exports (static properties on `Uppy`) - reason: transition to ESM - migrate: import the `Uppy` class by default and/or use named exports for everything else. - `@uppy/react`: don't expose `validProps` - reason: internal only - migrate: do not depend on this - `@uppy/store-redux`: remove backwards compatible exports (static properties on `ReduxStore`) - reason: transition to ESM - migrate: use named imports - `@uppy/thumbnail-generator`: remove `rotateImage`, `protect`, and `canvasToBlob` from prototype. - reason: internal only - migrate: don't depend on this
84 lines
2.3 KiB
JavaScript
84 lines
2.3 KiB
JavaScript
/**
|
|
* Core plugin logic that all plugins share.
|
|
*
|
|
* BasePlugin does not contain DOM rendering so it can be used for plugins
|
|
* without a user interface.
|
|
*
|
|
* See `Plugin` for the extended version with Preact rendering for interfaces.
|
|
*/
|
|
|
|
import Translator from '@uppy/utils/lib/Translator'
|
|
|
|
export default class BasePlugin {
|
|
constructor (uppy, opts = {}) {
|
|
this.uppy = uppy
|
|
this.opts = opts
|
|
}
|
|
|
|
getPluginState () {
|
|
const { plugins } = this.uppy.getState()
|
|
return plugins[this.id] || {}
|
|
}
|
|
|
|
setPluginState (update) {
|
|
const { plugins } = this.uppy.getState()
|
|
|
|
this.uppy.setState({
|
|
plugins: {
|
|
...plugins,
|
|
[this.id]: {
|
|
...plugins[this.id],
|
|
...update,
|
|
},
|
|
},
|
|
})
|
|
}
|
|
|
|
setOptions (newOpts) {
|
|
this.opts = { ...this.opts, ...newOpts }
|
|
this.setPluginState() // so that UI re-renders with new options
|
|
this.i18nInit()
|
|
}
|
|
|
|
i18nInit () {
|
|
const translator = new Translator([this.defaultLocale, this.uppy.locale, this.opts.locale])
|
|
this.i18n = translator.translate.bind(translator)
|
|
this.i18nArray = translator.translateArray.bind(translator)
|
|
this.setPluginState() // so that UI re-renders and we see the updated locale
|
|
}
|
|
|
|
/**
|
|
* Extendable methods
|
|
* ==================
|
|
* These methods are here to serve as an overview of the extendable methods as well as
|
|
* making them not conditional in use, such as `if (this.afterUpdate)`.
|
|
*/
|
|
|
|
// eslint-disable-next-line class-methods-use-this
|
|
addTarget () {
|
|
throw new Error('Extend the addTarget method to add your plugin to another plugin\'s target')
|
|
}
|
|
|
|
// eslint-disable-next-line class-methods-use-this
|
|
install () {}
|
|
|
|
// eslint-disable-next-line class-methods-use-this
|
|
uninstall () {}
|
|
|
|
/**
|
|
* Called when plugin is mounted, whether in DOM or into another plugin.
|
|
* Needed because sometimes plugins are mounted separately/after `install`,
|
|
* so this.el and this.parent might not be available in `install`.
|
|
* This is the case with @uppy/react plugins, for example.
|
|
*/
|
|
render () {
|
|
throw new Error('Extend the render method to add your plugin to a DOM element')
|
|
}
|
|
|
|
// eslint-disable-next-line class-methods-use-this
|
|
update () {}
|
|
|
|
// Called after every state update, after everything's mounted. Debounced.
|
|
// eslint-disable-next-line class-methods-use-this
|
|
afterUpdate () {}
|
|
}
|