ionbase-ui 0.76.0 → 0.81.0

package/dist/components/shortcut.js

@@ -0,0 +1,122 @@
+const MODIFIERS = ['mod', 'ctrl', 'alt', 'shift', 'meta'];
+const ALIASES = {
+    cmd: 'meta',
+    command: 'meta',
+    option: 'alt',
+    opt: 'alt',
+    control: 'ctrl',
+    esc: 'escape',
+    return: 'enter',
+    del: 'delete',
+    up: 'arrowup',
+    down: 'arrowdown',
+    left: 'arrowleft',
+    right: 'arrowright',
+};
+/** `mod+Shift+P` → `{ modifiers: {mod, shift}, key: 'p' }`. Throws on a shortcut with no key. */
+export function parseShortcut(shortcut) {
+    const parts = shortcut
+        .toLowerCase()
+        .split('+')
+        .map((p) => p.trim())
+        .map((p) => ALIASES[p] ?? p);
+    // `mod++` is mod and the plus key: an empty part after the split is `+`.
+    const key = shortcut.endsWith('++') ? '+' : parts.pop();
+    const modifiers = new Set();
+    for (const p of parts) {
+        if (!p)
+            continue;
+        if (!MODIFIERS.includes(p)) {
+            throw new Error(`Shortcut "${shortcut}": "${p}" is not a modifier. Use mod, ctrl, alt, shift or meta, joined with "+".`);
+        }
+        modifiers.add(p);
+    }
+    if (!key || MODIFIERS.includes(key)) {
+        throw new Error(`Shortcut "${shortcut}" has no key, only modifiers.`);
+    }
+    return { modifiers, key };
+}
+const MAC_SYMBOL = {
+    mod: '⌘',
+    meta: '⌘',
+    ctrl: '⌃',
+    alt: '⌥',
+    shift: '⇧',
+};
+const MAC_NAME = {
+    mod: 'Command',
+    meta: 'Command',
+    ctrl: 'Control',
+    alt: 'Option',
+    shift: 'Shift',
+};
+const OTHER_SYMBOL = {
+    mod: 'Ctrl',
+    ctrl: 'Ctrl',
+    meta: 'Win',
+    alt: 'Alt',
+    shift: 'Shift',
+};
+const OTHER_NAME = {
+    mod: 'Control',
+    ctrl: 'Control',
+    meta: 'Windows',
+    alt: 'Alt',
+    shift: 'Shift',
+};
+const KEY_SYMBOL = {
+    enter: ['↵', 'Enter'],
+    escape: ['Esc', 'Escape'],
+    backspace: ['⌫', 'Backspace'],
+    delete: ['Del', 'Delete'],
+    tab: ['Tab', 'Tab'],
+    space: ['Space', 'Space'],
+    arrowup: ['↑', 'Up arrow'],
+    arrowdown: ['↓', 'Down arrow'],
+    arrowleft: ['←', 'Left arrow'],
+    arrowright: ['→', 'Right arrow'],
+};
+/** macOS order: Control, Option, Shift, Command. Everywhere else: Ctrl, Alt, Shift. */
+const ORDER = ['ctrl', 'alt', 'shift', 'mod', 'meta'];
+const OTHER_ORDER = [
+    'mod',
+    'ctrl',
+    'meta',
+    'alt',
+    'shift',
+];
+/** The keys to draw, in the platform's conventional order. */
+export function shortcutKeys(shortcut, isMac) {
+    const { modifiers, key } = parseShortcut(shortcut);
+    const order = isMac ? ORDER : OTHER_ORDER;
+    const keys = order
+        .filter((m) => modifiers.has(m))
+        // `mod` and `meta` are the same key on a Mac; draw it once.
+        .filter((m) => !(isMac && m === 'meta' && modifiers.has('mod')))
+        .map((m) => ({
+        symbol: (isMac ? MAC_SYMBOL : OTHER_SYMBOL)[m],
+        name: (isMac ? MAC_NAME : OTHER_NAME)[m],
+    }));
+    const named = KEY_SYMBOL[key];
+    keys.push(named
+        ? { symbol: named[0], name: named[1] }
+        : { symbol: key.toUpperCase(), name: key.toUpperCase() });
+    return keys;
+}
+/** Whether a keydown is this shortcut — modifiers exact, so `mod+k` is not `mod+shift+k`. */
+export function matchesShortcut(event, shortcut, isMac) {
+    const { modifiers, key } = shortcut;
+    const wantMeta = modifiers.has('meta') || (isMac && modifiers.has('mod'));
+    const wantCtrl = modifiers.has('ctrl') || (!isMac && modifiers.has('mod'));
+    if (event.metaKey !== wantMeta)
+        return false;
+    if (event.ctrlKey !== wantCtrl)
+        return false;
+    if (event.altKey !== modifiers.has('alt'))
+        return false;
+    if (event.shiftKey !== modifiers.has('shift'))
+        return false;
+    const pressed = event.key.toLowerCase();
+    return pressed === key || (key === 'space' && pressed === ' ');
+}
+//# sourceMappingURL=shortcut.js.map

