github-mirror/discourse
2
0
Fork 0
mirror of https://github.com/discourse/discourse.git synced 2024-11-23 02:50:00 +08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

DEV: Update plugin-api docs for new user menu (#20808)

Browse Source 
The updated user menu is the default for new sites, and will soon be enabled on older sites. This commit removes the 'EXPERIMENTAL' warning from the new `registerUserMenuTab` API, and adds a note to the `addUserMenuGlyph` documentation.
This commit is contained in:
David Taylor 2023-04-24 12:00:22 +01:00 committed by GitHub
parent 73f7f81808
commit aa5038a352
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -987,7 +987,7 @@ class PluginApi {
} }
/** /**
* Adds a glyph to user menu after bookmarks * Adds a glyph to the legacy user menu after bookmarks
* WARNING: there is limited space there * WARNING: there is limited space there
* *
* example: * example:
@ -999,6 +999,7 @@ class PluginApi {
* data: { url: `/some/path` }, * data: { url: `/some/path` },
* }); * });
* *
* To customize the new user menu, see api.registerUserMenuTab
*/ */
addUserMenuGlyph(glyph) { addUserMenuGlyph(glyph) {
addUserMenuGlyph(glyph); addUserMenuGlyph(glyph);
@ -2078,7 +2079,6 @@ class PluginApi {
} }
/** /**
* EXPERIMENTAL. Do not use.
* Registers a new tab in the user menu. This API method expects a callback * Registers a new tab in the user menu. This API method expects a callback
* that should return a class inheriting from the class (UserMenuTab) that's * that should return a class inheriting from the class (UserMenuTab) that's
* passed to the callback. See discourse/app/lib/user-menu/tab.js for * passed to the callback. See discourse/app/lib/user-menu/tab.js for