@orz/ui 0.0.0-stage → 0.1.0

package/dist/components/filter-menu.d.ts

@@ -0,0 +1,98 @@
+import type { ComponentProps, ReactElement, ReactNode, Ref } from "react";
+import { PopoverContent } from "./popover.tsx";
+export interface FilterMenuRow {
+    /** Unique across every section. */
+    id: string;
+    disabled?: boolean;
+}
+export interface FilterMenuSection<R extends FilterMenuRow> {
+    id: string;
+    label?: ReactNode;
+    rows: readonly R[];
+}
+export interface FilterMenuRowState {
+    highlighted: boolean;
+    selected: boolean;
+    /** What the row's own list is filtered by: the menu's query, or its submenu's. */
+    query: string;
+}
+export interface FilterMenuSubmenuFilter {
+    placeholder?: string;
+    /** Defaults to "Filter" and the submenu's label. */
+    label?: string;
+}
+export interface FilterMenuHandle {
+    /** The highlight back on `selectedId`, firing `onHighlight(null)`; for a control in `header` that commits at once. */
+    resetHighlight(): void;
+}
+export interface FilterMenuProps<R extends FilterMenuRow> {
+    ref?: Ref<FilterMenuHandle>;
+    /** The trigger, rendered through `PopoverTrigger asChild`. */
+    children: ReactElement;
+    open?: boolean;
+    defaultOpen?: boolean;
+    onOpenChange?: (open: boolean) => void;
+    query: string;
+    /** Called with `""` as the menu opens, so every opening starts unfiltered. */
+    onQueryChange: (query: string) => void;
+    /** Already filtered for `query`; sections without rows are skipped. */
+    sections: readonly FilterMenuSection<R>[];
+    renderRow: (row: R, state: FilterMenuRowState) => ReactNode;
+    /** The committed row: checked, and where the highlight rests when nobody moved it. */
+    selectedId?: string;
+    /**
+     * The row the user moved the highlight to, by key, pointer or typing.
+     * `null` means "show the committed state": the highlight rests on
+     * `selectedId` untouched, the pointer left the list, or the menu closed.
+     */
+    onHighlight?: (row: R | null) => void;
+    /** The menu closes after it. */
+    onSelect: (row: R) => void;
+    /**
+     * A row's submenu rows, filtered for `query`: what its filter box holds, or
+     * `""` without one. Undefined or empty for `""` = no submenu. Ids unique
+     * across the whole menu.
+     */
+    getSubmenu?: (row: R, query: string) => readonly R[] | undefined;
+    /** Gives a row's submenu its own filter box; undefined = none. */
+    submenuFilter?: (row: R) => FilterMenuSubmenuFilter | undefined;
+    /** The committed row inside a submenu: checked there. */
+    selectedSubmenuId?: string;
+    /** Accessible name of a row's submenu listbox. */
+    submenuLabel?: (row: R) => string;
+    header?: ReactNode;
+    footer?: ReactNode;
+    placeholder?: string;
+    inputLabel?: string;
+    listLabel?: string;
+    empty?: (query: string) => ReactNode;
+    align?: ComponentProps<typeof PopoverContent>["align"];
+    side?: ComponentProps<typeof PopoverContent>["side"];
+    sideOffset?: number;
+    className?: string;
+}
+/**
+ * Where `query` occurs in `text`, folded as above, as a range of `text`'s own
+ * indices; `null` when it does not. An empty query matches at 0 with nothing
+ * to mark.
+ */
+export declare function matchText(text: string, query: string): {
+    start: number;
+    end: number;
+} | null;
+/**
+ * `text`, with the part `query` matched in a `<mark>`. One element, so a
+ * flex row lays it out as one item rather than three.
+ */
+export declare function MatchedText({ text, query }: {
+    text: string;
+    query: string;
+}): import("react").JSX.Element;
+/**
+ * A popover with a filter box over a list, the combobox pattern: focus stays
+ * in the box, so typing always filters, and the arrow keys walk a highlight
+ * that `aria-activedescendant` follows. The caller filters; this component
+ * owns the surface, the highlight and the keys.
+ */
+export declare function FilterMenu<R extends FilterMenuRow>({ ref, children, open: openProp, defaultOpen, onOpenChange, query, onQueryChange, sections, renderRow, selectedId, onHighlight, onSelect, getSubmenu, submenuFilter, selectedSubmenuId, submenuLabel, header, footer, placeholder, inputLabel, listLabel, empty, align, side, sideOffset, className, }: FilterMenuProps<R>): import("react").JSX.Element;
+//# sourceMappingURL=filter-menu.d.ts.map

