@rastr/vue 0.0.0-stage → 0.1.0-beta.1

package/dist/RsGrid-CuQ785Nt.d.ts

@@ -0,0 +1,298 @@
+import * as _rastr_grid from '@rastr/grid';
+import { GridColumn, CellRenderer, HeaderRenderer, Messages, GridEditingOptions, GridRowReorderOptions, HeaderBand, GridExportOptions, GridEvents, CopyResult, ExportFormat } from '@rastr/grid';
+import * as vue from 'vue';
+import { Slot, ComponentInternalInstance, PropType, VNode, SlotsType } from 'vue';
+import { Key, StateStorage, DataSource, GridState, GridStore, SavedViewsAdapter, SelectionState, FilterNode, SavedViews } from '@rastr/core';
+
+interface CellSlotProps<TRow> {
+    readonly row: TRow;
+    readonly value: unknown;
+    readonly text: string;
+    readonly key: Key;
+    readonly rowIndex: number;
+    readonly column: GridColumn<TRow>;
+}
+/**
+ * Creates a cell renderer that mounts a Vue slot into each cell. The slot sees the parent's app
+ * context and provides (global components, plugins, inject), and a new row object for the same
+ * key only updates the slot props, so components in cells keep their state.
+ */
+declare function createVueCellRenderer<TRow>(getSlot: () => Slot | undefined, parent: ComponentInternalInstance): CellRenderer<TRow>;
+interface HeaderSlotProps<TRow> {
+    readonly column: GridColumn<TRow>;
+    readonly caption: string;
+}
+/** Header renderer that mounts a Vue slot with { column, caption }. */
+declare function createVueHeaderRenderer<TRow>(getSlot: () => Slot | undefined, parent: ComponentInternalInstance): HeaderRenderer<TRow>;
+
+interface EditSlotProps<TRow> {
+    readonly row: TRow;
+    readonly value: unknown;
+    readonly column: GridColumn<TRow>;
+    setValue(value: unknown): void;
+    commit(): void;
+    cancel(): void;
+}
+
+type StateStorageProp = `local:${string}` | `session:${string}` | {
+    readonly key: string;
+    readonly storage: StateStorage;
+};
+interface RsGridStoreProps<TRow> {
+    readonly dataSource: DataSource<TRow>;
+    readonly keyField: string;
+    readonly selectionMode?: 'none' | 'single' | 'multiple' | undefined;
+    readonly pageSize?: number | undefined;
+    /** Defaults to true. */
+    readonly paging?: boolean | undefined;
+    /** 'virtual' renders the visible rows only and loads blocks while scrolling; needs height. */
+    readonly scrolling?: 'paged' | 'virtual' | undefined;
+    readonly blockSize?: number | undefined;
+    readonly stateStorage?: StateStorageProp | undefined;
+    readonly initialState?: Partial<GridState> | undefined;
+}
+
+/** Props of the #detail slot. */
+interface DetailSlotProps<TRow> {
+    readonly row: TRow;
+    readonly key: Key;
+}
+interface RsGridExpose<TRow> {
+    readonly store: GridStore<TRow>;
+    refresh(): Promise<void>;
+    setFilter(filter: FilterNode | null): void;
+    setColumnFilter(field: string, filter: FilterNode | null): void;
+    clearFilters(): void;
+    getState(): GridState;
+    /** Selected keys; throws when "select all" is active, use getSelection() then. */
+    getSelectedKeys(): readonly Key[];
+    getSelection(): SelectionState;
+    /** Selected rows on the current page. */
+    getSelectedRows(): readonly TRow[];
+    selectAll(): void;
+    clearSelection(): void;
+    focusRow(key: Key): void;
+    /** Opens the detail (#detail slot) of a row on the current page. */
+    expandDetail(key: Key): void;
+    collapseDetail(key: Key): void;
+    isDetailExpanded(key: Key): boolean;
+    /** Scrolls a row of the whole result into view (virtual) or opens its page (paged). */
+    scrollToIndex(index: number): void;
+    /** Exports the current result in a format from the export prop. */
+    export(format: ExportFormat): Promise<void>;
+    /** Saved views controller; null without the savedViews prop or before mount. */
+    readonly savedViews: SavedViews | null;
+    /** Columns the grid shows (from the columns prop or RsColumn children); empty before mount. */
+    readonly columns: readonly GridColumn<TRow>[];
+}
+/**
+ * Row type for runtime props. Vue props cannot be generic, and GridColumn<Row> is not assignable to
+ * GridColumn<unknown> (callbacks are contravariant), so props accept any row type.
+ */
+type AnyRow = any;
+declare const RsGrid: vue.DefineComponent<vue.ExtractPropTypes<{
+    dataSource: PropType<DataSource<AnyRow>>;
+    keyField: StringConstructor;
+    store: PropType<GridStore<AnyRow>>;
+    columns: PropType<GridColumn<AnyRow>[]>;
+    selectionMode: PropType<"none" | "single" | "multiple">;
+    pageSize: NumberConstructor;
+    paging: {
+        readonly type: BooleanConstructor;
+        readonly default: undefined;
+    };
+    scrolling: PropType<"paged" | "virtual">;
+    blockSize: NumberConstructor;
+    stateStorage: PropType<StateStorageProp>;
+    initialState: PropType<Partial<GridState>>;
+    /** v-model:state */
+    state: PropType<GridState>;
+    showCheckboxes: {
+        readonly type: BooleanConstructor;
+        readonly default: undefined;
+    };
+    filterRow: {
+        readonly type: BooleanConstructor;
+        readonly default: undefined;
+    };
+    headerFilter: {
+        readonly type: BooleanConstructor;
+        readonly default: undefined;
+    };
+    columnChooser: {
+        readonly type: BooleanConstructor;
+        readonly default: undefined;
+    };
+    pager: {
+        type: PropType<false | {
+            readonly pageSizes?: readonly number[];
+        }>;
+        default: undefined;
+    };
+    toolbar: {
+        readonly type: BooleanConstructor;
+        readonly default: undefined;
+    };
+    rowClass: PropType<(row: AnyRow) => string | undefined>;
+    height: StringConstructor;
+    locale: StringConstructor;
+    messages: PropType<Partial<Messages>>;
+    theme: PropType<"light" | "dark">;
+    density: PropType<"compact" | "normal" | "comfortable">;
+    /** Editing; only the mode is structural, callbacks are read when called (inline objects are fine). */
+    editing: PropType<GridEditingOptions<AnyRow>>;
+    /** Drag handle column; onReorder, canDrag and sortField are read from the latest props on every move. */
+    rowReorder: PropType<GridRowReorderOptions<AnyRow>>;
+    /** Caption rows above the column headers (bands follow their columns when they move). */
+    headerBands: PropType<readonly HeaderBand[]>;
+    /** Renders only the body cells in view; 'auto' (default) from 50 data columns. */
+    columnVirtualization: {
+        type: PropType<boolean | "auto">;
+        default: undefined;
+    };
+    /** Rows that get a detail toggle (with the #detail slot); defaults to all rows. Read on every render of a row. */
+    detailCanExpand: PropType<(row: AnyRow) => boolean>;
+    /** Storage of the user's saved views; shows the view picker in the toolbar (unless #toolbar-start is used). */
+    savedViews: PropType<SavedViewsAdapter>;
+    /** { fileName, sheetName, title, maxRows, formats: { xlsx: () => import('@rastr/export-xlsx'), … } } */
+    export: PropType<GridExportOptions>;
+}>, () => VNode<vue.RendererNode, vue.RendererElement, {
+    [key: string]: any;
+}>, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {
+    rowClick: (payload: GridEvents<AnyRow>["rowClick"]) => boolean;
+    rowDblClick: (payload: GridEvents<AnyRow>["rowDblClick"]) => boolean;
+    rowActivate: (payload: GridEvents<AnyRow>["rowActivate"]) => boolean;
+    focusedRowChange: (payload: GridEvents<AnyRow>["focusedRowChange"]) => boolean;
+    selectionChange: (keys: readonly Key[], selection: SelectionState) => boolean;
+    stateChange: (state: GridState) => boolean;
+    loadError: (error: unknown) => error is {} | null | undefined;
+    'update:state': (state: GridState) => boolean;
+    copy: (result: CopyResult) => boolean;
+    saveError: (payload: GridEvents<AnyRow>["saveError"]) => boolean;
+    exportError: (error: unknown) => error is {} | null | undefined;
+    reorderError: (payload: GridEvents<AnyRow>["reorderError"]) => boolean;
+    detailToggle: (payload: GridEvents<AnyRow>["detailToggle"]) => boolean;
+}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
+    dataSource: PropType<DataSource<AnyRow>>;
+    keyField: StringConstructor;
+    store: PropType<GridStore<AnyRow>>;
+    columns: PropType<GridColumn<AnyRow>[]>;
+    selectionMode: PropType<"none" | "single" | "multiple">;
+    pageSize: NumberConstructor;
+    paging: {
+        readonly type: BooleanConstructor;
+        readonly default: undefined;
+    };
+    scrolling: PropType<"paged" | "virtual">;
+    blockSize: NumberConstructor;
+    stateStorage: PropType<StateStorageProp>;
+    initialState: PropType<Partial<GridState>>;
+    /** v-model:state */
+    state: PropType<GridState>;
+    showCheckboxes: {
+        readonly type: BooleanConstructor;
+        readonly default: undefined;
+    };
+    filterRow: {
+        readonly type: BooleanConstructor;
+        readonly default: undefined;
+    };
+    headerFilter: {
+        readonly type: BooleanConstructor;
+        readonly default: undefined;
+    };
+    columnChooser: {
+        readonly type: BooleanConstructor;
+        readonly default: undefined;
+    };
+    pager: {
+        type: PropType<false | {
+            readonly pageSizes?: readonly number[];
+        }>;
+        default: undefined;
+    };
+    toolbar: {
+        readonly type: BooleanConstructor;
+        readonly default: undefined;
+    };
+    rowClass: PropType<(row: AnyRow) => string | undefined>;
+    height: StringConstructor;
+    locale: StringConstructor;
+    messages: PropType<Partial<Messages>>;
+    theme: PropType<"light" | "dark">;
+    density: PropType<"compact" | "normal" | "comfortable">;
+    /** Editing; only the mode is structural, callbacks are read when called (inline objects are fine). */
+    editing: PropType<GridEditingOptions<AnyRow>>;
+    /** Drag handle column; onReorder, canDrag and sortField are read from the latest props on every move. */
+    rowReorder: PropType<GridRowReorderOptions<AnyRow>>;
+    /** Caption rows above the column headers (bands follow their columns when they move). */
+    headerBands: PropType<readonly HeaderBand[]>;
+    /** Renders only the body cells in view; 'auto' (default) from 50 data columns. */
+    columnVirtualization: {
+        type: PropType<boolean | "auto">;
+        default: undefined;
+    };
+    /** Rows that get a detail toggle (with the #detail slot); defaults to all rows. Read on every render of a row. */
+    detailCanExpand: PropType<(row: AnyRow) => boolean>;
+    /** Storage of the user's saved views; shows the view picker in the toolbar (unless #toolbar-start is used). */
+    savedViews: PropType<SavedViewsAdapter>;
+    /** { fileName, sheetName, title, maxRows, formats: { xlsx: () => import('@rastr/export-xlsx'), … } } */
+    export: PropType<GridExportOptions>;
+}>> & Readonly<{
+    onCopy?: (result: CopyResult) => any;
+    onLoadError?: (error: unknown) => any;
+    onRowClick?: (payload: {
+        readonly row: any;
+        readonly key: Key;
+        readonly event: MouseEvent;
+    }) => any;
+    onRowDblClick?: (payload: {
+        readonly row: any;
+        readonly key: Key;
+        readonly event: MouseEvent;
+    }) => any;
+    onRowActivate?: (payload: {
+        readonly row: any;
+        readonly key: Key;
+    }) => any;
+    onFocusedRowChange?: (payload: {
+        readonly row: any;
+        readonly key: Key | null;
+    }) => any;
+    onSaveError?: (payload: {
+        readonly message: string;
+        readonly errors: _rastr_grid.SaveErrors;
+    }) => any;
+    onReorderError?: (payload: {
+        readonly error: unknown;
+    }) => any;
+    onDetailToggle?: (payload: {
+        readonly key: Key;
+        readonly row: any;
+        readonly expanded: boolean;
+    }) => any;
+    onSelectionChange?: (keys: readonly Key[], selection: SelectionState) => any;
+    onStateChange?: (state: GridState) => any;
+    "onUpdate:state"?: (state: GridState) => any;
+    onExportError?: (error: unknown) => any;
+}>, {
+    paging: boolean;
+    toolbar: boolean;
+    headerFilter: boolean;
+    showCheckboxes: boolean;
+    filterRow: boolean;
+    columnChooser: boolean;
+    pager: false | {
+        readonly pageSizes?: readonly number[];
+    };
+    columnVirtualization: boolean | "auto";
+}, SlotsType<{
+    [name: `cell-${string}`]: CellSlotProps<any>;
+    [name: `edit-${string}`]: EditSlotProps<any>;
+    'toolbar-start': Record<string, never>;
+    'toolbar-end': Record<string, never>;
+    detail: DetailSlotProps<AnyRow>;
+    default: Record<string, never>;
+}>, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>;
+
+export { type CellSlotProps as C, type DetailSlotProps as D, type EditSlotProps as E, type HeaderSlotProps as H, RsGrid as R, type StateStorageProp as S, type RsGridExpose as a, type RsGridStoreProps as b, createVueCellRenderer as c, createVueHeaderRenderer as d };