package/dist/components/shortcut.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"shortcut.js","sourceRoot":"","sources":["../../src/components/shortcut.ts"],"names":[],"mappings":"AAaA,MAAM,SAAS,GAAwB,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;AAC/E,MAAM,OAAO,GAA2B;IACtC,GAAG,EAAE,MAAM;IACX,OAAO,EAAE,MAAM;IACf,MAAM,EAAE,KAAK;IACb,GAAG,EAAE,KAAK;IACV,OAAO,EAAE,MAAM;IACf,GAAG,EAAE,QAAQ;IACb,MAAM,EAAE,OAAO;IACf,GAAG,EAAE,QAAQ;IACb,EAAE,EAAE,SAAS;IACb,IAAI,EAAE,WAAW;IACjB,IAAI,EAAE,WAAW;IACjB,KAAK,EAAE,YAAY;CACpB,CAAC;AAOF,iGAAiG;AACjG,MAAM,UAAU,aAAa,CAAC,QAAgB;IAC5C,MAAM,KAAK,GAAG,QAAQ;SACnB,WAAW,EAAE;SACb,KAAK,CAAC,GAAG,CAAC;SACV,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;SACpB,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;IAC/B,yEAAyE;IACzE,MAAM,GAAG,GAAG,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC;IACxD,MAAM,SAAS,GAAG,IAAI,GAAG,EAAY,CAAC;IACtC,KAAK,MAAM,CAAC,IAAI,KAAK,EAAE,CAAC;QACtB,IAAI,CAAC,CAAC;YAAE,SAAS;QACjB,IAAI,CAAE,SAA+B,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC;YAClD,MAAM,IAAI,KAAK,CACb,aAAa,QAAQ,OAAO,CAAC,0EAA0E,CACxG,CAAC;QACJ,CAAC;QACD,SAAS,CAAC,GAAG,CAAC,CAAa,CAAC,CAAC;IAC/B,CAAC;IACD,IAAI,CAAC,GAAG,IAAK,SAA+B,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QAC3D,MAAM,IAAI,KAAK,CAAC,aAAa,QAAQ,+BAA+B,CAAC,CAAC;IACxE,CAAC;IACD,OAAO,EAAE,SAAS,EAAE,GAAG,EAAE,CAAC;AAC5B,CAAC;AAED,MAAM,UAAU,GAA2B;IACzC,GAAG,EAAE,GAAG;IACR,IAAI,EAAE,GAAG;IACT,IAAI,EAAE,GAAG;IACT,GAAG,EAAE,GAAG;IACR,KAAK,EAAE,GAAG;CACX,CAAC;AACF,MAAM,QAAQ,GAA2B;IACvC,GAAG,EAAE,SAAS;IACd,IAAI,EAAE,SAAS;IACf,IAAI,EAAE,SAAS;IACf,GAAG,EAAE,QAAQ;IACb,KAAK,EAAE,OAAO;CACf,CAAC;AACF,MAAM,YAAY,GAA2B;IAC3C,GAAG,EAAE,MAAM;IACX,IAAI,EAAE,MAAM;IACZ,IAAI,EAAE,KAAK;IACX,GAAG,EAAE,KAAK;IACV,KAAK,EAAE,OAAO;CACf,CAAC;AACF,MAAM,UAAU,GAA2B;IACzC,GAAG,EAAE,SAAS;IACd,IAAI,EAAE,SAAS;IACf,IAAI,EAAE,SAAS;IACf,GAAG,EAAE,KAAK;IACV,KAAK,EAAE,OAAO;CACf,CAAC;AACF,MAAM,UAAU,GAAmD;IACjE,KAAK,EAAE,CAAC,GAAG,EAAE,OAAO,CAAC;IACrB,MAAM,EAAE,CAAC,KAAK,EAAE,QAAQ,CAAC;IACzB,SAAS,EAAE,CAAC,GAAG,EAAE,WAAW,CAAC;IAC7B,MAAM,EAAE,CAAC,KAAK,EAAE,QAAQ,CAAC;IACzB,GAAG,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC;IACnB,KAAK,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC;IACzB,OAAO,EAAE,CAAC,GAAG,EAAE,UAAU,CAAC;IAC1B,SAAS,EAAE,CAAC,GAAG,EAAE,YAAY,CAAC;IAC9B,SAAS,EAAE,CAAC,GAAG,EAAE,YAAY,CAAC;IAC9B,UAAU,EAAE,CAAC,GAAG,EAAE,aAAa,CAAC;CACjC,CAAC;AAEF,uFAAuF;AACvF,MAAM,KAAK,GAAwB,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;AAC3E,MAAM,WAAW,GAAwB;IACvC,KAAK;IACL,MAAM;IACN,MAAM;IACN,KAAK;IACL,OAAO;CACR,CAAC;AASF,8DAA8D;AAC9D,MAAM,UAAU,YAAY,CAAC,QAAgB,EAAE,KAAc;IAC3D,MAAM,EAAE,SAAS,EAAE,GAAG,EAAE,GAAG,aAAa,CAAC,QAAQ,CAAC,CAAC;IACnD,MAAM,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,WAAW,CAAC;IAC1C,MAAM,IAAI,GAAG,KAAK;SACf,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QAChC,4DAA4D;SAC3D,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,KAAK,MAAM,IAAI,SAAS,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC;SAC/D,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QACX,MAAM,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QAC9C,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;KACzC,CAAC,CAAC,CAAC;IACN,MAAM,KAAK,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC;IAC9B,IAAI,CAAC,IAAI,CACP,KAAK;QACH,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE;QACtC,CAAC,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,WAAW,EAAE,EAAE,IAAI,EAAE,GAAG,CAAC,WAAW,EAAE,EAAE,CAC3D,CAAC;IACF,OAAO,IAAI,CAAC;AACd,CAAC;AAED,6FAA6F;AAC7F,MAAM,UAAU,eAAe,CAC7B,KAGC,EACD,QAAwB,EACxB,KAAc;IAEd,MAAM,EAAE,SAAS,EAAE,GAAG,EAAE,GAAG,QAAQ,CAAC;IACpC,MAAM,QAAQ,GAAG,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,IAAI,SAAS,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC;IAC1E,MAAM,QAAQ,GAAG,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,IAAI,SAAS,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC;IAC3E,IAAI,KAAK,CAAC,OAAO,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAC;IAC7C,IAAI,KAAK,CAAC,OAAO,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAC;IAC7C,IAAI,KAAK,CAAC,MAAM,KAAK,SAAS,CAAC,GAAG,CAAC,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC;IACxD,IAAI,KAAK,CAAC,QAAQ,KAAK,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC;QAAE,OAAO,KAAK,CAAC;IAC5D,MAAM,OAAO,GAAG,KAAK,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC;IACxC,OAAO,OAAO,KAAK,GAAG,IAAI,CAAC,GAAG,KAAK,OAAO,IAAI,OAAO,KAAK,GAAG,CAAC,CAAC;AACjE,CAAC"}

