@kanunilabs/datagrid 1.9.1 → 1.9.3

package/dist/index.d.cts

@@ -1,4 +1,4 @@
-import { GridRowData, DataGridController, GridDictionary, GridDataType, LookupItem, LookupMatchMode, RowKey, EditingEngineOptions, EditingEngine, RowChange, EditMode, RowNode, GridColumnDef, DataGridCoreConfig, FilterRenderContextBase, FilterNode, GridThemeName, GridPaletteName, GridDensity, DescribeFilterOptions, CardViewOptions, StateStoringConfig, InferColumnsOptions } from '@kanunilabs/datagrid-core';
+import { GridRowData, DataGridController, GridDictionary, GridDataType, LookupItem, LookupMatchMode, RowKey, EditingEngineOptions, EditingEngine, RowChange, EditMode, RowNode, GridColumnDef, DataGridCoreConfig, FilterRenderContextBase, FilterNode, GridThemeName, GridPaletteName, GridDensity, DescribeFilterOptions, CardViewOptions, ToolbarOptions, PortalContainer, StateStoringConfig, InferColumnsOptions, RowStatusSource } from '@kanunilabs/datagrid-core';
 export { CustomFilterOperator, CustomFilterOperatorId, DENSITY_ROW_HEIGHT, DataGridController, FilterNode, GRID_COLOR_SCHEMES, GridColorScheme, GridColumnDef, GridDensity, GridPaletteName, GridRowData, GridTheme, GridThemeName, RowKey, RowNode, SortDescriptor, THEME_ROW_HEIGHT, isPackagedTheme, presetRowHeight } from '@kanunilabs/datagrid-core';
 
 /** What a header menu is opened against — the React shape, verbatim. */
@@ -780,8 +780,25 @@ interface CreateGridConfig<TRow = GridRowData> extends Omit<DataGridCoreConfig<T
      * a vanilla caller has no editor surfacing the `@deprecated` tag.
      */
     showRowCount?: boolean;
-    /** Quick-search + CSV export bar above the grid. */
-    toolbar?: boolean;
+    /**
+     * Quick-search + export bar above the grid. `true` shows all of it; an
+     * object picks the parts and sets the search box up — React's `toolbar`:
+     *
+     *   toolbar: { export: false, search: { maxLength: 100, debounce: 300, validate } }
+     *
+     * Your own buttons: `toolbarItemsBefore` / `toolbarItemsAfter`, e.g. built
+     * with `toolbarButton()`.
+     */
+    toolbar?: boolean | ToolbarOptions;
+    /**
+     * Where the grid draws its popups (header filter, menus, date and lookup
+     * lists, dialogs, tooltips): an element, or a function returning one.
+     * Default `document.body`. Set it when the grid sits in a modal that makes
+     * the rest of the page ignore the pointer; pass the modal's content element
+     * (one without `overflow: hidden`). Popups stay in place even when the modal
+     * is moved with a CSS transform. Every popup carries `data-kanuni-portal`.
+     */
+    portalContainer?: PortalContainer;
     /** "Columns" button in the toolbar opening the visibility chooser. */
     toolbarColumnChooser?: boolean;
     /**
@@ -926,6 +943,12 @@ interface CreateGridConfig<TRow = GridRowData> extends Omit<DataGridCoreConfig<T
     enterpriseEdition?: boolean;
     /** Extra classes for a body cell (pending edit, range, fill preview…). */
     getCellClassName?: (ctx: CellSlotContext<TRow>) => string | undefined;
+    /**
+     * Where `rowStatus` reads the grid's own save status — the Enterprise
+     * wrapper's editing engine. With `editing` on here, the grid's own engine
+     * answers and this is not asked.
+     */
+    getRowStatusSource?: () => RowStatusSource | null;
     onCellPointerDown?: (ctx: CellSlotContext<TRow>, event: MouseEvent) => void;
     onCellPointerEnter?: (ctx: CellSlotContext<TRow>, event: MouseEvent) => void;
     onCellDoubleClick?: (ctx: CellSlotContext<TRow>) => void;
