github-mirror/discourse
2
0
Fork 0
mirror of https://github.com/discourse/discourse.git synced 2024-11-22 09:41:29 +08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
913fd3a7b3
discourse/plugins/discourse-details
History
Alan Guo Xiang Tan 913fd3a7b3
DEV: Improve addToolbarPopupMenuOptionsCallback plugin api (#23769) 
Why this change?

Previously just using the `addToolbarPopupMenuOptionsCallback` plugin
API itself was insufficient because it required the return object to
include an `action` key which only accepted a name of the action
function as a string. This was highly problematic because the action
function had to be defined on the `composer` service which means using
the `modifyClass` API to add the action function. This made the API
awkward to use leading to poor developer experiencec.

What does this change do?

This commit introduces a couple of improvemnts to the API.

1. First the API has been renamed to `addComposerToolbarPopupMenuOption` because
   the API no longer accepts a callback function which was quite
   redundant. Instead, it now accepts an Object. The
   `addToolbarPopupMenuOptionsCallback` API function is deprecated and
   will be dropped in Discourse 3.3. Note that passing the API a
   function is still supported but will be dropped when the `addToolbarPopupMenuOptionsCallback`
   is removed.

2. The `action` key in the Object passed to the function can now be a
   function and is passed the `toolbarEvent` object when called.

3. The `condition` on key in the Object passed to the function can now be a
   function and is passed the `composer` service when called.
2023-10-06 07:43:40 +08:00
..
assets DEV: Improve addToolbarPopupMenuOptionsCallback plugin api (#23769) 2023-10-06 07:43:40 +08:00
config Update translations (#23099) 2023-08-15 21:24:57 +02:00
spec/components DEV: Apply syntax_tree formatting to plugins/* 2023-01-07 11:11:37 +00:00
test/javascripts DEV: Improve addToolbarPopupMenuOptionsCallback plugin api (#23769) 2023-10-06 07:43:40 +08:00
LICENSE
plugin.rb FIX: Hide core plugins from the admin Plugins list (#23328) 2023-08-31 10:01:01 +10:00
README.md for docs, normalize on space after code fence when specifying lang 2019-01-21 01:19:28 -08:00

README.md

discourse-details

HTML 5.1 <details> polyfill for Discourse.

NOTE: Does not work on IE9, but we don't support IE9 as of Jan 1 2016.

Usage

In your posts, surround text with [details=your summary] ... [/details].
For example:

   I watched the murder mystery on TV last night. [details=Who did it?]The butler did it[/details].

Installation

Follow our Install a Plugin howto, using
git clone https://github.com/discourse/discourse-details.git as the plugin command.

Issues

If you have issues or suggestions for the plugin, please bring them up on Discourse Meta.

License

MIT