123 lines
3.5 KiB
JavaScript
123 lines
3.5 KiB
JavaScript
import { addDecorator } from 'discourse/widgets/post-cooked';
|
|
import ComposerEditor from 'discourse/components/composer-editor';
|
|
import { addPosterIcon } from 'discourse/widgets/poster-name';
|
|
|
|
let _decorateId = 0;
|
|
function decorate(klass, evt, cb) {
|
|
const mixin = {};
|
|
mixin["_decorate_" + (_decorateId++)] = function($elem) { cb($elem); }.on(evt);
|
|
klass.reopen(mixin);
|
|
}
|
|
|
|
export function decorateCooked() {
|
|
console.warn('`decorateCooked` has been removed. Use `getPluginApi(version).decorateCooked` instead');
|
|
}
|
|
|
|
class PluginApi {
|
|
constructor(version, container) {
|
|
this.version = version;
|
|
this.container = container;
|
|
}
|
|
|
|
/**
|
|
* decorateCooked(callback)
|
|
*
|
|
* Used for decorating the `cooked` content of a post after it is rendered using
|
|
* jQuery.
|
|
*
|
|
* `callback` will be called when it is time to decorate with a jQuery selector.
|
|
*
|
|
* For example, to add a yellow background to all posts you could do this:
|
|
*
|
|
* ```
|
|
* api.decorateCooked($elem => $elem.css({ backgroundColor: 'yellow' }));
|
|
* ```
|
|
**/
|
|
decorateCooked(cb) {
|
|
addDecorator(cb);
|
|
decorate(ComposerEditor, 'previewRefreshed', cb);
|
|
decorate(this.container.lookupFactory('view:user-stream'), 'didInsertElement', cb);
|
|
}
|
|
|
|
/**
|
|
* addPosterIcon(callback)
|
|
*
|
|
* This function can be used to add an icon with a link that will be displayed
|
|
* beside a poster's name. The `callback` is called with the post's user custom
|
|
* fields, and will render an icon if it receives an object back.
|
|
*
|
|
* The returned object can have the following attributes:
|
|
*
|
|
* icon (required) the font awesome icon to render
|
|
* className (optional) a css class to apply to the icon
|
|
* url (optional) where to link the icon
|
|
* title (optional) the tooltip title for the icon on hover
|
|
*
|
|
* ```
|
|
* api.addPosterIcon(cfs => {
|
|
* if (cfs.customer) {
|
|
* return { icon: 'user', className: 'customer', title: 'customer' };
|
|
* }
|
|
* });
|
|
* ```
|
|
**/
|
|
addPosterIcon(cb) {
|
|
addPosterIcon(cb);
|
|
}
|
|
}
|
|
|
|
let _pluginv01;
|
|
function getPluginApi(version) {
|
|
if (version === "0.1") {
|
|
if (!_pluginv01) {
|
|
_pluginv01 = new PluginApi(version, Discourse.__container__);
|
|
}
|
|
return _pluginv01;
|
|
} else {
|
|
console.warn(`Plugin API v${version} is not supported`);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* withPluginApi(version, apiCode, noApi)
|
|
*
|
|
* Helper to version our client side plugin API. Pass the version of the API that your
|
|
* plugin is coded against. If that API is available, the `apiCodeCallback` function will
|
|
* be called with the `PluginApi` object.
|
|
*/
|
|
export function withPluginApi(version, apiCodeCallback, opts) {
|
|
opts = opts || {};
|
|
|
|
const api = getPluginApi(version);
|
|
if (api) {
|
|
return apiCodeCallback(api);
|
|
}
|
|
}
|
|
|
|
// This is backported so plugins in the new format will not raise errors
|
|
//
|
|
// To upgrade your plugin for backwards compatibility, you can add code in this
|
|
// form:
|
|
//
|
|
// function newApiCode(api) {
|
|
// // api.xyz();
|
|
// }
|
|
//
|
|
// function oldCode() {
|
|
// // your pre-PluginAPI code goes here. You will be able to delete this
|
|
// // code once the `PluginAPI` has been rolled out to all versions of
|
|
// // Discourse you want to support.
|
|
// }
|
|
//
|
|
// // `newApiCode` will use API version 0.1, if no API support then
|
|
// // `oldCode` will be called
|
|
// withPluginApi('0.1', newApiCode, { noApi: oldCode });
|
|
//
|
|
export function withPluginApi(version, apiCodeCallback, opts) {
|
|
console.warn(`Plugin API v${version} is not supported`);
|
|
|
|
if (opts && opts.noApi) {
|
|
return opts.noApi();
|
|
}
|
|
}
|