@@ -950,6 +973,26 @@ interface GridApi<TRow = GridRowData> {
 }
 declare function createGrid<TRow = GridRowData>(container: HTMLElement, config: CreateGridConfig<TRow>): GridApi<TRow>;
 
+interface ToolbarButtonSpec {
+    /** The glyph: an element (e.g. an inline SVG) or SVG/HTML markup. */
+    icon: Element | string;
+    /** The button's name: its accessible name and the start of its tooltip. */
+    label: string;
+    /** Keyboard shortcut shown in the tooltip and as `aria-keyshortcuts`. */
+    shortcut?: string;
+    /** Set while the button cannot be used: clicks are ignored and this is the reason given. */
+    disabledReason?: string;
+    /** Show the label beside the icon. Default false (icon only). */
+    showLabel?: boolean;
+    onClick?: () => void;
+    /** `data-testid` on the button. */
+    testId?: string;
+}
+/** A button for the toolbar or status bar. Call `update()` to change it later. */
+declare function toolbarButton(spec: ToolbarButtonSpec): HTMLButtonElement & {
+    update(next: Partial<ToolbarButtonSpec>): void;
+};
+
 /**
  * Width that fits the header and every rendered cell of `columnId`.
  * Returns null when nothing could be measured (no such column on screen, or no
@@ -1004,8 +1047,13 @@ interface ConfirmDialogSpec {
     danger?: boolean;
     /** The enterprise wrapper's theme/dark classes, re-established here. */
     surfaceClass?: string;
+    /**
+     * An element inside the grid, so the dialog follows the grid's
+     * `portalContainer` (core `portalContainerFor`). Default: <body>.
+     */
+    anchor?: Element;
 }
 /** Open the dialog; resolves the user's answer and removes itself. */
 declare function openConfirmDialog(spec: ConfirmDialogSpec): Promise<boolean>;
 
-export { CHECKBOX_COLUMN_WIDTH, type CellEditingExtension, type CellEditingHelpers, type CellEditingLayer, type CellEditingOptions, type CellEditorSpec, type CellLookupEditorSpec, type CellMenuOptions, type CellRenderContext, type CellSlotContext, type ConfirmDialogSpec, type CreateGridConfig, DETAIL_COLUMN_WIDTH, type DateEditorSpec, type EditFormField, type EditFormHandle, type EditFormSpec, type ExportKind, type GridApi, type GridMenuItem, type GridNotesConfig, type HeaderMenuContext, type HeaderMenuDeps, type NoteCellContext, PRINT_MAX_ROWS, type PrintLayoutOptions, ROW_DRAG_MIME, ROW_NUMBER_COLUMN_WIDTH, type RowDragConfig, type RowDragPayload, type RowDropEvent, type RowMenuContext, type RowReorderEvent, type RowTemplateContext, type VanillaColumnDef, type VanillaEditorRenderContext, type VanillaFilterRenderApi, attachCellEditing, buildCellEditor, buildDateEditor, buildEditForm, buildHeaderMenu, createGrid, measureBestFitWidth, openConfirmDialog };
+export { CHECKBOX_COLUMN_WIDTH, type CellEditingExtension, type CellEditingHelpers, type CellEditingLayer, type CellEditingOptions, type CellEditorSpec, type CellLookupEditorSpec, type CellMenuOptions, type CellRenderContext, type CellSlotContext, type ConfirmDialogSpec, type CreateGridConfig, DETAIL_COLUMN_WIDTH, type DateEditorSpec, type EditFormField, type EditFormHandle, type EditFormSpec, type ExportKind, type GridApi, type GridMenuItem, type GridNotesConfig, type HeaderMenuContext, type HeaderMenuDeps, type NoteCellContext, PRINT_MAX_ROWS, type PrintLayoutOptions, ROW_DRAG_MIME, ROW_NUMBER_COLUMN_WIDTH, type RowDragConfig, type RowDragPayload, type RowDropEvent, type RowMenuContext, type RowReorderEvent, type RowTemplateContext, type ToolbarButtonSpec, type VanillaColumnDef, type VanillaEditorRenderContext, type VanillaFilterRenderApi, attachCellEditing, buildCellEditor, buildDateEditor, buildEditForm, buildHeaderMenu, createGrid, measureBestFitWidth, openConfirmDialog, toolbarButton };

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { GridRowData, DataGridController, GridDictionary, GridDataType, LookupItem, LookupMatchMode, RowKey, EditingEngineOptions, EditingEngine, RowChange, EditMode, RowNode, GridColumnDef, DataGridCoreConfig, FilterRenderContextBase, FilterNode, GridThemeName, GridPaletteName, GridDensity, DescribeFilterOptions, CardViewOptions, StateStoringConfig, InferColumnsOptions } from '@kanunilabs/datagrid-core';
+import { GridRowData, DataGridController, GridDictionary, GridDataType, LookupItem, LookupMatchMode, RowKey, EditingEngineOptions, EditingEngine, RowChange, EditMode, RowNode, GridColumnDef, DataGridCoreConfig, FilterRenderContextBase, FilterNode, GridThemeName, GridPaletteName, GridDensity, DescribeFilterOptions, CardViewOptions, ToolbarOptions, PortalContainer, StateStoringConfig, InferColumnsOptions, RowStatusSource } from '@kanunilabs/datagrid-core';
 export { CustomFilterOperator, CustomFilterOperatorId, DENSITY_ROW_HEIGHT, DataGridController, FilterNode, GRID_COLOR_SCHEMES, GridColorScheme, GridColumnDef, GridDensity, GridPaletteName, GridRowData, GridTheme, GridThemeName, RowKey, RowNode, SortDescriptor, THEME_ROW_HEIGHT, isPackagedTheme, presetRowHeight } from '@kanunilabs/datagrid-core';
 
 /** What a header menu is opened against — the React shape, verbatim. */