package/dist/components/use-table-sort.d.ts

@@ -0,0 +1,38 @@
+import type { TableSortDirection } from './Table.js';
+/** Which column the rows are sorted by, and which way. */
+export interface TableSort<Column extends string = string> {
+    column: Column;
+    direction: Exclude<TableSortDirection, 'none'>;
+}
+export interface TableSortProps {
+    sortDirection: TableSortDirection;
+    onSort: () => void;
+}
+export interface UseTableSortResult<Column extends string> {
+    /** The current sort; `null` until a column is chosen when no `initial` is given. */
+    sort: TableSort<Column> | null;
+    /** Set the sort directly — from a URL, a saved view, a reset. */
+    setSort: (sort: TableSort<Column> | null) => void;
+    /**
+     * Spread onto a header `TableCell`. `firstDirection` is where a column
+     * starts when it is chosen: `descending` for dates and amounts, where the
+     * newest or largest is what people look for first.
+     */
+    sortProps: (column: Column, options?: {
+        firstDirection?: TableSort['direction'];
+    }) => TableSortProps;
+}
+/**
+ * The state of a sortable table: which column, which way, and the props that
+ * wire each header to it.
+ *
+ * Choosing a new column sorts it in its `firstDirection` (ascending unless
+ * given); choosing the current column again reverses it. There is no third
+ * "unsorted" click: a table that silently returns to server order on the
+ * third press loses the reader's place for no reason they can see.
+ *
+ * It does not sort rows. The rows may be one page of thousands on a server,
+ * so ordering them is the caller's — with `sort` as the input.
+ */
+export declare function useTableSort<Column extends string>(initial?: TableSort<Column> | null): UseTableSortResult<Column>;
+//# sourceMappingURL=use-table-sort.d.ts.map