package/dist/components/filter-menu.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"filter-menu.d.ts","sourceRoot":"","sources":["../../src/components/filter-menu.tsx"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,cAAc,EAGd,YAAY,EACZ,SAAS,EACT,GAAG,EACJ,MAAM,OAAO,CAAC;AAaf,OAAO,EAGL,cAAc,EAEf,MAAM,eAAe,CAAC;AAEvB,MAAM,WAAW,aAAa;IAC5B,mCAAmC;IACnC,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,WAAW,iBAAiB,CAAC,CAAC,SAAS,aAAa;IACxD,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB,IAAI,EAAE,SAAS,CAAC,EAAE,CAAC;CACpB;AAED,MAAM,WAAW,kBAAkB;IACjC,WAAW,EAAE,OAAO,CAAC;IACrB,QAAQ,EAAE,OAAO,CAAC;IAClB,kFAAkF;IAClF,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,uBAAuB;IACtC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,oDAAoD;IACpD,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,gBAAgB;IAC/B,sHAAsH;IACtH,cAAc,IAAI,IAAI,CAAC;CACxB;AAED,MAAM,WAAW,eAAe,CAAC,CAAC,SAAS,aAAa;IACtD,GAAG,CAAC,EAAE,GAAG,CAAC,gBAAgB,CAAC,CAAC;IAC5B,8DAA8D;IAC9D,QAAQ,EAAE,YAAY,CAAC;IACvB,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,YAAY,CAAC,EAAE,CAAC,IAAI,EAAE,OAAO,KAAK,IAAI,CAAC;IACvC,KAAK,EAAE,MAAM,CAAC;IACd,8EAA8E;IAC9E,aAAa,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;IACvC,uEAAuE;IACvE,QAAQ,EAAE,SAAS,iBAAiB,CAAC,CAAC,CAAC,EAAE,CAAC;IAC1C,SAAS,EAAE,CAAC,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,kBAAkB,KAAK,SAAS,CAAC;IAC5D,sFAAsF;IACtF,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;;OAIG;IACH,WAAW,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,IAAI,KAAK,IAAI,CAAC;IACtC,gCAAgC;IAChC,QAAQ,EAAE,CAAC,GAAG,EAAE,CAAC,KAAK,IAAI,CAAC;IAC3B;;;;OAIG;IACH,UAAU,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,MAAM,KAAK,SAAS,CAAC,EAAE,GAAG,SAAS,CAAC;IACjE,kEAAkE;IAClE,aAAa,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,KAAK,uBAAuB,GAAG,SAAS,CAAC;IAChE,yDAAyD;IACzD,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,kDAAkD;IAClD,YAAY,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,KAAK,MAAM,CAAC;IAClC,MAAM,CAAC,EAAE,SAAS,CAAC;IACnB,MAAM,CAAC,EAAE,SAAS,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,SAAS,CAAC;IACrC,KAAK,CAAC,EAAE,cAAc,CAAC,OAAO,cAAc,CAAC,CAAC,OAAO,CAAC,CAAC;IACvD,IAAI,CAAC,EAAE,cAAc,CAAC,OAAO,cAAc,CAAC,CAAC,MAAM,CAAC,CAAC;IACrD,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAaD;;;;GAIG;AACH,wBAAgB,SAAS,CACvB,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,MAAM,GACZ;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,GAAG,EAAE,MAAM,CAAA;CAAE,GAAG,IAAI,CA4BvC;AAED;;;GAGG;AACH,wBAAgB,WAAW,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,+BAY3E;AAkID;;;;;GAKG;AACH,wBAAgB,UAAU,CAAC,CAAC,SAAS,aAAa,EAAE,EAClD,GAAG,EACH,QAAQ,EACR,IAAI,EAAE,QAAQ,EACd,WAAmB,EACnB,YAAY,EACZ,KAAK,EACL,aAAa,EACb,QAAQ,EACR,SAAS,EACT,UAAU,EACV,WAAW,EACX,QAAQ,EACR,UAAU,EACV,aAAa,EACb,iBAAiB,EACjB,YAAY,EACZ,MAAM,EACN,MAAM,EACN,WAAuB,EACvB,UAAqB,EACrB,SAAS,EACT,KAAuE,EACvE,KAAe,EACf,IAAI,EACJ,UAAU,EACV,SAAS,GACV,EAAE,eAAe,CAAC,CAAC,CAAC,+BAu1BpB"}