@@ -780,8 +780,25 @@ interface CreateGridConfig<TRow = GridRowData> extends Omit<DataGridCoreConfig<T
      * a vanilla caller has no editor surfacing the `@deprecated` tag.
      */
     showRowCount?: boolean;
-    /** Quick-search + CSV export bar above the grid. */
-    toolbar?: boolean;
+    /**
+     * Quick-search + export bar above the grid. `true` shows all of it; an
+     * object picks the parts and sets the search box up — React's `toolbar`:
+     *
+     *   toolbar: { export: false, search: { maxLength: 100, debounce: 300, validate } }
+     *
+     * Your own buttons: `toolbarItemsBefore` / `toolbarItemsAfter`, e.g. built
+     * with `toolbarButton()`.
+     */
+    toolbar?: boolean | ToolbarOptions;
+    /**
+     * Where the grid draws its popups (header filter, menus, date and lookup
+     * lists, dialogs, tooltips): an element, or a function returning one.
+     * Default `document.body`. Set it when the grid sits in a modal that makes
+     * the rest of the page ignore the pointer; pass the modal's content element
+     * (one without `overflow: hidden`). Popups stay in place even when the modal
+     * is moved with a CSS transform. Every popup carries `data-kanuni-portal`.
+     */
+    portalContainer?: PortalContainer;
     /** "Columns" button in the toolbar opening the visibility chooser. */
     toolbarColumnChooser?: boolean;
     /**
@@ -926,6 +943,12 @@ interface CreateGridConfig<TRow = GridRowData> extends Omit<DataGridCoreConfig<T
     enterpriseEdition?: boolean;
     /** Extra classes for a body cell (pending edit, range, fill preview…). */
     getCellClassName?: (ctx: CellSlotContext<TRow>) => string | undefined;
+    /**
+     * Where `rowStatus` reads the grid's own save status — the Enterprise
+     * wrapper's editing engine. With `editing` on here, the grid's own engine
+     * answers and this is not asked.
+     */
+    getRowStatusSource?: () => RowStatusSource | null;
     onCellPointerDown?: (ctx: CellSlotContext<TRow>, event: MouseEvent) => void;
     onCellPointerEnter?: (ctx: CellSlotContext<TRow>, event: MouseEvent) => void;
     onCellDoubleClick?: (ctx: CellSlotContext<TRow>) => void;
@@ -950,6 +973,26 @@ interface GridApi<TRow = GridRowData> {
 }
 declare function createGrid<TRow = GridRowData>(container: HTMLElement, config: CreateGridConfig<TRow>): GridApi<TRow>;
 
