pixelize-design-library 2.4.2-beta.63 → 2.4.2-beta.65

package/dist/Components/NavLauncher/NavLauncherProps.d.ts

@@ -1,5 +1,6 @@
 import type { ElementType, KeyboardEvent, MouseEvent, ReactNode } from "react";
 import type { AppOption } from "../AppSwitcher/AppSwitcherProps";
+import type { LauncherSynonyms } from "./engine";
 /** Rendered as `<Icon size={16} aria-hidden />`, so any lucide-compatible component works. */
 export type LauncherIcon = ElementType;
 /** One destination the launcher can open; screens are what pins, Frequent and Recent refer to. */
@@ -33,6 +34,19 @@ export type LauncherSection = {
     label: string;
     modules: readonly LauncherModule[];
 };
+/** One label/value pair of a result, e.g. PAN: ABCDE1234F; plain text only, never HTML. */
+export type LauncherFact = {
+    label: string;
+    value: string;
+    /** Adds a Copy button; a blocked clipboard selects the value instead. */
+    copyable?: boolean;
+};
+/** Direct-answer payload, e.g. label "Next holiday", value "24 Oct — Diwali". */
+export type LauncherAnswer = {
+    label: string;
+    value: string;
+    hint?: string;
+};
 /** A search row that is not a screen: an action (`run`) or an entity result (`href`). */
 export type LauncherSearchItem = {
     id: string;
@@ -40,18 +54,35 @@ export type LauncherSearchItem = {
     /** Second line, e.g. the module a result belongs to. */
     context?: string;
     icon?: LauncherIcon;
-    /** Extra terms the query may match; never rendered. */
+    /** Extra terms the query may match; never rendered. Separate phrases with commas. */
     keywords?: string;
     hint?: string;
     href?: string;
     run?: () => void;
+    /** Shown in the Preview pane for the active result; searchable in spotlight. */
+    facts?: readonly LauncherFact[];
+    /** Read only for items passed in `answers`: the card's label, value and hint. */
+    answer?: LauncherAnswer;
 };
 /** A titled batch of remote results, rendered after Screens in the order given. */
 export type LauncherResultGroup = {
     id: string;
     label: string;
     items: readonly LauncherSearchItem[];
+    /** Scope chip this group belongs to; defaults to `id`. */
+    scope?: string;
+    /** Launcher filters and ranks these items itself; by default they show as given. */
+    matchLocally?: boolean;
+};
+/** A filter chip; "screens" and "actions" are built in, others match `LauncherResultGroup.scope`. */
+export type LauncherScope = {
+    id: string;
+    label: string;
+    /** Field placeholder while this chip is selected, e.g. "Search legal name, PAN, GSTIN…"; the field's accessible name stays `labels.searchPlaceholder`. */
+    placeholder?: string;
 };
+/** "classic": registry order, substring matching; "spotlight": relevance ranking plus a Top hit. */
+export type LauncherSearchMode = "classic" | "spotlight";
 /** Every visible string and accessible name; pass any subset, the rest fall back to English. */
 export type LauncherLabels = {
     /** Accessible name of the dialog and the results list; no longer drawn as a header pill. */
@@ -86,7 +117,7 @@ export type LauncherLabels = {
     /** Footer hint after the ESC key cap. */
     hintClose: string;
     /** @deprecated No longer rendered: the launcher is already open, so the open chord is not shown. */
-    hintOpenMenu: string;
+    hintOpenMenu?: string;
     /** Footer hint after the mod key cap for a modified click, e.g. "+ click for new tab". */
     hintClickNewTab: string;
     /** Tooltip of the arrow link beside a row. */
@@ -121,6 +152,36 @@ export type LauncherLabels = {
     pinTip: string;
     /** Tooltip on a pinned star. */
     unpinTip: string;
+    /** Heading of the best-match card in spotlight mode. */
+    topHit?: string;
+    /** Prefix of the Top hit line naming the keyword or fact that matched. */
+    matchedOn?: string;
+    /** Name of the answers group. */
+    answers?: string;
+    /** Footer-style hint on an answer card that copies its value. */
+    hintCopy?: string;
+    /** Name of the scope chip group. */
+    scopes?: string;
+    /** Chip prepended to `scopes` when the list has no "all". */
+    scopeAll?: string;
+    /** Polite announcement when the scope changes. */
+    scopeChanged?: (label: string) => string;
+    /** Accessible name of a chip while a query is active, e.g. "People, 3 results". */
+    scopeCount?: (label: string, count: number) => string;
+    /** Shown when a chip is picked with an empty query and its scope has nothing to list yet. */
+    scopeEmpty?: (label: string) => string;
+    /** Name of the quick actions row. */
+    quickActions?: string;
+    /** Option that expands a collapsed result group. */
+    showMore?: (count: number) => string;
+    /** Name of the preview pane. */
+    preview?: string;
+    /** Accessible name and tooltip of a fact's Copy button. */
+    copy?: (label: string) => string;
+    /** Polite announcement after a copy. */
+    copied?: string;
+    /** Announcement when the clipboard is blocked and the value was selected instead. */
+    copySelected?: string;
 };
 /** Passed to `onNavigate`; `newTab` is true for mod+Enter. */
 export type LauncherNavigateOptions = {
@@ -165,7 +226,7 @@ export interface NavLauncherProps {
     openShortcutHint?: string;
     /** Replaces the modifier cap of the mod+Enter hint; defaults to "⌘" on Apple platforms, "Ctrl" elsewhere. */
     modKeyLabel?: string;
-    /** Rendered between the search field and the close button, e.g. a help or customise icon button; use icon-only buttons so the dialog name stays "Menu". */
+    /** Rendered just before the close button, e.g. a help or customise icon button; the dialog name stays `labels.title` whatever is here. */
     headerActions?: ReactNode;
     /** Panel width at `lg`+; always full width below `lg`. Defaults to "1080px". */
     maxWidth?: string;
@@ -178,6 +239,21 @@ export interface NavLauncherProps {
     onAppSelect?: (app: AppOption, event: MouseEvent | KeyboardEvent) => void;
     /** Default "apps-on-compact": the section shows only below `md`, where the 9-dot is usually hidden. */
     appsVisibility?: "always" | "apps-on-compact";
+    /** Default "classic"; "spotlight" adds typo-tolerant ranking, synonyms, usage boosts and a Top hit. */
+    searchMode?: LauncherSearchMode;
+    /** Spotlight only: equivalent terms, both directions, e.g. `{ pf: ["provident fund"] }`. */
+    synonyms?: LauncherSynonyms;
+    /** Filter chips in the header row (their own row below `md`), always shown, with live counts while a query is active; "all" is prepended unless listed. A chip other than All or Screens picked with an empty query lists that scope's items. */
+    scopes?: readonly LauncherScope[];
+    /** Controlled scope id; omit for uncontrolled ("all", reset on close). */
+    activeScope?: string;
+    onScopeChange?: (scope: string) => void;
+    /** Up to 5 pill buttons at the top of the menu while the query is empty and the scope is All; each runs or links like an action. */
+    quickActions?: readonly LauncherSearchItem[];
+    /** Direct answers, matched against the query and shown above every result. */
+    answers?: readonly LauncherSearchItem[];
+    /** Rows per group before "Show N more"; default 5 in spotlight, unlimited in classic. */
+    groupLimit?: number;
     "data-testid"?: string;
 }
 /** Props for the star pin toggle used on launcher rows and reusable on a landing page; shows only while its row is hovered or focused. */

package/dist/Components/NavLauncher/ScopeBar.d.ts

@@ -0,0 +1,14 @@
+export type ScopeChip = {
+    id: string;
+    label: string;
+    count?: number;
+};
+type ScopeBarProps = {
+    scopes: readonly ScopeChip[];
+    value: string;
+    onChange: (scope: string) => void;
+    label: string;
+    countLabel: (label: string, count: number) => string;
+};
+export declare function ScopeBar({ scopes, value, onChange, label, countLabel, }: ScopeBarProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/Components/NavLauncher/ScopeBar.js

@@ -0,0 +1,137 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ScopeBar = ScopeBar;
+const jsx_runtime_1 = require("react/jsx-runtime");
+const react_1 = require("@chakra-ui/react");
+const lucide_react_1 = require("lucide-react");
+const react_2 = require("react");
+const focusRing_styles_1 = require("../../Theme/chakra/focusRing.styles");
+const motion_1 = require("../../Theme/chakra/motion");
+const outlineRung_1 = require("../../Theme/tokens/builders/outlineRung");
+const rowStates_1 = require("../../Theme/tokens/builders/rowStates");
+const motion_2 = require("../../Theme/tokens/primitives/motion");
+const useCustomTheme_1 = require("../../Theme/useCustomTheme");
+const EDGE = 36;
+const MAX_COUNT = 99;
+const STEPS = {
+    ArrowRight: 1,
+    ArrowDown: 1,
+    ArrowLeft: -1,
+    ArrowUp: -1,
+};
+const HIDDEN_SCROLLBAR = {
+    scrollbarWidth: "none",
+    "&::-webkit-scrollbar": { display: "none" },
+};
+const NO_EDGES = { start: false, end: false };
+const fadeMask = ({ start, end }) => start || end
+    ? `linear-gradient(to right, ${start ? "transparent" : "black"}, black ${EDGE}px, black calc(100% - ${EDGE}px), ${end ? "transparent" : "black"})`
+    : "none";
+function PageArrow({ side, onPage, }) {
+    const { colors } = (0, useCustomTheme_1.useCustomTheme)();
+    const Icon = side === "start" ? lucide_react_1.ChevronLeft : lucide_react_1.ChevronRight;
+    return ((0, jsx_runtime_1.jsx)(react_1.Box, { as: "button", type: "button", tabIndex: -1, "aria-hidden": true, "data-testid": `launcher-scopes-${side}`, onMouseDown: (event) => event.preventDefault(), onClick: onPage, position: "absolute", top: "50%", left: side === "start" ? 0 : undefined, right: side === "end" ? 0 : undefined, transform: "translateY(-50%)", display: "inline-flex", alignItems: "center", justifyContent: "center", boxSize: "28px", borderRadius: "full", borderWidth: "1px", borderColor: colors.boxborder[200], bg: colors.surfaceRaised, boxShadow: `0 1px 3px ${colors.boxShadow.default}`, color: colors.textMuted, cursor: "pointer", _hover: { color: colors.text[900] }, sx: { "@media (hover: none)": { display: "none" } }, children: (0, jsx_runtime_1.jsx)(Icon, { size: 16, "aria-hidden": true }) }));
+}
+function ScopeBar({ scopes, value, onChange, label, countLabel, }) {
+    const { colors } = (0, useCustomTheme_1.useCustomTheme)();
+    const stripRef = (0, react_2.useRef)(null);
+    const chipRefs = (0, react_2.useRef)([]);
+    const [edges, setEdges] = (0, react_2.useState)(NO_EDGES);
+    const reduced = (0, motion_1.usePrefersReducedMotion)();
+    const selected = Math.max(0, scopes.findIndex((scope) => scope.id === value));
+    const layoutKey = scopes.map((s) => { var _a; return `${s.id}:${(_a = s.count) !== null && _a !== void 0 ? _a : ""}`; }).join("|");
+    const edge = (0, outlineRung_1.liftToContrast)(colors.primary[500], colors.surfaceRaised, outlineRung_1.AA_NON_TEXT);
+    const measure = (0, react_2.useCallback)(() => {
+        const strip = stripRef.current;
+        if (!strip)
+            return;
+        const start = strip.scrollLeft > 1;
+        const end = strip.scrollLeft + strip.clientWidth < strip.scrollWidth - 1;
+        setEdges((prev) => prev.start === start && prev.end === end ? prev : { start, end });
+    }, []);
+    (0, react_2.useEffect)(() => {
+        const strip = stripRef.current;
+        if (!strip || typeof ResizeObserver === "undefined")
+            return undefined;
+        const observer = new ResizeObserver(measure);
+        observer.observe(strip);
+        if (strip.firstElementChild)
+            observer.observe(strip.firstElementChild);
+        return () => observer.disconnect();
+    }, [measure]);
+    (0, react_2.useEffect)(() => {
+        const strip = stripRef.current;
+        const chip = chipRefs.current[selected];
+        if (strip && chip) {
+            const from = chip.offsetLeft - EDGE;
+            const to = chip.offsetLeft + chip.offsetWidth + EDGE - strip.clientWidth;
+            if (from < strip.scrollLeft)
+                strip.scrollLeft = Math.max(0, from);
+            else if (to > strip.scrollLeft)
+                strip.scrollLeft = to;
+        }
+        measure();
+    }, [selected, layoutKey, measure]);
+    const onKeyDown = (event) => {
+        var _a;
+        if (event.altKey || event.ctrlKey || event.metaKey)
+            return;
+        const step = STEPS[event.key];
+        const last = scopes.length - 1;
+        const next = step !== undefined
+            ? (selected + step + scopes.length) % scopes.length
+            : event.key === "Home"
+                ? 0
+                : event.key === "End"
+                    ? last
+                    : -1;
+        if (next < 0)
+            return;
+        event.preventDefault();
+        (_a = chipRefs.current[next]) === null || _a === void 0 ? void 0 : _a.focus();
+        onChange(scopes[next].id);
+    };
+    const onWheel = (event) => {
+        const strip = event.currentTarget;
+        if (Math.abs(event.deltaY) <= Math.abs(event.deltaX))
+            return;
+        if (strip.scrollWidth > strip.clientWidth)
+            strip.scrollLeft += event.deltaY;
+    };
+    const page = (direction) => {
+        const strip = stripRef.current;
+        if (!strip)
+            return;
+        const step = Math.max(strip.clientWidth - EDGE * 2, EDGE);
+        const max = Math.max(0, strip.scrollWidth - strip.clientWidth);
+        const left = Math.min(max, Math.max(0, strip.scrollLeft + direction * step));
+        if (reduced || typeof strip.scrollTo !== "function")
+            strip.scrollLeft = left;
+        else
+            strip.scrollTo({ left, behavior: "smooth" });
+    };
+    const mask = fadeMask(edges);
+    return ((0, jsx_runtime_1.jsxs)(react_1.Box, { position: "relative", minW: 0, flexShrink: 1, children: [(0, jsx_runtime_1.jsx)(react_1.Box, { ref: stripRef, "data-testid": "launcher-scopes", overflowX: "auto", overflowY: "hidden", onScroll: measure, onWheel: onWheel, sx: { ...HIDDEN_SCROLLBAR, maskImage: mask, WebkitMaskImage: mask }, children: (0, jsx_runtime_1.jsx)(react_1.Flex, { role: "radiogroup", "aria-label": label, onKeyDown: onKeyDown, gap: "6px", w: "max-content", p: "5px", children: scopes.map((scope, index) => {
+                        var _a, _b;
+                        const isSelected = index === selected;
+                        const hasCount = scope.count !== undefined;
+                        return ((0, jsx_runtime_1.jsxs)(react_1.Box, { as: "button", type: "button", ref: (node) => {
+                                chipRefs.current[index] = node;
+                            }, role: "radio", "aria-checked": isSelected, "aria-label": hasCount
+                                ? countLabel(scope.label, (_a = scope.count) !== null && _a !== void 0 ? _a : 0)
+                                : undefined, tabIndex: isSelected ? 0 : -1, onClick: () => onChange(scope.id), display: "inline-flex", alignItems: "center", gap: "6px", flexShrink: 0, h: "32px", pl: "12px", pr: hasCount ? "6px" : "12px", borderRadius: "full", borderWidth: "1px", borderColor: isSelected ? edge : colors.boxborder[200], bg: isSelected ? colors.primary[50] : colors.surfaceRaised, color: isSelected ? colors.accentText : colors.textMuted, fontSize: "xs-plus", fontWeight: isSelected ? 600 : 500, whiteSpace: "nowrap", cursor: "pointer", transition: (0, motion_2.transitionFor)([
+                                "background-color",
+                                "border-color",
+                                "color",
+                            ]), _hover: isSelected
+                                ? undefined
+                                : {
+                                    bg: (0, rowStates_1.listRowBackgrounds)(colors).active,
+                                    color: colors.text[900],
+                                }, sx: { ...(0, focusRing_styles_1.focusVisibleStyles)(colors), ...(0, motion_1.reducedMotionSx)() }, children: [scope.label, hasCount ? ((0, jsx_runtime_1.jsx)(react_1.Box, { as: "span", minW: "20px", h: "20px", px: "6px", borderRadius: "full", bg: isSelected
+                                        ? colors.surfaceRaised
+                                        : colors.backgroundColor.subtle, fontSize: "11.5px", fontWeight: 600, display: "inline-flex", alignItems: "center", justifyContent: "center", sx: { fontVariantNumeric: "tabular-nums" }, children: ((_b = scope.count) !== null && _b !== void 0 ? _b : 0) > MAX_COUNT
+                                        ? `${MAX_COUNT}+`
+                                        : scope.count })) : null] }, scope.id));
+                    }) }) }), edges.start ? (0, jsx_runtime_1.jsx)(PageArrow, { side: "start", onPage: () => page(-1) }) : null, edges.end ? (0, jsx_runtime_1.jsx)(PageArrow, { side: "end", onPage: () => page(1) }) : null] }));
+}

package/dist/Components/NavLauncher/engine/distance.d.ts

@@ -0,0 +1,4 @@
+/** Characters of a string, or the written letters of one (see `letters`). */
+export type Sequence = string | readonly string[];
+/** Damerau-Levenshtein (optimal string alignment) distance; returns `max + 1` once it exceeds `max`. */
+export declare const editDistance: (a: Sequence, b: Sequence, max: number) => number;

package/dist/Components/NavLauncher/engine/distance.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.editDistance = void 0;
+/** Damerau-Levenshtein (optimal string alignment) distance; returns `max + 1` once it exceeds `max`. */
+const editDistance = (a, b, max) => {
+    if (a === b)
+        return 0;
+    const la = a.length;
+    const lb = b.length;
+    if (Math.abs(la - lb) > max)
+        return max + 1;
+    if (la === 0 || lb === 0)
+        return Math.max(la, lb);
+    let before = new Int32Array(lb + 1);
+    let prev = new Int32Array(lb + 1);
+    let cur = new Int32Array(lb + 1);
+    for (let j = 0; j <= lb; j += 1)
+        prev[j] = j;
+    for (let i = 1; i <= la; i += 1) {
+        cur[0] = i;
+        let rowMin = i;
+        for (let j = 1; j <= lb; j += 1) {
+            const cost = a[i - 1] === b[j - 1] ? 0 : 1;
+            let value = Math.min(prev[j] + 1, cur[j - 1] + 1, prev[j - 1] + cost);
+            if (i > 1 && j > 1 && a[i - 1] === b[j - 2] && a[i - 2] === b[j - 1]) {
+                value = Math.min(value, before[j - 2] + 1);
+            }
+            cur[j] = value;
+            if (value < rowMin)
+                rowMin = value;
+        }
+        if (rowMin > max)
+            return max + 1;
+        const spare = before;
+        before = prev;
+        prev = cur;
+        cur = spare;
+    }
+    return Math.min(prev[lb], max + 1);
+};
+exports.editDistance = editDistance;

package/dist/Components/NavLauncher/engine/engine.d.ts

@@ -0,0 +1,84 @@
+import { editDistance } from "./distance";
+import { foldText, splitWords, tokenize } from "./fold";
+/** One searchable string; `weight` scales its matches (label 1, keyword 0.75, context 0.4). */
+export type LauncherSearchField = {
+    name: string;
+    text: string;
+    weight?: number;
+};
+/** Anything searchable: an id plus its weighted fields, in the order results should tie-break. */
+export type LauncherSearchDocument = {
+    id: string;
+    fields: readonly LauncherSearchField[];
+};
+/** How a query token matched a field, strongest first. */
+export type LauncherMatchKind = "exact" | "prefix" | "word" | "word-prefix" | "initialism" | "substring" | "fuzzy" | "subsequence";
+/** The field that gave a query token its best score. */
+export type LauncherTokenMatch = {
+    token: string;
+    field: string;
+    text: string;
+    kind: LauncherMatchKind;
+};
+/** A ranked document: `index` is its input position, `synonym` the expansion used. */
+export type LauncherSearchHit = {
+    id: string;
+    index: number;
+    score: number;
+    matches: LauncherTokenMatch[];
+    synonym?: string;
+};
+/** Term -> equivalent phrases, matched both ways: `{ pf: ["provident fund"] }`. */
+export type LauncherSynonyms = Readonly<Record<string, readonly string[]>>;
+/** Ranking knobs; `boosts` adds points per document id to documents that already match. */
+export type LauncherSearchOptions = {
+    synonyms?: LauncherSynonyms;
+    boosts?: Readonly<Record<string, number>>;
+    /** Typo tolerance; defaults to true. */
+    fuzzy?: boolean;
+    /** Drops hits under this share of the best score; 0 keeps all. */
+    relativeCutoff?: number;
+    limit?: number;
+};
+type IndexedField = {
+    name: string;
+    text: string;
+    weight: number;
+    folded: string;
+    compact: string;
+    words: string[];
+    starts: number[];
+    initials: string;
+    mask: number;
+    letterWords: readonly (readonly string[])[] | null;
+};
+type IndexedDocument = {
+    id: string;
+    index: number;
+    fields: IndexedField[];
+    mask: number;
+};
+/** Pre-folded documents; build once with `createIndex`, query many times. */
+export type LauncherSearchIndex = {
+    readonly size: number;
+    readonly documents: readonly IndexedDocument[];
+};
+export declare const createSearchIndex: (documents: readonly LauncherSearchDocument[]) => LauncherSearchIndex;
+type CompileOptions = Pick<LauncherSearchOptions, "synonyms" | "fuzzy">;
+export declare const searchIndex: (index: LauncherSearchIndex, query: string, options?: LauncherSearchOptions) => LauncherSearchHit[];
+export declare const searchDocuments: (documents: readonly LauncherSearchDocument[], query: string, options?: LauncherSearchOptions) => LauncherSearchHit[];
+/** Boolean test over one row's texts; an empty query matches every row. */
+export type LauncherMatcher = (...texts: ReadonlyArray<string | null | undefined>) => boolean;
+/** Compiles `query` once; every query word must hit some text of the row. */
+export declare const createMatcher: (query: string, options?: CompileOptions) => LauncherMatcher;
+/** One-off form of `createMatcher`: does `query` match the row made of `texts`? */
+export declare const matchesQuery: (query: string, ...texts: ReadonlyArray<string | null | undefined>) => boolean;
+/** Character ranges of `text` a query matched, in original-text offsets, merged and sorted. */
+export declare const highlightRanges: (text: string, query: string, options?: Pick<LauncherSearchOptions, "synonyms" | "fuzzy">) => Array<[number, number]>;
+/** Additive ranking points from usage: pinned flat, frequent and recent decaying by position. */
+export declare const usageBoosts: (usage: {
+    pinnedIds?: readonly string[];
+    frequentIds?: readonly string[];
+    recentIds?: readonly string[];
+}) => Record<string, number>;
+export { editDistance, foldText, splitWords, tokenize };