package/dist/components/use-table-sort.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-table-sort.d.ts","sourceRoot":"","sources":["../../src/components/use-table-sort.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC;AAErD,0DAA0D;AAC1D,MAAM,WAAW,SAAS,CAAC,MAAM,SAAS,MAAM,GAAG,MAAM;IACvD,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,OAAO,CAAC,kBAAkB,EAAE,MAAM,CAAC,CAAC;CAChD;AAED,MAAM,WAAW,cAAc;IAC7B,aAAa,EAAE,kBAAkB,CAAC;IAClC,MAAM,EAAE,MAAM,IAAI,CAAC;CACpB;AAED,MAAM,WAAW,kBAAkB,CAAC,MAAM,SAAS,MAAM;IACvD,oFAAoF;IACpF,IAAI,EAAE,SAAS,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAC/B,iEAAiE;IACjE,OAAO,EAAE,CAAC,IAAI,EAAE,SAAS,CAAC,MAAM,CAAC,GAAG,IAAI,KAAK,IAAI,CAAC;IAClD;;;;OAIG;IACH,SAAS,EAAE,CACT,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE;QAAE,cAAc,CAAC,EAAE,SAAS,CAAC,WAAW,CAAC,CAAA;KAAE,KAClD,cAAc,CAAC;CACrB;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,YAAY,CAAC,MAAM,SAAS,MAAM,EAChD,OAAO,GAAE,SAAS,CAAC,MAAM,CAAC,GAAG,IAAW,GACvC,kBAAkB,CAAC,MAAM,CAAC,CA6B5B"}

package/dist/components/use-table-sort.js

@@ -0,0 +1,33 @@
+'use client';
+import { useCallback, useState } from 'react';
+/**
+ * The state of a sortable table: which column, which way, and the props that
+ * wire each header to it.
+ *
+ * Choosing a new column sorts it in its `firstDirection` (ascending unless
+ * given); choosing the current column again reverses it. There is no third
+ * "unsorted" click: a table that silently returns to server order on the
+ * third press loses the reader's place for no reason they can see.
+ *
+ * It does not sort rows. The rows may be one page of thousands on a server,
+ * so ordering them is the caller's — with `sort` as the input.
+ */
+export function useTableSort(initial = null) {
+    const [sort, setSort] = useState(initial);
+    const sortProps = useCallback((column, options) => ({
+        sortDirection: sort?.column === column ? sort.direction : 'none',
+        onSort: () => setSort((current) => current?.column === column
+            ? {
+                column,
+                direction: current.direction === 'ascending'
+                    ? 'descending'
+                    : 'ascending',
+            }
+            : {
+                column,
+                direction: options?.firstDirection ?? 'ascending',
+            }),
+    }), [sort]);
+    return { sort, setSort, sortProps };
+}
+//# sourceMappingURL=use-table-sort.js.map

package/dist/components/use-table-sort.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-table-sort.js","sourceRoot":"","sources":["../../src/components/use-table-sort.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC;AAEb,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AA8B9C;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,YAAY,CAC1B,UAAoC,IAAI;IAExC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,GAAG,QAAQ,CAA2B,OAAO,CAAC,CAAC;IAEpE,MAAM,SAAS,GAAG,WAAW,CAC3B,CACE,MAAc,EACd,OAAqD,EACrC,EAAE,CAAC,CAAC;QACpB,aAAa,EAAE,IAAI,EAAE,MAAM,KAAK,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM;QAChE,MAAM,EAAE,GAAG,EAAE,CACX,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAClB,OAAO,EAAE,MAAM,KAAK,MAAM;YACxB,CAAC,CAAC;gBACE,MAAM;gBACN,SAAS,EACP,OAAO,CAAC,SAAS,KAAK,WAAW;oBAC/B,CAAC,CAAC,YAAY;oBACd,CAAC,CAAC,WAAW;aAClB;YACH,CAAC,CAAC;gBACE,MAAM;gBACN,SAAS,EAAE,OAAO,EAAE,cAAc,IAAI,WAAW;aAClD,CACN;KACJ,CAAC,EACF,CAAC,IAAI,CAAC,CACP,CAAC;IAEF,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC;AACtC,CAAC"}