@iris-ui-kit/vue 0.2.36 → 0.2.38

package/dist/grid.d.cts

@@ -0,0 +1,184 @@
+import { ShallowRef, ComputedRef } from 'vue';
+import { GridClipboardFeatureOptions, GridCore, GridClipboardModel, GridEditingFeatureOptions, GridEditingKey, GridEditingValidation, GridEditingCommit, GridEditingModel, GridRangeChange, GridRangeModel, GridColumnPin, GridColumnsModel, GridColumnsState, GridFeature, GridExpansionKey, GridFilterValues, GridFilteringModel, GridPaginationChange, GridPaginationModel, GridPaginationState, GridRowKey, GridRowsTransaction, GridRowsModel, SelectionKey, SelectionMode, SelectionModel, SortState, GridSortingModel, GridVirtualRangeChange, GridVirtualModel, VirtualizerState } from '@iris-ui-kit/core/grid';
+export { GridColumnPin, GridCore, GridFeature, GridRowsCommitOptions } from '@iris-ui-kit/core/grid';
+import { TableCopyFormat, TableClipboardRange, CellEditState, CellRangeState, CellRange, ExpansionModel } from '@iris-ui-kit/core';
+
+type UseGridClipboardOptions<Row extends Record<string, unknown>> = GridClipboardFeatureOptions<Row>;
+interface UseGridClipboardResult<Row extends Record<string, unknown>> {
+    core: GridCore<Row>;
+    model: GridClipboardModel;
+    serialize(format?: TableCopyFormat, copyWithFormat?: boolean): string | null;
+    paste(text: string, range?: TableClipboardRange): boolean;
+}
+/** Installs clipboard pure logic while leaving system clipboard I/O in Vue. */
+declare function useGridClipboard<Row extends Record<string, unknown> = Record<string, unknown>>(core: GridCore<Row>, options: UseGridClipboardOptions<Row>): UseGridClipboardResult<Row>;
+
+interface UseGridEditingOptions<Row extends Record<string, unknown>> extends Omit<GridEditingFeatureOptions<Row>, 'onStateChange' | 'onCommit'> {
+    onStateChange?: (state: CellEditState<GridEditingKey>) => void;
+    onValidation?: (validation: GridEditingValidation) => void;
+    onCommit?: (commit: GridEditingCommit<Row>) => void;
+}
+interface UseGridEditingResult<Row extends Record<string, unknown>> {
+    core: GridCore<Row>;
+    model: GridEditingModel;
+    state: Readonly<ShallowRef<CellEditState<GridEditingKey>>>;
+    startCellEdit(rowKey: GridEditingKey, columnKey: string, initialDraft?: unknown): boolean;
+    setCellDraft(value: unknown): void;
+    cancelCellEdit(): void;
+    commitCellEdit(value?: unknown): boolean;
+    isCellEditing(rowKey: GridEditingKey, columnKey: string): boolean;
+}
+/** Installs the framework-independent editing feature and bridges its state into Vue. */
+declare function useGridEditing<Row extends Record<string, unknown>>(core: GridCore<Row>, options: UseGridEditingOptions<Row>): UseGridEditingResult<Row>;
+
+interface UseGridRangeOptions {
+    onChange?: (change: GridRangeChange) => void;
+}
+interface UseGridRangeResult {
+    model: GridRangeModel;
+    state: Readonly<ShallowRef<CellRangeState>>;
+    range: ComputedRef<CellRange | null>;
+}
+/** Installs the range feature and bridges its controller snapshot into Vue. */
+declare function useGridRange<Row extends Record<string, unknown> = Record<string, unknown>>(core: GridCore<Row>, options?: UseGridRangeOptions): UseGridRangeResult;
+
+interface UseGridCoreOptions<Row extends Record<string, unknown>> {
+    readonly features?: readonly GridFeature<Row>[];
+}
+/** Vue lifecycle bridge for one framework-independent Grid Core instance. */
+declare function useGridCore<Row extends Record<string, unknown> = Record<string, unknown>>(options?: UseGridCoreOptions<Row>): GridCore<Row>;
+interface UseGridSelectionOptions<K extends SelectionKey = string> {
+    mode?: SelectionMode;
+    value?: K[];
+    defaultValue?: K[];
+    onChange?: (keys: K[]) => void;
+    getKeys?: () => readonly K[];
+}
+interface UseGridSelectionResult<K extends SelectionKey = string> {
+    model: SelectionModel<K>;
+    selection: ComputedRef<K[]>;
+    controlled: ComputedRef<boolean>;
+}
+declare function useGridSelection<Row extends Record<string, unknown> = Record<string, unknown>, K extends SelectionKey = string>(core: GridCore<Row>, options?: UseGridSelectionOptions<K>): UseGridSelectionResult<K>;
+interface UseGridExpansionOptions<K extends GridExpansionKey = string> {
+    mode?: 'single' | 'multiple';
+    defaultValue?: K[];
+    onChange?: (keys: K[]) => void;
+    getKeys?: () => readonly K[];
+}
+interface UseGridExpansionResult<K extends GridExpansionKey = string> {
+    model: ExpansionModel<K>;
+    expandedKeys: ShallowRef<K[]>;
+}
+declare function useGridExpansion<Row extends Record<string, unknown> = Record<string, unknown>, K extends GridExpansionKey = string>(core: GridCore<Row>, options?: UseGridExpansionOptions<K>): UseGridExpansionResult<K>;
+interface UseGridRowsOptions<Row extends Record<string, unknown>, Meta = unknown> {
+    /** Copy the initial seed before the rows feature stores it (default true). */
+    cloneDefaultRows?: boolean;
+    rowKeyField?: string;
+    getRowKey?: (row: Row, index: number) => GridRowKey | undefined;
+    /** Read nested rows when the source is a tree; omitted keeps flat-row semantics. */
+    getChildren?: (row: Row) => readonly Row[] | undefined;
+    /** Replace nested rows immutably when `getChildren` is not a direct property. */
+    setChildren?: (row: Row, children: Row[]) => Row;
+    onBeforeRowsChange?: (transaction: GridRowsTransaction<Row, Meta>) => void;
+    onRowsChange?: (transaction: GridRowsTransaction<Row, Meta>) => void;
+}
+interface UseGridRowsResult<Row extends Record<string, unknown>, Meta = unknown> {
+    model: GridRowsModel<Row, Meta>;
+    rows: ShallowRef<Row[]>;
+}
+declare function useGridRows<Row extends Record<string, unknown> = Record<string, unknown>, Meta = unknown>(core: GridCore<Row>, initialRows: readonly Row[], options?: UseGridRowsOptions<Row, Meta>): UseGridRowsResult<Row, Meta>;
+interface UseGridColumnsOptions {
+    visibility?: Record<string, boolean>;
+    defaultVisibility?: Record<string, boolean>;
+    onVisibilityChange?: (value: Record<string, boolean>) => void;
+    order?: string[];
+    defaultOrder?: string[];
+    orderControlled?: boolean;
+    onOrderChange?: (value: string[] | undefined) => void;
+    widths?: Record<string, number>;
+    defaultWidths?: Record<string, number>;
+    onWidthsChange?: (value: Record<string, number>) => void;
+    pinned?: Record<string, GridColumnPin>;
+    defaultPinned?: Record<string, GridColumnPin>;
+    onPinnedChange?: (key: string, side: GridColumnPin) => void;
+}
+interface UseGridColumnsResult {
+    model: GridColumnsModel;
+    state: ShallowRef<GridColumnsState>;
+    setVisibility(value: Record<string, boolean>): void;
+    toggleVisibility(key: string): void;
+    setOrder(value: string[] | undefined): void;
+    clearOrder(): void;
+    setWidth(key: string, width: number): void;
+    setWidths(value: Record<string, number>): void;
+    resetWidths(): void;
+    setPinned(key: string, side: GridColumnPin): void;
+}
+declare function useGridColumns<Row extends Record<string, unknown> = Record<string, unknown>>(core: GridCore<Row>, options?: UseGridColumnsOptions): UseGridColumnsResult;
+interface UseGridPaginationOptions {
+    page?: number;
+    defaultPage?: number;
+    pageSize?: number;
+    defaultPageSize?: number;
+    total?: number;
+    defaultTotal?: number;
+    onChange?: (change: GridPaginationChange) => void;
+}
+interface UseGridPaginationResult {
+    model: GridPaginationModel;
+    pagination: ShallowRef<GridPaginationState>;
+    setPage(page: number): void;
+    setPageSize(pageSize: number): void;
+    setPagination(page: number, pageSize: number): void;
+}
+declare function useGridPagination<Row extends Record<string, unknown> = Record<string, unknown>>(core: GridCore<Row>, options?: UseGridPaginationOptions): UseGridPaginationResult;
+interface UseGridSortingOptions {
+    mode?: 'single' | 'multiple';
+    sort?: SortState | null;
+    defaultSort?: SortState | null;
+    onSortChange?: (sort: SortState | null) => void;
+    multiSortState?: SortState[];
+    defaultMultiSort?: SortState[];
+    onMultiSortChange?: (sorts: SortState[]) => void;
+}
+interface UseGridSortingResult {
+    model: GridSortingModel;
+    sort: ComputedRef<SortState | null>;
+    multiSort: ComputedRef<SortState[]>;
+    cycleSort(key: string): void;
+    setSort(sort: SortState | null): void;
+    cycleMultiSort(key: string): void;
+    setMultiSort(sorts: SortState[]): void;
+}
+declare function useGridSorting<Row extends Record<string, unknown> = Record<string, unknown>>(core: GridCore<Row>, options?: UseGridSortingOptions): UseGridSortingResult;
+interface UseGridFilteringOptions {
+    filters?: Record<string, string>;
+    defaultFilters?: Record<string, string>;
+    onFiltersChange?: (filters: Record<string, string>) => void;
+    filterValues?: GridFilterValues;
+    defaultFilterValues?: GridFilterValues;
+    onFilterValuesChange?: (values: GridFilterValues) => void;
+}
+interface UseGridFilteringResult {
+    model: GridFilteringModel;
+    filters: ComputedRef<Record<string, string>>;
+    filterValues: ComputedRef<GridFilterValues>;
+}
+declare function useGridFiltering<Row extends Record<string, unknown> = Record<string, unknown>>(core: GridCore<Row>, options?: UseGridFilteringOptions): UseGridFilteringResult;
+interface UseGridVirtualOptions<Item> {
+    items: readonly Item[];
+    estimateSize: number | ((index: number) => number);
+    viewportSize?: number;
+    scrollOffset?: number;
+    buffer?: number;
+    getItemKey?: (item: Item, index: number) => string | number;
+    onRangeChange?: (change: GridVirtualRangeChange) => void;
+}
+interface UseGridVirtualResult {
+    model: GridVirtualModel;
+    state: ShallowRef<VirtualizerState>;
+}
+declare function useGridVirtual<Row extends Record<string, unknown> = Record<string, unknown>, Item = Row>(core: GridCore<Row>, options: UseGridVirtualOptions<Item>): UseGridVirtualResult;
+
+export { type UseGridClipboardOptions, type UseGridClipboardResult, type UseGridColumnsOptions, type UseGridColumnsResult, type UseGridCoreOptions, type UseGridEditingOptions, type UseGridEditingResult, type UseGridExpansionOptions, type UseGridExpansionResult, type UseGridFilteringOptions, type UseGridFilteringResult, type UseGridPaginationOptions, type UseGridPaginationResult, type UseGridRangeOptions, type UseGridRangeResult, type UseGridRowsOptions, type UseGridRowsResult, type UseGridSelectionOptions, type UseGridSelectionResult, type UseGridSortingOptions, type UseGridSortingResult, type UseGridVirtualOptions, type UseGridVirtualResult, useGridClipboard, useGridColumns, useGridCore, useGridEditing, useGridExpansion, useGridFiltering, useGridPagination, useGridRange, useGridRows, useGridSelection, useGridSorting, useGridVirtual };