+interface ToolbarButtonSpec {
+    /** The glyph: an element (e.g. an inline SVG) or SVG/HTML markup. */
+    icon: Element | string;
+    /** The button's name: its accessible name and the start of its tooltip. */
+    label: string;
+    /** Keyboard shortcut shown in the tooltip and as `aria-keyshortcuts`. */
+    shortcut?: string;
+    /** Set while the button cannot be used: clicks are ignored and this is the reason given. */
+    disabledReason?: string;
+    /** Show the label beside the icon. Default false (icon only). */
+    showLabel?: boolean;
+    onClick?: () => void;
+    /** `data-testid` on the button. */
+    testId?: string;
+}
+/** A button for the toolbar or status bar. Call `update()` to change it later. */
+declare function toolbarButton(spec: ToolbarButtonSpec): HTMLButtonElement & {
+    update(next: Partial<ToolbarButtonSpec>): void;
+};
+
 /**
  * Width that fits the header and every rendered cell of `columnId`.
  * Returns null when nothing could be measured (no such column on screen, or no
@@ -1004,8 +1047,13 @@ interface ConfirmDialogSpec {
     danger?: boolean;
     /** The enterprise wrapper's theme/dark classes, re-established here. */
     surfaceClass?: string;
+    /**
+     * An element inside the grid, so the dialog follows the grid's
+     * `portalContainer` (core `portalContainerFor`). Default: <body>.
+     */
+    anchor?: Element;
 }
 /** Open the dialog; resolves the user's answer and removes itself. */
 declare function openConfirmDialog(spec: ConfirmDialogSpec): Promise<boolean>;
 
-export { CHECKBOX_COLUMN_WIDTH, type CellEditingExtension, type CellEditingHelpers, type CellEditingLayer, type CellEditingOptions, type CellEditorSpec, type CellLookupEditorSpec, type CellMenuOptions, type CellRenderContext, type CellSlotContext, type ConfirmDialogSpec, type CreateGridConfig, DETAIL_COLUMN_WIDTH, type DateEditorSpec, type EditFormField, type EditFormHandle, type EditFormSpec, type ExportKind, type GridApi, type GridMenuItem, type GridNotesConfig, type HeaderMenuContext, type HeaderMenuDeps, type NoteCellContext, PRINT_MAX_ROWS, type PrintLayoutOptions, ROW_DRAG_MIME, ROW_NUMBER_COLUMN_WIDTH, type RowDragConfig, type RowDragPayload, type RowDropEvent, type RowMenuContext, type RowReorderEvent, type RowTemplateContext, type VanillaColumnDef, type VanillaEditorRenderContext, type VanillaFilterRenderApi, attachCellEditing, buildCellEditor, buildDateEditor, buildEditForm, buildHeaderMenu, createGrid, measureBestFitWidth, openConfirmDialog };
+export { CHECKBOX_COLUMN_WIDTH, type CellEditingExtension, type CellEditingHelpers, type CellEditingLayer, type CellEditingOptions, type CellEditorSpec, type CellLookupEditorSpec, type CellMenuOptions, type CellRenderContext, type CellSlotContext, type ConfirmDialogSpec, type CreateGridConfig, DETAIL_COLUMN_WIDTH, type DateEditorSpec, type EditFormField, type EditFormHandle, type EditFormSpec, type ExportKind, type GridApi, type GridMenuItem, type GridNotesConfig, type HeaderMenuContext, type HeaderMenuDeps, type NoteCellContext, PRINT_MAX_ROWS, type PrintLayoutOptions, ROW_DRAG_MIME, ROW_NUMBER_COLUMN_WIDTH, type RowDragConfig, type RowDragPayload, type RowDropEvent, type RowMenuContext, type RowReorderEvent, type RowTemplateContext, type ToolbarButtonSpec, type VanillaColumnDef, type VanillaEditorRenderContext, type VanillaFilterRenderApi, attachCellEditing, buildCellEditor, buildDateEditor, buildEditForm, buildHeaderMenu, createGrid, measureBestFitWidth, openConfirmDialog, toolbarButton };