@johly/bits-ui 2.18.1

package/dist/bits/menu-data/types.d.ts

@@ -0,0 +1,176 @@
+import type { Snippet } from "svelte";
+import type { Expand } from "svelte-toolbelt";
+import type { OnChangeFn, WithChildren, Without } from "../../internal/types.js";
+import type { BitsPrimitiveDivAttributes, BitsPrimitiveInputAttributes } from "../../shared/attributes.js";
+export interface RowRenderContext {
+    search: {
+        query: string;
+        score: number;
+    } | null;
+    breadcrumbs: string[];
+    isDeepSearchResult: boolean;
+    highlighted: boolean;
+    disabled: boolean;
+    group: {
+        id: string;
+        label?: string;
+    } | null;
+}
+export interface GroupRenderContext {
+    search: {
+        query: string;
+        bestScore: number;
+    } | null;
+    matchCount: number;
+    breadcrumbs: string[];
+    isDeepSearchResult: boolean;
+}
+interface BaseNodeDef<TMeta = any> {
+    id: string;
+    hidden?: boolean;
+    meta?: TMeta;
+}
+export interface ItemDef<TMeta = any> extends BaseNodeDef<TMeta> {
+    kind: "item";
+    label: string;
+    keywords?: string[];
+    disabled?: boolean;
+    onSelect?: () => void;
+    closeOnSelect?: boolean;
+    shortcut?: string;
+    value?: string;
+}
+export interface CheckboxItemDef<TMeta = any> extends BaseNodeDef<TMeta> {
+    kind: "checkbox-item";
+    label: string;
+    keywords?: string[];
+    disabled?: boolean;
+    checked?: boolean;
+    onCheckedChange?: (checked: boolean) => void;
+    closeOnSelect?: boolean;
+}
+export interface SubmenuDef<TMeta = any> extends BaseNodeDef<TMeta> {
+    kind: "submenu";
+    title: string;
+    label?: string;
+    keywords?: string[];
+    disabled?: boolean;
+    nodes?: NodeDef<TMeta>[];
+    deepSearch?: boolean;
+}
+export interface SeparatorDef<TMeta = any> {
+    kind: "separator";
+    id?: string;
+    hidden?: boolean;
+    meta?: TMeta;
+}
+export interface GroupDef<TMeta = any> {
+    kind: "group";
+    id: string;
+    label?: string;
+    hidden?: boolean;
+    nodes: NodeDef<TMeta>[];
+    meta?: TMeta;
+}
+export interface RadioGroupDef<TMeta = any> {
+    kind: "radio-group";
+    id: string;
+    label?: string;
+    value?: string;
+    onValueChange?: (value: string) => void;
+    hidden?: boolean;
+    disabled?: boolean;
+    nodes: Array<ItemDef<TMeta> | CheckboxItemDef<TMeta> | SubmenuDef<TMeta>>;
+    meta?: TMeta;
+}
+export type NodeDef<TMeta = any> = ItemDef<TMeta> | CheckboxItemDef<TMeta> | SubmenuDef<TMeta> | SeparatorDef<TMeta> | GroupDef<TMeta> | RadioGroupDef<TMeta>;
+export interface ScoredNode<TMeta = any> {
+    node: ItemDef<TMeta> | CheckboxItemDef<TMeta> | SubmenuDef<TMeta>;
+    score: number;
+    breadcrumbs: string[];
+    breadcrumbIds: string[];
+    group: {
+        id: string;
+        label?: string;
+        groupDef: GroupDef<TMeta>;
+    } | null;
+    radioGroup: {
+        id: string;
+        label?: string;
+        radioGroupDef: RadioGroupDef<TMeta>;
+    } | null;
+}
+export interface DisplayRowNode<TMeta = any> {
+    node: ItemDef<TMeta> | CheckboxItemDef<TMeta> | SubmenuDef<TMeta>;
+    context: RowRenderContext;
+}
+export interface DisplayGroupNode<TMeta = any> {
+    kind: "group";
+    group: GroupDef<TMeta>;
+    context: GroupRenderContext;
+    items: Array<DisplayRowNode<TMeta>>;
+    bestScore: number;
+}
+export interface DisplayRadioGroupNode<TMeta = any> {
+    kind: "radio-group";
+    radioGroup: RadioGroupDef<TMeta>;
+    context: GroupRenderContext;
+    items: Array<DisplayRowNode<TMeta>>;
+    bestScore: number;
+}
+export interface DisplaySeparatorNode<TMeta = any> {
+    kind: "separator";
+    separator: SeparatorDef<TMeta>;
+}
+export type DisplayNode<TMeta = any> = DisplayRowNode<TMeta> | DisplayGroupNode<TMeta> | DisplayRadioGroupNode<TMeta> | DisplaySeparatorNode<TMeta>;
+export declare function isDisplayGroupNode<TMeta>(node: DisplayNode<TMeta>): node is DisplayGroupNode<TMeta>;
+export declare function isDisplayRadioGroupNode<TMeta>(node: DisplayNode<TMeta>): node is DisplayRadioGroupNode<TMeta>;
+export declare function isDisplaySeparatorNode<TMeta>(node: DisplayNode<TMeta>): node is DisplaySeparatorNode<TMeta>;
+export declare function isDisplayRowNode<TMeta>(node: DisplayNode<TMeta>): node is DisplayRowNode<TMeta>;
+export type GroupBehavior = "flatten" | "preserve";
+export type RadioGroupBehavior = "flatten" | "preserve" | "preserve-show-all";
+export interface DeepSearchConfig {
+    enabled?: boolean;
+    minLength?: number;
+    groupSearchBehavior?: GroupBehavior;
+    radioGroupSearchBehavior?: RadioGroupBehavior;
+    sortGroups?: boolean;
+}
+export type DeepSearchProp = boolean | DeepSearchConfig;
+export type DataInputVisibility = "always" | "typing" | "hidden";
+export type DataSurfacePropsWithoutHTML<TMeta = any> = WithChildren<{
+    content: Array<NodeDef<TMeta>>;
+    deepSearch?: DeepSearchProp;
+    search?: string;
+    onSearchChange?: OnChangeFn<string>;
+    defaultSearch?: string;
+    loop?: boolean;
+    autoHighlightFirst?: boolean;
+    clearSearchOnClose?: boolean;
+    ref?: HTMLDivElement | null;
+}>;
+export type DataSurfaceProps<TMeta = any> = DataSurfacePropsWithoutHTML<TMeta> & Without<BitsPrimitiveDivAttributes, DataSurfacePropsWithoutHTML<TMeta>>;
+export type DataInputPropsWithoutHTML = {
+    value?: string;
+    onValueChange?: OnChangeFn<string>;
+    visibility?: DataInputVisibility;
+    hideUntilActive?: boolean;
+    ref?: HTMLInputElement | null;
+};
+export type DataInputProps = DataInputPropsWithoutHTML & Without<BitsPrimitiveInputAttributes, DataInputPropsWithoutHTML>;
+export type DataListChildrenSnippetProps<TMeta = any> = {
+    search: string;
+    nodes: Array<DisplayNode<TMeta>>;
+    count: number;
+    isDeepSearching: boolean;
+};
+export type DataListPropsWithoutHTML<TMeta = any> = Expand<{
+    children?: Snippet<[DataListChildrenSnippetProps<TMeta>]>;
+    ref?: HTMLDivElement | null;
+}>;
+export type DataListProps<TMeta = any> = DataListPropsWithoutHTML<TMeta> & Without<BitsPrimitiveDivAttributes, DataListPropsWithoutHTML<TMeta>>;
+export type DataEmptyPropsWithoutHTML = WithChildren<{
+    ref?: HTMLDivElement | null;
+}>;
+export type DataEmptyProps = DataEmptyPropsWithoutHTML & Without<BitsPrimitiveDivAttributes, DataEmptyPropsWithoutHTML>;
+export {};

