@univerjs/ui 0.5.5 → 0.6.0-alpha.0

package/lib/es/facade.js

@@ -1,25 +1,59 @@
-var x = Object.defineProperty;
-var U = (n, e, t) => e in n ? x(n, e, { enumerable: !0, configurable: !0, writable: !0, value: t }) : n[e] = t;
-var o = (n, e, t) => U(n, typeof e != "symbol" ? e + "" : e, t);
-import { Inject as l, Injector as v, ICommandService as u, FBase as b, Tools as B, CommandType as D, FUniver as j, connectInjector as F, FHooks as P, FEnum as M } from "@univerjs/core";
-import { IMenuManagerService as C, MenuItemType as y, RibbonStartGroup as O, RibbonPosition as T, MenuManagerPosition as w, IShortcutService as R, CopyCommand as m, PasteCommand as p, ISidebarService as $, IDialogService as G, ComponentManager as f, IMessageService as V, IUIPartsService as d, SheetPasteShortKeyCommandName as N, BuiltInUIPart as H } from "@univerjs/ui";
-var L = Object.defineProperty, A = Object.getOwnPropertyDescriptor, E = (n, e, t, r) => {
-  for (var i = r > 1 ? void 0 : r ? A(e, t) : e, s = n.length - 1, c; s >= 0; s--)
+var F = Object.defineProperty;
+var D = (n, e, t) => e in n ? F(n, e, { enumerable: !0, configurable: !0, writable: !0, value: t }) : n[e] = t;
+var o = (n, e, t) => D(n, typeof e != "symbol" ? e + "" : e, t);
+import { Inject as v, Injector as b, ICommandService as u, Tools as O, CommandType as w, FBase as j, FUniver as P, connectInjector as R, FHooks as M, FEnum as C } from "@univerjs/core";
+import { IMenuManagerService as y, MenuItemType as E, RibbonStartGroup as T, RibbonPosition as $, MenuManagerPosition as G, IShortcutService as V, CopyCommand as p, PasteCommand as S, ISidebarService as N, IDialogService as H, ComponentManager as f, IMessageService as L, IUIPartsService as m, SheetPasteShortKeyCommandName as A, BuiltInUIPart as K } from "@univerjs/ui";
+var W = Object.defineProperty, q = Object.getOwnPropertyDescriptor, x = (n, e, t, r) => {
+  for (var i = r > 1 ? void 0 : r ? q(e, t) : e, s = n.length - 1, c; s >= 0; s--)
     (c = n[s]) && (i = (r ? c(e, t, i) : c(i)) || i);
-  return r && i && L(e, t, i), i;
-}, h = (n, e) => (t, r) => e(t, r, n), a;
-let S = (a = class extends b {
+  return r && i && W(e, t, i), i;
+}, d = (n, e) => (t, r) => e(t, r, n);
+class U extends j {
+  /**
+   * Append the menu to any menu position on Univer UI.
+   * @param {string | string[]} path - Some predefined path to append the menu. The paths can be an array,
+   * or an array joined by `|` separator. Since lots of submenus reuse the same name,
+   * you may need to specify their parent menus as well.
+   *
+   * @example
+   * ```typescript
+   * // This menu item will appear on every `contextMenu.others` section.
+   * univerAPI.createMenu({
+   *   id: 'custom-menu-id-1',
+   *   title: 'Custom Menu 1',
+   *   action: () => {},
+   * }).appendTo('contextMenu.others');
+   *
+   * // This menu item will only appear on the `contextMenu.others` section on the main area.
+   * univerAPI.createMenu({
+   *   id: 'custom-menu-id-2',
+   *   title: 'Custom Menu 2',
+   *   action: () => { console.log(123); },
+   * }).appendTo(['contextMenu.mainArea', 'contextMenu.others']);
+   * ```
+   */
+  appendTo(e) {
+    const t = typeof e == "string" ? e.split("|") : e, r = t.length, i = {};
+    let s = i;
+    const c = this.__getSchema();
+    t.forEach((h, B) => {
+      B === r - 1 ? s[h] = c : s[h] = {}, s = s[h];
+    }), this._menuManagerService.mergeMenu(i);
+  }
+}
+var a;
+let _ = (a = class extends U {
   constructor(e, t, r, i) {
     super();
     o(this, "_commandToRegister", /* @__PURE__ */ new Map());
     o(this, "_buildingSchema");
     this._item = e, this._injector = t, this._commandService = r, this._menuManagerService = i;
-    const s = typeof e.action == "string" ? e.action : B.generateRandomId(12);
+    const s = typeof e.action == "string" ? e.action : O.generateRandomId(12);
     s !== e.action && this._commandToRegister.set(s, e.action), this._buildingSchema = {
       // eslint-disable-next-line ts/explicit-function-return-type
       menuItemFactory: () => ({
         id: e.id,
-        type: y.BUTTON,
+        type: E.BUTTON,
         // we only support button for now
         icon: e.icon,
         title: e.title,
@@ -28,33 +62,25 @@ let S = (a = class extends b {
       })
     }, typeof e.order < "u" && (this._buildingSchema.order = e.order);
   }
-  /** @ignore */
+  /**
+   * @ignore
+   */
   __getSchema() {
     return this._commandToRegister.forEach((e, t) => {
       this._commandService.hasCommand(t) || this._commandService.registerCommand({
         id: t,
-        type: D.COMMAND,
+        type: w.COMMAND,
         handler: e
       });
     }), { [this._item.id]: this._buildingSchema };
   }
-  /**
-   * Append the menu to any menu position on Univer UI.
-   * @param path Some predefined path to append the menu.
-   */
-  appendTo(e) {
-    const t = this.__getSchema();
-    this._menuManagerService.mergeMenu({
-      [e]: t
-    });
-  }
-}, o(a, "RibbonStartGroup", O), o(a, "RibbonPosition", T), o(a, "MenuManagerPosition", w), a);
-S = E([
-  h(1, l(v)),
-  h(2, u),
-  h(3, C)
-], S);
-let _ = class extends b {
+}, o(a, "RibbonStartGroup", T), o(a, "RibbonPosition", $), o(a, "MenuManagerPosition", G), a);
+_ = x([
+  d(1, v(b)),
+  d(2, u),
+  d(3, y)
+], _);
+let g = class extends U {
   constructor(e, t, r) {
     super();
     o(this, "_menuByGroups", []);
@@ -64,7 +90,7 @@ let _ = class extends b {
       // eslint-disable-next-line ts/explicit-function-return-type
       menuItemFactory: () => ({
         id: e.id,
-        type: y.SUBITEMS,
+        type: E.SUBITEMS,
         icon: e.icon,
         title: e.title,
         tooltip: e.tooltip
@@ -73,30 +99,22 @@ let _ = class extends b {
   }
   /**
    * Add a menu to the submenu. It can be a {@link FMenu} or a {@link FSubmenu}.
-   * @param submenu Menu to add to the submenu.
-   * @returns The FSubmenu itself for chaining calls.
+   * @param {FMenu | FSubmenu} submenu - Menu to add to the submenu.
+   * @returns {FSubmenu} The FSubmenu itself for chaining calls.
    */
   addSubmenu(e) {
     return this._submenus.push(e), this;
   }
   /**
    * Add a separator to the submenu.
-   * @returns The FSubmenu itself for chaining calls.
+   * @returns {FSubmenu} The FSubmenu itself for chaining calls.
    */
   addSeparator() {
     return this._menuByGroups.push(this._submenus), this._submenus = [], this;
   }
   /**
-   * Append the menu to any menu position on Univer UI.
-   * @param path Some predefined path to append the menu.
+   * @ignore
    */
-  appendTo(e) {
-    const t = this.__getSchema();
-    this._menuManagerService.mergeMenu({
-      [e]: t
-    });
-  }
-  /** @ignore */
   __getSchema() {
     const e = {};
     return this.addSeparator(), this._menuByGroups.forEach((t, r) => {
@@ -107,63 +125,87 @@ let _ = class extends b {
     }), { [this._item.id]: Object.assign(this._buildingSchema, e) };
   }
 };
-_ = E([
-  h(1, l(v)),
-  h(2, C)
-], _);
-var K = Object.defineProperty, W = Object.getOwnPropertyDescriptor, q = (n, e, t, r) => {
-  for (var i = r > 1 ? void 0 : r ? W(e, t) : e, s = n.length - 1, c; s >= 0; s--)
+g = x([
+  d(1, v(b)),
+  d(2, y)
+], g);
+var z = Object.defineProperty, J = Object.getOwnPropertyDescriptor, Q = (n, e, t, r) => {
+  for (var i = r > 1 ? void 0 : r ? J(e, t) : e, s = n.length - 1, c; s >= 0; s--)
     (c = n[s]) && (i = (r ? c(e, t, i) : c(i)) || i);
-  return r && i && K(e, t, i), i;
+  return r && i && z(e, t, i), i;
 }, I = (n, e) => (t, r) => e(t, r, n);
-let g = class extends b {
+let l = class extends j {
   constructor(e, t) {
     super();
     o(this, "_forceEscapeDisposable", null);
     this._injector = e, this._shortcutService = t;
   }
+  /**
+   * Enable shortcuts of Univer.
+   * @returns {FShortcut} The Facade API instance itself for chaining.
+   */
   enableShortcut() {
     var e;
-    (e = this._forceEscapeDisposable) == null || e.dispose(), this._forceEscapeDisposable = null;
+    return (e = this._forceEscapeDisposable) == null || e.dispose(), this._forceEscapeDisposable = null, this;
   }
+  /**
+   * Disable shortcuts of Univer.
+   * @returns {FShortcut} The Facade API instance itself for chaining.
+   */
   disableShortcut() {
-    this._forceEscapeDisposable || (this._forceEscapeDisposable = this._shortcutService.forceEscape());
+    return this._forceEscapeDisposable || (this._forceEscapeDisposable = this._shortcutService.forceEscape()), this;
   }
+  /**
+   * Dispatch a KeyboardEvent to the shortcut service and return the matched shortcut item.
+   * @param {KeyboardEvent} e - The KeyboardEvent to dispatch.
+   * @returns {IShortcutItem<object> | undefined} The matched shortcut item.
+   *
+   * @example
+   * ```typescript
+   * const fShortcut = univerAPI.getShortcut();
+   * const pseudoEvent = new KeyboardEvent('keydown', { key: 's', ctrlKey: true });
+   * const ifShortcutItem = fShortcut.dispatchShortcutEvent(pseudoEvent);
+   * if (ifShortcutItem) {
+   *   const commandId = ifShortcutItem.id;
+   *   // Do something with the commandId.
+   * }
+   * ```
+   */
   dispatchShortcutEvent(e) {
     return this._shortcutService.dispatch(e);
   }
 };
-g = q([
-  I(0, l(v)),
-  I(1, R)
-], g);
-class z extends j {
+l = Q([
+  I(0, v(b)),
+  I(1, V)
+], l);
+class X extends P {
   getURL() {
     return new URL(window.location.href);
   }
   getShortcut() {
-    return this._injector.createInstance(g);
+    return this._injector.createInstance(l);
   }
   copy() {
-    return this._commandService.syncExecuteCommand(m.id);
+    return this._commandService.syncExecuteCommand(p.id);
   }
   paste() {
-    return this._commandService.syncExecuteCommand(p.id);
+    return this._commandService.syncExecuteCommand(S.id);
   }
   createMenu(e) {
-    return this._injector.createInstance(S, e);
+    return this._injector.createInstance(_, e);
   }
   createSubmenu(e) {
-    return this._injector.createInstance(_, e);
+    return this._injector.createInstance(g, e);
   }
   openSiderbar(e) {
-    return this._injector.get($).open(e);
+    return this._injector.get(N).open(e);
   }
   openSidebar(e) {
     return this.openSiderbar(e);
   }
   openDialog(e) {
-    const r = this._injector.get(G).open({
+    const r = this._injector.get(H).open({
       ...e,
       onClose: () => {
         r.dispose();
@@ -175,49 +217,49 @@ class z extends j {
     return this._injector.get(f);
   }
   showMessage(e) {
-    return this._injector.get(V).show(e), this;
+    return this._injector.get(L).show(e), this;
   }
   setUIVisible(e, t) {
-    return this._injector.get(d).setUIVisible(e, t), this;
+    return this._injector.get(m).setUIVisible(e, t), this;
   }
   isUIVisible(e) {
-    return this._injector.get(d).isUIVisible(e);
+    return this._injector.get(m).isUIVisible(e);
   }
   registerUIPart(e, t) {
-    return this._injector.get(d).registerComponent(e, () => F(t, this._injector));
+    return this._injector.get(m).registerComponent(e, () => R(t, this._injector));
   }
   registerComponent(e, t, r) {
     const i = this._injector.get(f);
     return this.disposeWithMe(i.register(e, t, r));
   }
 }
-j.extend(z);
-class J extends P {
+P.extend(X);
+class Y extends M {
   onBeforeCopy(e) {
     return this._injector.get(u).beforeCommandExecuted((r) => {
-      r.id === m.id && e();
+      r.id === p.id && e();
     });
   }
   onCopy(e) {
     return this._injector.get(u).onCommandExecuted((r) => {
-      r.id === m.id && e();
+      r.id === p.id && e();
     });
   }
   onBeforePaste(e) {
     return this._injector.get(u).beforeCommandExecuted((r) => {
-      r.id === p.id && e();
+      r.id === S.id && e();
     });
   }
   onPaste(e) {
     return this._injector.get(u).onCommandExecuted((r) => {
-      (r.id === p.id || r.id === N) && e();
+      (r.id === S.id || r.id === A) && e();
     });
   }
 }
-P.extend(J);
-class Q extends M {
+M.extend(Y);
+class Z extends C {
   get BuiltInUIPart() {
-    return H;
+    return K;
   }
 }
-M.extend(Q);
+C.extend(Z);