@cocoar/vue-ui 2.2.1 → 2.4.0

package/dist/components/tree/tree-types.d.ts

@@ -0,0 +1,131 @@
+import { InjectionKey, Ref, Slot } from 'vue';
+/**
+ * Public types for `<CoarTree>`.
+ *
+ * The tree is generic over the consumer's node type `T` — identity, children and
+ * label are extracted via prop functions rather than imposed by a fixed shape.
+ * This lets the same tree render file systems, navigation hierarchies, settings
+ * trees, org charts, etc. without forcing a common base type.
+ */
+/** Where a drop lands relative to a target node. */
+export type CoarTreeDropPosition = 'before' | 'inside' | 'after';
+/** Payload for {@link CoarTreeEmits.node-move}. */
+export interface CoarTreeNodeMoveEvent<T> {
+    /** Node being moved. */
+    source: T;
+    /**
+     * Sibling / parent the drop is relative to. `null` means the drop landed on
+     * the empty tree-pane background — typically interpreted as "move to root".
+     */
+    target: T | null;
+    /** Where the drop landed relative to `target`. With `target: null` only `'inside'` is meaningful. */
+    position: CoarTreeDropPosition;
+}
+/** Payload for {@link CoarTreeEmits.files-drop}. */
+export interface CoarTreeFilesDropEvent<T> {
+    /** Files from the OS drag-drop. */
+    files: FileList;
+    /** Folder the drop landed on, or `null` for the tree background (root). */
+    target: T | null;
+}
+/** Context exposed to the default slot for rendering a row body. */
+export interface CoarTreeNodeSlotProps<T> {
+    node: T;
+    /** Nesting depth — 0 for root nodes. */
+    depth: number;
+    isExpanded: boolean;
+    isSelected: boolean;
+    isFocused: boolean;
+    isExpandable: boolean;
+    /**
+     * True while THIS row is in inline-rename mode (only meaningful when
+     * `<CoarTree :renamable>` is on). Useful for hiding hover-actions etc.
+     * while the user is typing the new name.
+     */
+    isRenaming: boolean;
+}
+/** Payload for {@link CoarTreeEmits.rename}. */
+export interface CoarTreeRenameEvent<T> {
+    node: T;
+    newName: string;
+}
+/**
+ * Custom MIME type used to encode an internal node drag in `DataTransfer`.
+ * Lets `dragover` distinguish internal moves from OS-file drags without
+ * relying on `getData()` (which is unavailable during dragover).
+ */
+export declare const COAR_TREE_DRAG_MIME = "application/x-coar-tree-node";
+/**
+ * Internal injection key — `<CoarTree>` provides its row-rendering slot here so
+ * the recursive `<CoarTreeNode>` can render it without passing the slot down
+ * through prop drilling (Vue's `Slot<T>` type doesn't compose cleanly with
+ * `defineSlots`-typed slots in generic components).
+ */
+export declare const COAR_TREE_NODE_SLOT_KEY: InjectionKey<Slot<CoarTreeNodeSlotProps<any>>>;
+/**
+ * Internal injection key — `<CoarTreeNode>` provides its row id so
+ * `<CoarTreeNodeLabel>` (and any future row-scoped helper) can read it
+ * without explicit prop wiring from the consumer.
+ */
+export declare const COAR_TREE_ROW_ID_KEY: InjectionKey<string>;
+/**
+ * The rename machinery `<CoarTree :renamable>` provides to descendants.
+ * `<CoarTreeNodeLabel>` consumes this; consumers normally never see it
+ * directly — they just drop `<CoarTreeNodeLabel :node :label>` into the
+ * default slot.
+ */
+export interface CoarTreeRenameContext {
+    /** Id of the row currently in rename mode, or `null` if none. */
+    readonly renamingId: Readonly<Ref<string | null>>;
+    /** Two-way buffer for the input — `v-model` it on the rename input. */
+    readonly buffer: Ref<string>;
+    /** Commit the current buffer. Tree emits `@rename` then clears state. */
+    commit: () => void;
+    /** Drop the buffer, leave the original name as-is. */
+    cancel: () => void;
+    /** Wired to the rename input's `@focus`. Starts the blur grace timer. */
+    onFocus: () => void;
+    /** Wired to the rename input's `@blur`. Commits after the grace period. */
+    onBlur: () => void;
+}
+export declare const COAR_TREE_RENAME_KEY: InjectionKey<CoarTreeRenameContext>;
+/**
+ * One entry in a builder-driven context menu. `'divider'` is the only string
+ * literal allowed — everything else is an object with `label` + `onClick`.
+ */
+export type CoarTreeMenuEntry = CoarTreeMenuItem | 'divider';
+/**
+ * Options for `<CoarTree :virtualize>` / `builder.virtualize(...)`.
+ *
+ * `useVirtualList` is a *fixed-known-size* virtualizer (no DOM auto-measure),
+ * so the consumer must declare row heights up front. The default of 28px
+ * matches the standard row layout (13px text + 6px vertical padding); change
+ * `itemSize` to match if the slot adds extra padding or multi-line content.
+ */
+export interface CoarTreeVirtualOptions {
+    /**
+     * Row height in pixels. Either a constant, or a function returning the
+     * height for the visible-row at the given index. Default: 28.
+     */
+    itemSize?: number | ((index: number) => number);
+    /** Rows rendered above/below the viewport as a scroll buffer. Default: 5. */
+    overscan?: number;
+}
+/**
+ * Prop shorthand: pass `true` to enable virtualization with defaults, an
+ * object to customize, or omit / `false` to disable.
+ */
+export type CoarTreeVirtualizeProp = boolean | CoarTreeVirtualOptions;
+export interface CoarTreeMenuItem {
+    /** Visible label. Required (use `disabled: true` if the item is a placeholder). */
+    label: string;
+    /** Optional icon name — passed through to `<CoarMenuItem :icon>`. */
+    icon?: string;
+    /** Marks the item as destructive (red text on hover). */
+    danger?: boolean;
+    /** Grays the item out and disables clicks. */
+    disabled?: boolean;
+    /** Invoked on click. The tree closes the menu automatically afterwards. */
+    onClick: () => void;
+}
+//# sourceMappingURL=tree-types.d.ts.map