package/dist/grid.d.ts

@@ -0,0 +1,184 @@
+import { ShallowRef, ComputedRef } from 'vue';
+import { GridClipboardFeatureOptions, GridCore, GridClipboardModel, GridEditingFeatureOptions, GridEditingKey, GridEditingValidation, GridEditingCommit, GridEditingModel, GridRangeChange, GridRangeModel, GridColumnPin, GridColumnsModel, GridColumnsState, GridFeature, GridExpansionKey, GridFilterValues, GridFilteringModel, GridPaginationChange, GridPaginationModel, GridPaginationState, GridRowKey, GridRowsTransaction, GridRowsModel, SelectionKey, SelectionMode, SelectionModel, SortState, GridSortingModel, GridVirtualRangeChange, GridVirtualModel, VirtualizerState } from '@iris-ui-kit/core/grid';
+export { GridColumnPin, GridCore, GridFeature, GridRowsCommitOptions } from '@iris-ui-kit/core/grid';
+import { TableCopyFormat, TableClipboardRange, CellEditState, CellRangeState, CellRange, ExpansionModel } from '@iris-ui-kit/core';
+
+type UseGridClipboardOptions<Row extends Record<string, unknown>> = GridClipboardFeatureOptions<Row>;
+interface UseGridClipboardResult<Row extends Record<string, unknown>> {
+    core: GridCore<Row>;
+    model: GridClipboardModel;
+    serialize(format?: TableCopyFormat, copyWithFormat?: boolean): string | null;
+    paste(text: string, range?: TableClipboardRange): boolean;
+}
+/** Installs clipboard pure logic while leaving system clipboard I/O in Vue. */
+declare function useGridClipboard<Row extends Record<string, unknown> = Record<string, unknown>>(core: GridCore<Row>, options: UseGridClipboardOptions<Row>): UseGridClipboardResult<Row>;
+
+interface UseGridEditingOptions<Row extends Record<string, unknown>> extends Omit<GridEditingFeatureOptions<Row>, 'onStateChange' | 'onCommit'> {
+    onStateChange?: (state: CellEditState<GridEditingKey>) => void;
+    onValidation?: (validation: GridEditingValidation) => void;
+    onCommit?: (commit: GridEditingCommit<Row>) => void;
+}
+interface UseGridEditingResult<Row extends Record<string, unknown>> {
+    core: GridCore<Row>;
+    model: GridEditingModel;
+    state: Readonly<ShallowRef<CellEditState<GridEditingKey>>>;
+    startCellEdit(rowKey: GridEditingKey, columnKey: string, initialDraft?: unknown): boolean;
+    setCellDraft(value: unknown): void;
+    cancelCellEdit(): void;
+    commitCellEdit(value?: unknown): boolean;
+    isCellEditing(rowKey: GridEditingKey, columnKey: string): boolean;
+}
+/** Installs the framework-independent editing feature and bridges its state into Vue. */
+declare function useGridEditing<Row extends Record<string, unknown>>(core: GridCore<Row>, options: UseGridEditingOptions<Row>): UseGridEditingResult<Row>;
+
+interface UseGridRangeOptions {
+    onChange?: (change: GridRangeChange) => void;
+}
+interface UseGridRangeResult {
+    model: GridRangeModel;
+    state: Readonly<ShallowRef<CellRangeState>>;
+    range: ComputedRef<CellRange | null>;
+}
+/** Installs the range feature and bridges its controller snapshot into Vue. */
+declare function useGridRange<Row extends Record<string, unknown> = Record<string, unknown>>(core: GridCore<Row>, options?: UseGridRangeOptions): UseGridRangeResult;
+
+interface UseGridCoreOptions<Row extends Record<string, unknown>> {
+    readonly features?: readonly GridFeature<Row>[];
+}
+/** Vue lifecycle bridge for one framework-independent Grid Core instance. */
+declare function useGridCore<Row extends Record<string, unknown> = Record<string, unknown>>(options?: UseGridCoreOptions<Row>): GridCore<Row>;
+interface UseGridSelectionOptions<K extends SelectionKey = string> {
+    mode?: SelectionMode;
+    value?: K[];
+    defaultValue?: K[];
+    onChange?: (keys: K[]) => void;
+    getKeys?: () => readonly K[];
+}
+interface UseGridSelectionResult<K extends SelectionKey = string> {
+    model: SelectionModel<K>;
+    selection: ComputedRef<K[]>;
+    controlled: ComputedRef<boolean>;
+}
+declare function useGridSelection<Row extends Record<string, unknown> = Record<string, unknown>, K extends SelectionKey = string>(core: GridCore<Row>, options?: UseGridSelectionOptions<K>): UseGridSelectionResult<K>;
+interface UseGridExpansionOptions<K extends GridExpansionKey = string> {
+    mode?: 'single' | 'multiple';
+    defaultValue?: K[];
+    onChange?: (keys: K[]) => void;
+    getKeys?: () => readonly K[];
+}
+interface UseGridExpansionResult<K extends GridExpansionKey = string> {
+    model: ExpansionModel<K>;
+    expandedKeys: ShallowRef<K[]>;
+}
+declare function useGridExpansion<Row extends Record<string, unknown> = Record<string, unknown>, K extends GridExpansionKey = string>(core: GridCore<Row>, options?: UseGridExpansionOptions<K>): UseGridExpansionResult<K>;
+interface UseGridRowsOptions<Row extends Record<string, unknown>, Meta = unknown> {
+    /** Copy the initial seed before the rows feature stores it (default true). */
+    cloneDefaultRows?: boolean;
+    rowKeyField?: string;
+    getRowKey?: (row: Row, index: number) => GridRowKey | undefined;
+    /** Read nested rows when the source is a tree; omitted keeps flat-row semantics. */
+    getChildren?: (row: Row) => readonly Row[] | undefined;
+    /** Replace nested rows immutably when `getChildren` is not a direct property. */
+    setChildren?: (row: Row, children: Row[]) => Row;
+    onBeforeRowsChange?: (transaction: GridRowsTransaction<Row, Meta>) => void;
+    onRowsChange?: (transaction: GridRowsTransaction<Row, Meta>) => void;
+}
+interface UseGridRowsResult<Row extends Record<string, unknown>, Meta = unknown> {
+    model: GridRowsModel<Row, Meta>;
+    rows: ShallowRef<Row[]>;
+}
+declare function useGridRows<Row extends Record<string, unknown> = Record<string, unknown>, Meta = unknown>(core: GridCore<Row>, initialRows: readonly Row[], options?: UseGridRowsOptions<Row, Meta>): UseGridRowsResult<Row, Meta>;
+interface UseGridColumnsOptions {
+    visibility?: Record<string, boolean>;
+    defaultVisibility?: Record<string, boolean>;
+    onVisibilityChange?: (value: Record<string, boolean>) => void;
+    order?: string[];
+    defaultOrder?: string[];
+    orderControlled?: boolean;
+    onOrderChange?: (value: string[] | undefined) => void;
+    widths?: Record<string, number>;
+    defaultWidths?: Record<string, number>;
+    onWidthsChange?: (value: Record<string, number>) => void;
+    pinned?: Record<string, GridColumnPin>;
+    defaultPinned?: Record<string, GridColumnPin>;
+    onPinnedChange?: (key: string, side: GridColumnPin) => void;
+}
+interface UseGridColumnsResult {
+    model: GridColumnsModel;
+    state: ShallowRef<GridColumnsState>;
+    setVisibility(value: Record<string, boolean>): void;
+    toggleVisibility(key: string): void;
+    setOrder(value: string[] | undefined): void;
+    clearOrder(): void;
+    setWidth(key: string, width: number): void;
+    setWidths(value: Record<string, number>): void;
+    resetWidths(): void;
+    setPinned(key: string, side: GridColumnPin): void;
+}
+declare function useGridColumns<Row extends Record<string, unknown> = Record<string, unknown>>(core: GridCore<Row>, options?: UseGridColumnsOptions): UseGridColumnsResult;
+interface UseGridPaginationOptions {
+    page?: number;
+    defaultPage?: number;
+    pageSize?: number;
+    defaultPageSize?: number;
+    total?: number;
+    defaultTotal?: number;
+    onChange?: (change: GridPaginationChange) => void;
+}
+interface UseGridPaginationResult {
+    model: GridPaginationModel;
+    pagination: ShallowRef<GridPaginationState>;
+    setPage(page: number): void;
+    setPageSize(pageSize: number): void;
+    setPagination(page: number, pageSize: number): void;
+}
+declare function useGridPagination<Row extends Record<string, unknown> = Record<string, unknown>>(core: GridCore<Row>, options?: UseGridPaginationOptions): UseGridPaginationResult;
+interface UseGridSortingOptions {
+    mode?: 'single' | 'multiple';
+    sort?: SortState | null;
+    defaultSort?: SortState | null;
+    onSortChange?: (sort: SortState | null) => void;
+    multiSortState?: SortState[];
+    defaultMultiSort?: SortState[];
+    onMultiSortChange?: (sorts: SortState[]) => void;
+}
+interface UseGridSortingResult {
+    model: GridSortingModel;
+    sort: ComputedRef<SortState | null>;
+    multiSort: ComputedRef<SortState[]>;
+    cycleSort(key: string): void;
+    setSort(sort: SortState | null): void;
+    cycleMultiSort(key: string): void;
+    setMultiSort(sorts: SortState[]): void;
+}
+declare function useGridSorting<Row extends Record<string, unknown> = Record<string, unknown>>(core: GridCore<Row>, options?: UseGridSortingOptions): UseGridSortingResult;
+interface UseGridFilteringOptions {
+    filters?: Record<string, string>;
+    defaultFilters?: Record<string, string>;
+    onFiltersChange?: (filters: Record<string, string>) => void;
+    filterValues?: GridFilterValues;
+    defaultFilterValues?: GridFilterValues;
+    onFilterValuesChange?: (values: GridFilterValues) => void;
+}
+interface UseGridFilteringResult {
+    model: GridFilteringModel;
+    filters: ComputedRef<Record<string, string>>;
+    filterValues: ComputedRef<GridFilterValues>;
+}
+declare function useGridFiltering<Row extends Record<string, unknown> = Record<string, unknown>>(core: GridCore<Row>, options?: UseGridFilteringOptions): UseGridFilteringResult;
+interface UseGridVirtualOptions<Item> {
+    items: readonly Item[];
+    estimateSize: number | ((index: number) => number);
+    viewportSize?: number;
+    scrollOffset?: number;
+    buffer?: number;
+    getItemKey?: (item: Item, index: number) => string | number;
+    onRangeChange?: (change: GridVirtualRangeChange) => void;
+}
+interface UseGridVirtualResult {
+    model: GridVirtualModel;
+    state: ShallowRef<VirtualizerState>;
+}
+declare function useGridVirtual<Row extends Record<string, unknown> = Record<string, unknown>, Item = Row>(core: GridCore<Row>, options: UseGridVirtualOptions<Item>): UseGridVirtualResult;
+
+export { type UseGridClipboardOptions, type UseGridClipboardResult, type UseGridColumnsOptions, type UseGridColumnsResult, type UseGridCoreOptions, type UseGridEditingOptions, type UseGridEditingResult, type UseGridExpansionOptions, type UseGridExpansionResult, type UseGridFilteringOptions, type UseGridFilteringResult, type UseGridPaginationOptions, type UseGridPaginationResult, type UseGridRangeOptions, type UseGridRangeResult, type UseGridRowsOptions, type UseGridRowsResult, type UseGridSelectionOptions, type UseGridSelectionResult, type UseGridSortingOptions, type UseGridSortingResult, type UseGridVirtualOptions, type UseGridVirtualResult, useGridClipboard, useGridColumns, useGridCore, useGridEditing, useGridExpansion, useGridFiltering, useGridPagination, useGridRange, useGridRows, useGridSelection, useGridSorting, useGridVirtual };

package/dist/grid.js

@@ -0,0 +1,4 @@
+export { useGridClipboard, useGridColumns, useGridCore, useGridEditing, useGridExpansion, useGridFiltering, useGridPagination, useGridRange, useGridRows, useGridSelection, useGridSorting, useGridVirtual } from './chunk-5Q3JCKNE.js';
+import './chunk-75GSYEJS.js';
+//# sourceMappingURL=grid.js.map
+//# sourceMappingURL=grid.js.map

package/dist/grid.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"grid.js"}