discourse/plugins/chat
Martin Brennan 735e96e5a0
FIX: Ensure hashtag autocomplete is not behind keyboard in chat (#19419)
We must set `treatAsTextarea` to true when using autocomplete
in the chat composer, since it is at the bottom of the screen
we always want to show it above the composer. This fixes the
issue where the hashtag autocomplete results went behind the
keyboard on mobile (which was not happening for mentions).
2022-12-12 15:14:51 +10:00
..
app FIX: webhook should touch channel’s last_message_sent_at (#19342) 2022-12-06 19:33:39 +01:00
assets FIX: Ensure hashtag autocomplete is not behind keyboard in chat (#19419) 2022-12-12 15:14:51 +10:00
config Update translations (#19401) 2022-12-09 12:01:05 +01:00
db DEV: Add messages_count to ChatChannel table (#19295) 2022-12-06 08:40:46 +10:00
lib FIX: Do not return channels for hashtags if user cannot chat (#19417) 2022-12-12 12:24:41 +10:00
public DEV: Move `discourse-chat` to the core repo. (#18776) 2022-11-02 10:41:30 -03:00
spec FIX: Do not return channels for hashtags if user cannot chat (#19417) 2022-12-12 12:24:41 +10:00
test/javascripts FIX: correctly hides admin settings in channel settings (#19384) 2022-12-08 22:48:29 +01:00
README.md DEV: Move `discourse-chat` to the core repo. (#18776) 2022-11-02 10:41:30 -03:00
plugin.rb FEATURE: Enforce mention limits for chat messages (#19034) 2022-12-06 14:54:04 -03:00

README.md

⚠️ 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
  • id unique, used to identify your button, eg: "gifs"
  • action callback 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 buttons class attribute, eg: ["foo", "bar"]
  • displayed, hide/or show the button, expects a boolean
  • disabled, sets the disabled attribute on the button, expects a boolean
  • priority, an integer defining the order of the buttons, higher comes first, eg: 700
  • dependentKeys, list of property names which should trigger a refresh of the buttons when changed, eg: ["foo.bar", "bar.baz"]