ooxml-ui 0.26.0 → 0.27.1

package/dist/{chunk-4R4CHY5X.js → chunk-4PBFBPOH.js}

@@ -4620,6 +4620,68 @@ function attachKeyTips(scope) {
   return handle;
 }
 
+// src/ribbon/keytip-run.ts
+var clash = (used, key) => used.some((other) => other.startsWith(key) || key.startsWith(other));
+function assignKeyTips(targets, label) {
+  const used = [];
+  for (const target of targets) {
+    if (target.key && !clash(used, target.key)) used.push(target.key);
+    else target.key = "";
+  }
+  for (const target of targets.filter((item) => !item.key)) {
+    const source = label(target).toUpperCase().replace(/[^A-Z0-9]/g, "") || "ZZ";
+    let key = "";
+    for (let a = 0; a < source.length && !key; a++)
+      for (let b = a + 1; b < source.length && !key; b++) {
+        const candidate = source[a] + source[b];
+        if (!clash(used, candidate)) key = candidate;
+      }
+    for (let n = 10; !key; n++) if (!clash(used, String(n))) key = String(n);
+    used.push(key);
+    target.key = key;
+  }
+}
+function runKeyTips(root, targets, onDone, className) {
+  const doc = root.ownerDocument;
+  const shown = targets.map((target) => {
+    const node = doc.createElement("span");
+    node.className = className;
+    node.textContent = target.key;
+    node.setAttribute("aria-hidden", "true");
+    const box = target.element.getBoundingClientRect();
+    node.style.position = "fixed";
+    node.style.left = `${box.left + box.width / 2}px`;
+    node.style.top = `${box.bottom - 10}px`;
+    root.append(node);
+    return { node, target };
+  });
+  let typed = "";
+  const stop = () => {
+    for (const { node } of shown) node.remove();
+    root.removeEventListener("keydown", onKey, true);
+    root.removeEventListener("pointerdown", stop, true);
+    onDone();
+  };
+  function onKey(event) {
+    if (event.key === "Alt" || event.key === "Shift") return;
+    event.preventDefault();
+    event.stopPropagation();
+    if (event.key === "Escape" || event.ctrlKey || event.metaKey) return stop();
+    typed += event.key.toUpperCase();
+    const matches = shown.filter(({ target }) => target.key.startsWith(typed));
+    if (!matches.length) return stop();
+    for (const { node, target } of shown) node.hidden = !target.key.startsWith(typed);
+    const exact = matches.find(({ target }) => target.key === typed);
+    if (exact) {
+      stop();
+      exact.target.activate();
+    }
+  }
+  root.addEventListener("keydown", onKey, true);
+  root.addEventListener("pointerdown", stop, true);
+  return stop;
+}
+
 // src/ribbon/overflow.ts
 function createRibbonOverflow(options) {
   let closeOpen;
@@ -4791,4 +4853,4 @@ function registerControls(registry) {
   for (const define of CONTROL_DEFINERS) define(registry);
 }
 
-export { CONTROL_DEFINERS, DEFAULT_OFFICE_PROFILE, EMPTY_MENU_STATE, OFFICE_AVATAR_SWATCHES, OFFICE_PROFILE_STORAGE_KEY, OFFICE_TITLE_BAR_SEARCH_LIMIT, OFFICE_TOAST_VISIBLE_LIMIT, attachKeyTips, clampFlyoutPosition, clampOptionNumber, clearOfficeProfile, createRibbonOverflow, defineAccount, defineBackstage, defineButton, defineCheckbox, defineCommandSearch, defineContextMenu, defineDialog, defineDialogFooter, defineFindBar, defineGallery, defineIcon, defineMenuButton, defineMenuItem, defineMenuSeparator, defineOptionsDialog, definePasteOptions, definePrintPreview, defineRadio, defineReadOnlyBanner, defineRibbon, defineRibbonGroup, defineRibbonSection, defineRibbonStack, defineRibbonToggle, defineRuler, defineSearchField, defineSelect, defineStatusBar, defineStatusItem, defineSwitch, defineTabStrip, defineTitleBar, defineToasts, defineToolbar, defineZoomSlider, glyph, nextEnabledIndex, parseSvgPreview, profileInitials, readOfficeProfile, registerControls, rulerDivisions, sanitizeOfficeProfile, typeAheadIndex, writeOfficeProfile };
+export { CONTROL_DEFINERS, DEFAULT_OFFICE_PROFILE, EMPTY_MENU_STATE, OFFICE_AVATAR_SWATCHES, OFFICE_PROFILE_STORAGE_KEY, OFFICE_TITLE_BAR_SEARCH_LIMIT, OFFICE_TOAST_VISIBLE_LIMIT, assignKeyTips, attachKeyTips, clampFlyoutPosition, clampOptionNumber, clearOfficeProfile, createRibbonOverflow, defineAccount, defineBackstage, defineButton, defineCheckbox, defineCommandSearch, defineContextMenu, defineDialog, defineDialogFooter, defineFindBar, defineGallery, defineIcon, defineMenuButton, defineMenuItem, defineMenuSeparator, defineOptionsDialog, definePasteOptions, definePrintPreview, defineRadio, defineReadOnlyBanner, defineRibbon, defineRibbonGroup, defineRibbonSection, defineRibbonStack, defineRibbonToggle, defineRuler, defineSearchField, defineSelect, defineStatusBar, defineStatusItem, defineSwitch, defineTabStrip, defineTitleBar, defineToasts, defineToolbar, defineZoomSlider, glyph, nextEnabledIndex, parseSvgPreview, profileInitials, readOfficeProfile, registerControls, rulerDivisions, runKeyTips, sanitizeOfficeProfile, typeAheadIndex, writeOfficeProfile };

package/dist/controls.d.ts

@@ -45,6 +45,8 @@ export { attachKeyTips, type KeyTipsHandle } from './keytips.js';
 export type { OfficeBackstageCloseEvent, OfficeBackstageItem, OfficeBackstageSelectEvent, } from './chrome/backstage.js';
 export type { OfficeFindInputEvent, OfficeFindStepEvent } from './chrome/find-bar.js';
 export type { OfficePrintPreviewPageEvent } from './chrome/print-preview.js';
+export { assignKeyTips, runKeyTips } from './ribbon/keytip-run.js';
+export type { KeyTipTarget } from './ribbon/keytip-run.js';
 export { createRibbonOverflow } from './ribbon/overflow.js';
 export type { RibbonOverflow, RibbonOverflowOptions } from './ribbon/overflow.js';
 export type { OfficeRibbonSelectEvent } from './ribbon/ribbon-tabs.js';

package/dist/controls.js

@@ -1,4 +1,4 @@
-export { CONTROL_DEFINERS, DEFAULT_OFFICE_PROFILE, EMPTY_MENU_STATE, OFFICE_AVATAR_SWATCHES, OFFICE_PROFILE_STORAGE_KEY, OFFICE_TITLE_BAR_SEARCH_LIMIT, OFFICE_TOAST_VISIBLE_LIMIT, attachKeyTips, clampFlyoutPosition, clampOptionNumber, clearOfficeProfile, createRibbonOverflow, defineAccount, defineBackstage, defineButton, defineCheckbox, defineCommandSearch, defineContextMenu, defineDialog, defineDialogFooter, defineFindBar, defineGallery, defineIcon, defineMenuButton, defineMenuItem, defineMenuSeparator, defineOptionsDialog, definePasteOptions, definePrintPreview, defineRadio, defineReadOnlyBanner, defineRibbon, defineRibbonGroup, defineRibbonSection, defineRibbonStack, defineRibbonToggle, defineRuler, defineSearchField, defineSelect, defineStatusBar, defineStatusItem, defineSwitch, defineTabStrip, defineTitleBar, defineToasts, defineToolbar, defineZoomSlider, nextEnabledIndex, parseSvgPreview, profileInitials, readOfficeProfile, registerControls, rulerDivisions, sanitizeOfficeProfile, typeAheadIndex, writeOfficeProfile } from './chunk-4R4CHY5X.js';
+export { CONTROL_DEFINERS, DEFAULT_OFFICE_PROFILE, EMPTY_MENU_STATE, OFFICE_AVATAR_SWATCHES, OFFICE_PROFILE_STORAGE_KEY, OFFICE_TITLE_BAR_SEARCH_LIMIT, OFFICE_TOAST_VISIBLE_LIMIT, assignKeyTips, attachKeyTips, clampFlyoutPosition, clampOptionNumber, clearOfficeProfile, createRibbonOverflow, defineAccount, defineBackstage, defineButton, defineCheckbox, defineCommandSearch, defineContextMenu, defineDialog, defineDialogFooter, defineFindBar, defineGallery, defineIcon, defineMenuButton, defineMenuItem, defineMenuSeparator, defineOptionsDialog, definePasteOptions, definePrintPreview, defineRadio, defineReadOnlyBanner, defineRibbon, defineRibbonGroup, defineRibbonSection, defineRibbonStack, defineRibbonToggle, defineRuler, defineSearchField, defineSelect, defineStatusBar, defineStatusItem, defineSwitch, defineTabStrip, defineTitleBar, defineToasts, defineToolbar, defineZoomSlider, nextEnabledIndex, parseSvgPreview, profileInitials, readOfficeProfile, registerControls, rulerDivisions, runKeyTips, sanitizeOfficeProfile, typeAheadIndex, writeOfficeProfile } from './chunk-4PBFBPOH.js';
 import './chunk-HZ422LTR.js';
 import './chunk-V6W5DKJ6.js';
 import './chunk-ZWBP2WTC.js';

package/dist/index.js

@@ -1,7 +1,7 @@
 import { installOfficeUiTheme } from './chunk-7QLJS57B.js';
 export { THEME_CSS, THEME_STYLE_ID, installOfficeUiTheme, shadcnBridge, themeBridge } from './chunk-7QLJS57B.js';
-import { registerControls } from './chunk-4R4CHY5X.js';
-export { CONTROL_DEFINERS, DEFAULT_OFFICE_PROFILE, EMPTY_MENU_STATE, OFFICE_AVATAR_SWATCHES, OFFICE_PROFILE_STORAGE_KEY, OFFICE_TITLE_BAR_SEARCH_LIMIT, OFFICE_TOAST_VISIBLE_LIMIT, attachKeyTips, clampFlyoutPosition, clampOptionNumber, clearOfficeProfile, createRibbonOverflow, defineAccount, defineBackstage, defineButton, defineCheckbox, defineCommandSearch, defineContextMenu, defineDialog, defineDialogFooter, defineFindBar, defineGallery, defineIcon, defineMenuButton, defineMenuItem, defineMenuSeparator, defineOptionsDialog, definePasteOptions, definePrintPreview, defineRadio, defineReadOnlyBanner, defineRibbon, defineRibbonGroup, defineRibbonSection, defineRibbonStack, defineRibbonToggle, defineRuler, defineSearchField, defineSelect, defineStatusBar, defineStatusItem, defineSwitch, defineTabStrip, defineTitleBar, defineToasts, defineToolbar, defineZoomSlider, glyph, nextEnabledIndex, parseSvgPreview, profileInitials, readOfficeProfile, registerControls, rulerDivisions, sanitizeOfficeProfile, typeAheadIndex, writeOfficeProfile } from './chunk-4R4CHY5X.js';
+import { registerControls } from './chunk-4PBFBPOH.js';
+export { CONTROL_DEFINERS, DEFAULT_OFFICE_PROFILE, EMPTY_MENU_STATE, OFFICE_AVATAR_SWATCHES, OFFICE_PROFILE_STORAGE_KEY, OFFICE_TITLE_BAR_SEARCH_LIMIT, OFFICE_TOAST_VISIBLE_LIMIT, assignKeyTips, attachKeyTips, clampFlyoutPosition, clampOptionNumber, clearOfficeProfile, createRibbonOverflow, defineAccount, defineBackstage, defineButton, defineCheckbox, defineCommandSearch, defineContextMenu, defineDialog, defineDialogFooter, defineFindBar, defineGallery, defineIcon, defineMenuButton, defineMenuItem, defineMenuSeparator, defineOptionsDialog, definePasteOptions, definePrintPreview, defineRadio, defineReadOnlyBanner, defineRibbon, defineRibbonGroup, defineRibbonSection, defineRibbonStack, defineRibbonToggle, defineRuler, defineSearchField, defineSelect, defineStatusBar, defineStatusItem, defineSwitch, defineTabStrip, defineTitleBar, defineToasts, defineToolbar, defineZoomSlider, glyph, nextEnabledIndex, parseSvgPreview, profileInitials, readOfficeProfile, registerControls, rulerDivisions, runKeyTips, sanitizeOfficeProfile, typeAheadIndex, writeOfficeProfile } from './chunk-4PBFBPOH.js';
 import { defineSmartArt } from './chunk-4VQ6S7QJ.js';
 export { OfficeUiSmartArt, defineSmartArt, renderDiagramDrawing } from './chunk-4VQ6S7QJ.js';
 import { TEAMS_TAGS, registerTeams } from './chunk-LE4FTRWB.js';

package/dist/ribbon/keytip-run.d.ts

@@ -0,0 +1,27 @@
+/**
+ * The second level of Office KeyTips for products that derive their tips from a ribbon panel: give
+ * each visible command a key (the product's own Office keys where the command exists, otherwise two
+ * letters of its label, never the prefix of another), show a badge over each and run the one whose
+ * letters are typed. Word and Excel use the same loop and differ only in the key table and in how a
+ * control is found and operated, so those stay with the product.
+ */
+export interface KeyTipTarget {
+    /** The letters or digits to type; empty before {@link assignKeyTips}. */
+    key: string;
+    /** The element the badge sits under. */
+    element: HTMLElement;
+    /** What the tip does: open the control, or click it. */
+    activate(): void;
+}
+/**
+ * Makes every key unique and unambiguous. A key that is already set stays unless an earlier one
+ * clashes with it (Office's own keys differ per tab, so two commands can share one); the others get
+ * two letters from `label(target)`, then a number.
+ */
+export declare function assignKeyTips(targets: readonly KeyTipTarget[], label: (target: KeyTipTarget) => string): void;
+/**
+ * Shows fixed badges over `targets` (in `root`, so product CSS styles them through `className`) and
+ * runs the one whose letters are typed. Escape, a pointer press or a key with no match ends it;
+ * `onDone` runs after any end. Returns a function that stops it.
+ */
+export declare function runKeyTips(root: HTMLElement, targets: readonly KeyTipTarget[], onDone: () => void, className: string): () => void;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "ooxml-ui",
-	"version": "0.26.0",
+	"version": "0.27.1",
 	"description": "Shared, format-neutral web components and styles for the Office viewers (Word, PowerPoint, Excel)",
 	"keywords": [
 		"custom-elements",
@@ -85,7 +85,7 @@
 	},
 	"dependencies": {
 		"lit": "^3.3.3",
-		"ooxml-core": "^0.17.0"
+		"ooxml-core": "^0.18.0"
 	},
 	"devDependencies": {
 		"@types/jsdom": "^30.0.0",