DOC: document addShortcut click option (#12467)

2025-02-22 12:17:12 +00:00 · 2021-03-22 09:51:45 +01:00 · 2021-03-22 09:51:45 +01:00 · c3e76da90a
commit c3e76da90a
parent 4857891ecf
1 changed files with 2 additions and 0 deletions
--- a/app/assets/javascripts/discourse/app/lib/keyboard-shortcuts.js
+++ b/app/assets/javascripts/discourse/app/lib/keyboard-shortcuts.js
@ -194,6 +194,8 @@ export default {
   * - path       - a specific path to limit the shortcut to .e.g /latest
   * - postAction - binds the shortcut to fire the specified post action when a
   *                post is selected
+   * - click      - allows to provide a selector on which a click event
+   *                will be triggered, eg: { click: ".topic.last .title" }
   **/
  addShortcut(shortcut, callback, opts = {}) {
    // we trim but leave whitespace between characters, as shortcuts