You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
99 lines
2.5 KiB
99 lines
2.5 KiB
"use strict";
|
|
|
|
/**
|
|
* 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.
|
|
*/
|
|
const Translator = require("@uppy/utils/lib/Translator");
|
|
|
|
class BasePlugin {
|
|
constructor(uppy, opts) {
|
|
if (opts === void 0) {
|
|
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');
|
|
} // TODO: remove in the next major version. It's not feasible to
|
|
// try to use plugins with other frameworks.
|
|
// 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() {}
|
|
|
|
}
|
|
|
|
module.exports = BasePlugin;
|