package/dist/components/tree/tree-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tree-types.d.ts","sourceRoot":"","sources":["../../../src/components/tree/tree-types.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,oDAAoD;AACpD,MAAM,MAAM,oBAAoB,GAAG,QAAQ,GAAG,QAAQ,GAAG,OAAO,CAAC;AAEjE,mDAAmD;AACnD,MAAM,WAAW,qBAAqB,CAAC,CAAC;IACtC,wBAAwB;IACxB,MAAM,EAAE,CAAC,CAAC;IACV;;;OAGG;IACH,MAAM,EAAE,CAAC,GAAG,IAAI,CAAC;IACjB,qGAAqG;IACrG,QAAQ,EAAE,oBAAoB,CAAC;CAChC;AAED,oDAAoD;AACpD,MAAM,WAAW,sBAAsB,CAAC,CAAC;IACvC,mCAAmC;IACnC,KAAK,EAAE,QAAQ,CAAC;IAChB,2EAA2E;IAC3E,MAAM,EAAE,CAAC,GAAG,IAAI,CAAC;CAClB;AAED,oEAAoE;AACpE,MAAM,WAAW,qBAAqB,CAAC,CAAC;IACtC,IAAI,EAAE,CAAC,CAAC;IACR,wCAAwC;IACxC,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,OAAO,CAAC;IACpB,UAAU,EAAE,OAAO,CAAC;IACpB,SAAS,EAAE,OAAO,CAAC;IACnB,YAAY,EAAE,OAAO,CAAC;IACtB;;;;OAIG;IACH,UAAU,EAAE,OAAO,CAAC;CACrB;AAED,gDAAgD;AAChD,MAAM,WAAW,mBAAmB,CAAC,CAAC;IACpC,IAAI,EAAE,CAAC,CAAC;IACR,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;;;GAIG;AACH,eAAO,MAAM,mBAAmB,iCAAiC,CAAC;AAElE,OAAO,KAAK,EAAE,YAAY,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,KAAK,CAAC;AAEnD;;;;;GAKG;AAEH,eAAO,MAAM,uBAAuB,EAAE,YAAY,CAAC,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,CAAC,CACpD,CAAC;AAEhC;;;;GAIG;AACH,eAAO,MAAM,oBAAoB,EAAE,YAAY,CAAC,MAAM,CAA8B,CAAC;AAErF;;;;;GAKG;AACH,MAAM,WAAW,qBAAqB;IACpC,iEAAiE;IACjE,QAAQ,CAAC,UAAU,EAAE,QAAQ,CAAC,GAAG,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC,CAAC;IAClD,uEAAuE;IACvE,QAAQ,CAAC,MAAM,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IAC7B,yEAAyE;IACzE,MAAM,EAAE,MAAM,IAAI,CAAC;IACnB,sDAAsD;IACtD,MAAM,EAAE,MAAM,IAAI,CAAC;IACnB,yEAAyE;IACzE,OAAO,EAAE,MAAM,IAAI,CAAC;IACpB,2EAA2E;IAC3E,MAAM,EAAE,MAAM,IAAI,CAAC;CACpB;AAED,eAAO,MAAM,oBAAoB,EAAE,YAAY,CAAC,qBAAqB,CACzC,CAAC;AAM7B;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG,gBAAgB,GAAG,SAAS,CAAC;AAM7D;;;;;;;GAOG;AACH,MAAM,WAAW,sBAAsB;IACrC;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,CAAC,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,CAAC,CAAC;IAChD,6EAA6E;IAC7E,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,MAAM,sBAAsB,GAAG,OAAO,GAAG,sBAAsB,CAAC;AAEtE,MAAM,WAAW,gBAAgB;IAC/B,mFAAmF;IACnF,KAAK,EAAE,MAAM,CAAC;IACd,qEAAqE;IACrE,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,yDAAyD;IACzD,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,8CAA8C;IAC9C,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,2EAA2E;IAC3E,OAAO,EAAE,MAAM,IAAI,CAAC;CACrB"}

package/dist/components/tree/useTree.d.ts

@@ -0,0 +1,6 @@
+import { TreeBuilder, TreeApi } from './tree-builder';
+export declare function useTree<T>(): {
+    builder: TreeBuilder<T>;
+    api: TreeApi;
+};
+//# sourceMappingURL=useTree.d.ts.map

package/dist/components/tree/useTree.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useTree.d.ts","sourceRoot":"","sources":["../../../src/components/tree/useTree.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8CG;AAEH,OAAO,EAAE,WAAW,EAAE,KAAK,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAE3D,wBAAgB,OAAO,CAAC,CAAC,KAAK;IAC5B,OAAO,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC;IACxB,GAAG,EAAE,OAAO,CAAC;CACd,CAGA"}