github-mirror/discourse
2
0
Fork 0
mirror of https://github.com/discourse/discourse.git synced 2025-05-25 18:51:48 +08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Add custom post icons to PluginAPI

Browse Source
This commit is contained in:
Robin Ward
2016-02-12 16:57:24 -05:00
parent 9b8871d7dd
commit f9722f8598
6 changed files with 74 additions and 81 deletions
Download Patch File Download Diff File Expand all files Collapse all files

45
app/assets/javascripts/discourse/lib/plugin-api.js.es6
View File

@ -1,5 +1,6 @@
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) {
@ -18,21 +19,61 @@ class PluginApi {
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;
export function getPluginApi(version) {
if (version === "0.1") {
if (!_pluginv01) {
_pluginv01 = new PluginApi(version, Discourse.__container__);
}
return _pluginv01;
} else {
throw `Plugin API v${version} is not supported`;
}
}