Régis Hanol wrote:
Here's the up-to-date list of all the
hooksavailable in Discourse:Client-side (javascript)
addCustomIcon
Event triggered by the
TopicStatusComponentwhen rendering the icons representing the status of a topic.How to use it?
Discourse.TopicStatusComponent.reopen({ onAddCustomIcon: function(buffer) { if (this.get('topic.archetype') === 'poll') { this.renderIcon(buffer, 'square-o', 'poll'); } }.on("addCustomIcon") });additionalButtons
Event triggered by the
TopicFooterButtonsViewwhen rendering the buttons at the bottom of a topic.How to use it? Read the How to add a button at the end of a topic? tutorial.
appendMapInformation
Event triggered by the
TopicMapContainerViewwhen rendering the topic map and any relevant information underneath the first post of a topic.How to use it?
Discourse.TopicMapContainerView.reopen({ onAppendMapInformation: function(container) { // your code }.on("appendMapInformation") });postViewInserted
Event triggered by the
PostViewwhen a post is inserted into the DOM.previewRefreshed
Event triggered by the
ComposerViewwhen the composer's preview renders.Discourse.TopicRoute / setupTopicController
Event triggered by the
TopicRoutewhen a topic is being loaded.Discourse.ApplicationRoute / activate
Event triggered when the ApplicationRoute is activated. This is useful if you need to do something like create a modal once the application has loaded (activated).
How to use it?
Discourse.TopicRoute.on("setupTopicController", function(event) { // Access the controller via: event.controller // Access the model via: event.currentModel });Dialect
Dialects are Discourse's way to extend our text rendering engine. They are made up of two stages. The first runs functions against the input to emit a JsonML intermediate representation. The second stage post-processes the JsonML before it is rendered to the string.
If you are interested in a custom text processor, you will probably find the functions in dialect.js useful and well documented. There are also examples of using the dialect API in the dialects directory of discourse.
parseNode
The
parseNodehook is for looping through the JsonML tree and modifying it in place. It will be called once per node in the tree so try to keep your function light and fast.Discourse.Dialect.on("parseNode", function(event) { var node = event.node, // current node in the tree path = event.path; // depth path to the current node // your logic goes here. });Server-side (ruby)
before_create_post
Event triggered by the
PostCreatorwhen a post is about to be created.How to use it?
class Plugin < DiscoursePlugin def setup listen_for(:before_create_post) end def before_create_post(post) # your code... end end
Posts: 4
Participants: 4
github.com
