mirror of
https://github.com/discourse/discourse.git
synced 2025-06-04 06:24:48 +08:00
5c699e4384
* DEV: Rnemae channel path to just c Also swap the channel id and channel slug params to be consistent with core. * linting * channel_path * Drop slugify helper and channel route without slug * Request slug and route models through the channel model if possible * DEV: Pass messageId as a dynamic segment instead of a query param * Ensure change is backwards-compatible * drop query param from oneboxes * Correctly extract channelId from routes * Better route organization using siblings for regular and near-message * Ensures sessions are unique even when using parallelism * prevents didReceiveAttrs to clear input mid test * we disable animations in capybara so sometimes the message was barely showing * adds wait * ensures finished loading * is it causing more harm than good? * this check is slowing things for no reason * actually target the button * more resilient select chat message * apply similar fix to bookmark * fix --------- Co-authored-by: Joffrey JAFFEUX <j.jaffeux@gmail.com>
⚠️ This plugin is still in active development and may change frequently
Documentation
The Discourse Chat plugin adds chat functionality to your Discourse so it can natively support both long-form and short-form communication needs of your online community.
For documentation, see Discourse Chat
Plugin API
registerChatComposerButton
Usage
api.registerChatComposerButton({ id: "foo", ... });
Options
Every option accepts a value or a function, when passing a function this will be the chat-composer component instance. Example of an option using a function:
api.registerChatComposerButton({
id: "foo",
displayed() {
return this.site.mobileView && this.canAttachUploads;
},
});
Required
idunique, used to identify your button, eg: "gifs"actioncallback when the button is pressed, can be an action name or an anonymous function, eg: "onFooClicked" or() => { console.log("clicked") }
A button requires at least an icon or a label:
icon, eg: "times"label, text displayed on the button, a translatable key, eg: "foo.bar"translatedLabel, text displayed on the button, a string, eg: "Add gifs"
Optional
position, can be "inline" or "dropdown", defaults to "inline"title, title attribute of the button, a translatable key, eg: "foo.bar"translatedTitle, title attribute of the button, a string, eg: "Add gifs"ariaLabel, aria-label attribute of the button, a translatable key, eg: "foo.bar"translatedAriaLabel, aria-label attribute of the button, a string, eg: "Add gifs"classNames, additional names to add to the button’s class attribute, eg: ["foo", "bar"]displayed, hide/or show the button, expects a booleandisabled, sets the disabled attribute on the button, expects a booleanpriority, an integer defining the order of the buttons, higher comes first, eg:700dependentKeys, list of property names which should trigger a refresh of the buttons when changed, eg:["foo.bar", "bar.baz"]