package/dist/bits/menu-data/types.js

@@ -0,0 +1,12 @@
+export function isDisplayGroupNode(node) {
+    return "kind" in node && node.kind === "group";
+}
+export function isDisplayRadioGroupNode(node) {
+    return "kind" in node && node.kind === "radio-group";
+}
+export function isDisplaySeparatorNode(node) {
+    return "kind" in node && node.kind === "separator";
+}
+export function isDisplayRowNode(node) {
+    return !("kind" in node);
+}

package/dist/bits/menu-data/utils.d.ts

@@ -0,0 +1,61 @@
+import type { CheckboxItemDef, DisplayNode, DisplayRowNode, GroupBehavior, GroupDef, ItemDef, NodeDef, RadioGroupBehavior, RadioGroupDef, ScoredNode, SeparatorDef, SubmenuDef } from "./types.js";
+export declare function isItemDef<TMeta>(node: NodeDef<TMeta>): node is ItemDef<TMeta>;
+export declare function isCheckboxItemDef<TMeta>(node: NodeDef<TMeta>): node is CheckboxItemDef<TMeta>;
+export declare function isSubmenuDef<TMeta>(node: NodeDef<TMeta>): node is SubmenuDef<TMeta>;
+export declare function isGroupDef<TMeta>(node: NodeDef<TMeta>): node is GroupDef<TMeta>;
+export declare function isRadioGroupDef<TMeta>(node: NodeDef<TMeta>): node is RadioGroupDef<TMeta>;
+export declare function isSeparatorDef<TMeta>(node: NodeDef<TMeta>): node is SeparatorDef<TMeta>;
+interface FlattenOptions<TMeta> {
+    deep?: boolean;
+    breadcrumbs?: string[];
+    breadcrumbIds?: string[];
+    group?: {
+        id: string;
+        label?: string;
+        groupDef: GroupDef<TMeta>;
+    } | null;
+    radioGroup?: {
+        id: string;
+        label?: string;
+        radioGroupDef: RadioGroupDef<TMeta>;
+    } | null;
+}
+interface FlattenedNode<TMeta> {
+    node: ItemDef<TMeta> | CheckboxItemDef<TMeta> | SubmenuDef<TMeta>;
+    breadcrumbs: string[];
+    breadcrumbIds: string[];
+    group: {
+        id: string;
+        label?: string;
+        groupDef: GroupDef<TMeta>;
+    } | null;
+    radioGroup: {
+        id: string;
+        label?: string;
+        radioGroupDef: RadioGroupDef<TMeta>;
+    } | null;
+}
+export declare function flattenNodes<TMeta>(nodes: Array<NodeDef<TMeta>>, options?: FlattenOptions<TMeta>): Array<FlattenedNode<TMeta>>;
+export declare function scoreNodes<TMeta>(flattenedNodes: Array<FlattenedNode<TMeta>>, query: string): Array<ScoredNode<TMeta>>;
+export declare function sortByScore<TMeta>(nodes: Array<ScoredNode<TMeta>>): Array<ScoredNode<TMeta>>;
+export declare function partitionByKind<TMeta>(nodes: Array<ScoredNode<TMeta>>): Array<ScoredNode<TMeta>>;
+export declare function deduplicateNodes<TMeta>(nodes: Array<ScoredNode<TMeta>>): Array<ScoredNode<TMeta>>;
+export declare function buildDisplayRowNodes<TMeta>(scoredNodes: Array<ScoredNode<TMeta>>, query: string, highlightedId: string | null): Array<DisplayRowNode<TMeta>>;
+export declare function getBrowseNodesPreserve<TMeta>(nodes: Array<NodeDef<TMeta>>, highlightedId: string | null): Array<DisplayNode<TMeta>>;
+export interface FilterNodesOptions<TMeta = unknown> {
+    query: string;
+    nodes: Array<NodeDef<TMeta>>;
+    highlightedId: string | null;
+    deepSearch?: boolean;
+    minLength?: number;
+    groupSearchBehavior?: GroupBehavior;
+    radioGroupSearchBehavior?: RadioGroupBehavior;
+    sortGroups?: boolean;
+}
+export declare function filterNodes<TMeta>(options: FilterNodesOptions<TMeta>): {
+    displayNodes: Array<DisplayNode<TMeta>>;
+    isDeepSearching: boolean;
+};
+export declare function getNavigableIds<TMeta>(displayNodes: Array<DisplayNode<TMeta>>): string[];
+export declare function getDisplayNodeKey<TMeta>(node: DisplayNode<TMeta>, fallbackIndex?: number): string;
+export {};