@kanunilabs/datagrid-react 1.8.9 → 1.8.10

package/dist/index.d.cts

@@ -1,6 +1,6 @@
 import * as react from 'react';
-import { ReactNode, FocusEvent, MouseEvent, RefObject } from 'react';
-import { GridRowData, DataGridController, GridDataType, RowKey, LookupItem, GridDictionary, StateStoringConfig, RowNode, DataRowNode, CardField, RowSaveStatus, GridColumnDef, DataGridCoreConfig, FilterRenderContextBase, FilterNode, InferColumnsOptions, GridThemeName, GridPaletteName, DescribeFilterOptions, GridDensity, ToolbarOptions, PortalContainer, CardViewOptions, EditMode, RowChange, RowStatusSource, ColumnRuntime, ColumnLayout, SortDescriptor, ColumnLookup, ColumnModel, ColSpanPlan, SummaryDef, RemoteDistinctList, PortalKind, ToolbarSearchOptions, ToolbarIconName, ColumnState, BusyPhase, VirtualWindow, ChartBoxSpec, ChartBoxModel, ChartSpec, ChartModel, ChartXYSpec, ChartXYModel, CellRange, RangeSelectionEngine, ColumnSelectMode, EditingEngine, EditingApi, NewRowPosition, ValidationRule, CrudHandlers, EditingPermissions, CommitOn, RowEditSession, ColumnNumberFormat, LookupMatchMode } from '@kanunilabs/datagrid-core';
+import { RefObject, ReactNode, FocusEvent, MouseEvent } from 'react';
+import { GridRowData, DataGridController, GridDataType, RowKey, LookupItem, GridDictionary, StateStoringConfig, RowNode, DataRowNode, CardField, RowSaveStatus, GridColumnDef, DataGridCoreConfig, FilterRenderContextBase, FilterNode, InferColumnsOptions, GridThemeName, GridPaletteName, DescribeFilterOptions, GridDensity, ToolbarOptions, PortalContainer, CardViewOptions, EditMode, RowChange, RowStatusSource, ColumnRuntime, ColumnLayout, SortDescriptor, ColumnLookup, ColumnModel, ColSpanPlan, SummaryDef, RemoteDistinctList, PortalKind, ToolbarSearchOptions, ToolbarIconName, ColumnState, BusyPhase, VirtualWindow, ChartBoxSpec, ChartBoxModel, ChartSpec, ChartModel, ChartXYSpec, ChartXYModel, CellRange, RangeSelectionEngine, ColumnSelectMode, EditingEngine, EditingApi, NewRowPosition, ValidationRule, CrudHandlers, EditingPermissions, CommitOn, RowEditSession, ColumnNumberFormat, LookupMatchMode, LookupMatchFold } from '@kanunilabs/datagrid-core';
 export { BusyChangedEvent, BusyPhase, ChangesChangedEvent, ClientRowModel, ColumnLayout, ColumnLookup, ColumnModel, ColumnPin, ColumnRuntime, ColumnState, ColumnStateChangedEvent, CommitOn, ContentReadyEvent, CustomFilterOperator, CustomFilterOperatorId, DEFAULT_ROW_HEIGHT, DENSITY_ROW_HEIGHT, DataGridController, DataGridCoreConfig, DataRowNode, DataSource, EditingApi, FilterChangedEvent, FilterCondition, FilterGroupNode, FilterNode, FilterOperator, FocusedRowChangedEvent, GRID_COLOR_SCHEMES, GRID_PALETTES, GRID_THEMES, GridColorScheme, GridColumnDef, GridDataType, GridDensity, GridEventMap, GridPalette, GridPaletteName, GridRowData, GridStateStore, GridTheme, GridThemeName, GridViewState, GroupRowNode, GroupingConfig, HeaderBandCell, InferColumnsOptions, LoadOptions, LoadResult, LookupItem, NewRowPosition, PortalContainer, RowDropPosition, RowKey, RowNode, SUMMARY_TYPE_LABEL, SaveRejected, SaveRowError, ScrollingConfig, SelectionDescriptor, SortChangedEvent, SortDescriptor, SortDirection, StateStoringConfig, SummaryDef, SummaryType, THEME_ROW_HEIGHT, ToolbarOptions, ToolbarSearchOptions, ViewportChangedEvent, VirtualWindow, VirtualWindowEngine, allowedSummaryTypes, andFilters, attachStateStoring, bandDepth, bandPath, computeColumnLayout, computeHeaderBands, createRestDataSource, describeFilter, downloadBlob, fillText, filterInputFromNode, formatSummaryValue, humanizeField, importCsv, inferColumns, isDataRow, isDataSource, isFilterGroup, isGroupRow, isPackagedTheme, isSaveRejected, lookupLabel, moveRowInArray, parseCsv, parseFilterInput, sniffDelimiter, summaryKey, summaryLabel, summaryTypeLabels, themeClassName } from '@kanunilabs/datagrid-core';
 
 /** Formats an export menu can offer. */
@@ -130,6 +130,13 @@ interface EditKeys {
      * are given.
      */
     typing?: boolean;
+    /**
+     * Space on a focused lookup cell opens its editor (and, with
+     * `lookup.openOnEdit`, its list) instead of doing nothing; the space is not
+     * typed into the box. While an editor is open Space types a space as usual.
+     * Default false (P-11).
+     */
+    space?: boolean;
     /**
      * A double-click (a double-tap on a touch screen) opens the cell's editor.
      * Default true.
@@ -261,6 +268,13 @@ interface PrintLayoutOptions {
         rows: number;
         maxRows: number;
     }) => void;
+    /**
+     * Print the column headers (band rows, header, filter row) at the top of
+     * EVERY page, not only the first (default true; Tekax P-15). A row is never
+     * split across two pages, whichever way this is set. The summary row prints
+     * once, after the last row.
+     */
+    repeatHeader?: boolean;
 }
 /** Default row cap. Report-sized results print; result sets do not. */
 declare const PRINT_MAX_ROWS = 5000;
@@ -280,7 +294,9 @@ interface PrintLayoutState {
  * — an ordinary `setState` would land after that and print the old, clipped
  * view. This is the case the API exists for.
  */
-declare function usePrintLayout<TRow = GridRowData>(controller: DataGridController<TRow>, options: boolean | PrintLayoutOptions | undefined): PrintLayoutState;
+declare function usePrintLayout<TRow = GridRowData>(controller: DataGridController<TRow>, options: boolean | PrintLayoutOptions | undefined, 
+/** The grid's root element, for the repeating header's printable copy. */
+rootRef?: RefObject<HTMLElement | null>): PrintLayoutState;
 
 /** MIME type carrying the payload. Custom so nothing else claims it. */
 declare const ROW_DRAG_MIME = "application/x-kanuni-row";
@@ -2937,8 +2953,30 @@ interface GridLookupEditorProps {
      * shows the code.
      */
     linked?: boolean;
+    /**
+     * How typed text and item text are folded before they are compared
+     * (`lookup.matchFold`, P-13). Default `'case'` — the editor's old behaviour.
+     */
+    matchFold?: LookupMatchFold;
     /** Let text that matches nothing become the value. Default false. */
     allowCustom?: boolean;
+    /**
+     * Open the list as soon as the editor mounts (`lookup.openOnEdit`, P-11).
+     * Only for an editor that takes focus (`autoFocus`) — in a row or form every
+     * field would open its list at once.
+     */
+    openOnEdit?: boolean;
+    /**
+     * The editor was opened by TYPING and `value` is that one character: the
+     * box starts with it as the typed text (list filtered by it, caret after
+     * it). Acts only together with `openOnEdit`.
+     */
+    seeded?: boolean;
+    /**
+     * Refuse typing that matches no item (`lookup.restrictInput`, P-12).
+     * Deleting is always free; ignored with `allowCustom`.
+     */
+    restrictInput?: boolean;
     /**
      * Complete typed text to the one item left / an exact label on leaving.
      * Default true. False: the "pick from the list" rule (K-3, see the top).
@@ -2993,7 +3031,7 @@ interface GridLookupEditorProps {
  */
 declare function matchOptions(options: readonly LookupItem[], query: string, mode: LookupMatchMode): readonly LookupItem[];
 /** The editor's settings that come straight from a column's `lookup`. */
-type LookupEditorSettings = Pick<GridLookupEditorProps, 'matchMode' | 'codeMatchMode' | 'linked' | 'allowCustom' | 'autoCompleteSingle' | 'onNoMatch'>;
+type LookupEditorSettings = Pick<GridLookupEditorProps, 'matchMode' | 'codeMatchMode' | 'linked' | 'allowCustom' | 'autoCompleteSingle' | 'onNoMatch' | 'matchFold' | 'openOnEdit' | 'restrictInput'>;
 /** `lookup` → the editor's props, one reading for the cell, row and form editors. */
 declare function lookupEditorSettings(lookup: ColumnLookup<never> | undefined): LookupEditorSettings;
 /**
@@ -3002,7 +3040,7 @@ declare function lookupEditorSettings(lookup: ColumnLookup<never> | undefined):
  * neither — a plain pick, one cell, as before.
  */
 declare function lookupPickValues(lookup: ColumnLookup<never> | undefined, columnId: string, item: LookupItem): Record<string, unknown> | null;
-declare function GridLookupEditor({ options, value, matchMode, codeMatchMode, linked, allowCustom, autoCompleteSingle, onNoMatch, onPick, invalid, autoFocus, testId, columnId, ariaLabel, onChange, onCommit, commitOnPick, onCancel, onTab, onBlurCommit, }: GridLookupEditorProps): react.JSX.Element;
+declare function GridLookupEditor({ options, value, matchMode, codeMatchMode, matchFold, linked, allowCustom, openOnEdit, seeded, restrictInput, autoCompleteSingle, onNoMatch, onPick, invalid, autoFocus, testId, columnId, ariaLabel, onChange, onCommit, commitOnPick, onCancel, onTab, onBlurCommit, }: GridLookupEditorProps): react.JSX.Element;
 
 interface GridCellEditorProps {
     value: unknown;

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import * as react from 'react';
-import { ReactNode, FocusEvent, MouseEvent, RefObject } from 'react';
-import { GridRowData, DataGridController, GridDataType, RowKey, LookupItem, GridDictionary, StateStoringConfig, RowNode, DataRowNode, CardField, RowSaveStatus, GridColumnDef, DataGridCoreConfig, FilterRenderContextBase, FilterNode, InferColumnsOptions, GridThemeName, GridPaletteName, DescribeFilterOptions, GridDensity, ToolbarOptions, PortalContainer, CardViewOptions, EditMode, RowChange, RowStatusSource, ColumnRuntime, ColumnLayout, SortDescriptor, ColumnLookup, ColumnModel, ColSpanPlan, SummaryDef, RemoteDistinctList, PortalKind, ToolbarSearchOptions, ToolbarIconName, ColumnState, BusyPhase, VirtualWindow, ChartBoxSpec, ChartBoxModel, ChartSpec, ChartModel, ChartXYSpec, ChartXYModel, CellRange, RangeSelectionEngine, ColumnSelectMode, EditingEngine, EditingApi, NewRowPosition, ValidationRule, CrudHandlers, EditingPermissions, CommitOn, RowEditSession, ColumnNumberFormat, LookupMatchMode } from '@kanunilabs/datagrid-core';
+import { RefObject, ReactNode, FocusEvent, MouseEvent } from 'react';
+import { GridRowData, DataGridController, GridDataType, RowKey, LookupItem, GridDictionary, StateStoringConfig, RowNode, DataRowNode, CardField, RowSaveStatus, GridColumnDef, DataGridCoreConfig, FilterRenderContextBase, FilterNode, InferColumnsOptions, GridThemeName, GridPaletteName, DescribeFilterOptions, GridDensity, ToolbarOptions, PortalContainer, CardViewOptions, EditMode, RowChange, RowStatusSource, ColumnRuntime, ColumnLayout, SortDescriptor, ColumnLookup, ColumnModel, ColSpanPlan, SummaryDef, RemoteDistinctList, PortalKind, ToolbarSearchOptions, ToolbarIconName, ColumnState, BusyPhase, VirtualWindow, ChartBoxSpec, ChartBoxModel, ChartSpec, ChartModel, ChartXYSpec, ChartXYModel, CellRange, RangeSelectionEngine, ColumnSelectMode, EditingEngine, EditingApi, NewRowPosition, ValidationRule, CrudHandlers, EditingPermissions, CommitOn, RowEditSession, ColumnNumberFormat, LookupMatchMode, LookupMatchFold } from '@kanunilabs/datagrid-core';
 export { BusyChangedEvent, BusyPhase, ChangesChangedEvent, ClientRowModel, ColumnLayout, ColumnLookup, ColumnModel, ColumnPin, ColumnRuntime, ColumnState, ColumnStateChangedEvent, CommitOn, ContentReadyEvent, CustomFilterOperator, CustomFilterOperatorId, DEFAULT_ROW_HEIGHT, DENSITY_ROW_HEIGHT, DataGridController, DataGridCoreConfig, DataRowNode, DataSource, EditingApi, FilterChangedEvent, FilterCondition, FilterGroupNode, FilterNode, FilterOperator, FocusedRowChangedEvent, GRID_COLOR_SCHEMES, GRID_PALETTES, GRID_THEMES, GridColorScheme, GridColumnDef, GridDataType, GridDensity, GridEventMap, GridPalette, GridPaletteName, GridRowData, GridStateStore, GridTheme, GridThemeName, GridViewState, GroupRowNode, GroupingConfig, HeaderBandCell, InferColumnsOptions, LoadOptions, LoadResult, LookupItem, NewRowPosition, PortalContainer, RowDropPosition, RowKey, RowNode, SUMMARY_TYPE_LABEL, SaveRejected, SaveRowError, ScrollingConfig, SelectionDescriptor, SortChangedEvent, SortDescriptor, SortDirection, StateStoringConfig, SummaryDef, SummaryType, THEME_ROW_HEIGHT, ToolbarOptions, ToolbarSearchOptions, ViewportChangedEvent, VirtualWindow, VirtualWindowEngine, allowedSummaryTypes, andFilters, attachStateStoring, bandDepth, bandPath, computeColumnLayout, computeHeaderBands, createRestDataSource, describeFilter, downloadBlob, fillText, filterInputFromNode, formatSummaryValue, humanizeField, importCsv, inferColumns, isDataRow, isDataSource, isFilterGroup, isGroupRow, isPackagedTheme, isSaveRejected, lookupLabel, moveRowInArray, parseCsv, parseFilterInput, sniffDelimiter, summaryKey, summaryLabel, summaryTypeLabels, themeClassName } from '@kanunilabs/datagrid-core';
 
 /** Formats an export menu can offer. */
@@ -130,6 +130,13 @@ interface EditKeys {
      * are given.
      */
     typing?: boolean;
+    /**
+     * Space on a focused lookup cell opens its editor (and, with
+     * `lookup.openOnEdit`, its list) instead of doing nothing; the space is not
+     * typed into the box. While an editor is open Space types a space as usual.
+     * Default false (P-11).
+     */
+    space?: boolean;
     /**
      * A double-click (a double-tap on a touch screen) opens the cell's editor.
      * Default true.
@@ -261,6 +268,13 @@ interface PrintLayoutOptions {
         rows: number;
         maxRows: number;
     }) => void;
+    /**
+     * Print the column headers (band rows, header, filter row) at the top of
+     * EVERY page, not only the first (default true; Tekax P-15). A row is never
+     * split across two pages, whichever way this is set. The summary row prints
+     * once, after the last row.
+     */
+    repeatHeader?: boolean;
 }
 /** Default row cap. Report-sized results print; result sets do not. */
 declare const PRINT_MAX_ROWS = 5000;
@@ -280,7 +294,9 @@ interface PrintLayoutState {
  * — an ordinary `setState` would land after that and print the old, clipped
  * view. This is the case the API exists for.
  */
-declare function usePrintLayout<TRow = GridRowData>(controller: DataGridController<TRow>, options: boolean | PrintLayoutOptions | undefined): PrintLayoutState;
+declare function usePrintLayout<TRow = GridRowData>(controller: DataGridController<TRow>, options: boolean | PrintLayoutOptions | undefined, 
+/** The grid's root element, for the repeating header's printable copy. */
+rootRef?: RefObject<HTMLElement | null>): PrintLayoutState;
 
 /** MIME type carrying the payload. Custom so nothing else claims it. */
 declare const ROW_DRAG_MIME = "application/x-kanuni-row";
@@ -2937,8 +2953,30 @@ interface GridLookupEditorProps {
      * shows the code.
      */
     linked?: boolean;
+    /**
+     * How typed text and item text are folded before they are compared
+     * (`lookup.matchFold`, P-13). Default `'case'` — the editor's old behaviour.
+     */
+    matchFold?: LookupMatchFold;
     /** Let text that matches nothing become the value. Default false. */
     allowCustom?: boolean;
+    /**
+     * Open the list as soon as the editor mounts (`lookup.openOnEdit`, P-11).
+     * Only for an editor that takes focus (`autoFocus`) — in a row or form every
+     * field would open its list at once.
+     */
+    openOnEdit?: boolean;
+    /**
+     * The editor was opened by TYPING and `value` is that one character: the
+     * box starts with it as the typed text (list filtered by it, caret after
+     * it). Acts only together with `openOnEdit`.
+     */
+    seeded?: boolean;
+    /**
+     * Refuse typing that matches no item (`lookup.restrictInput`, P-12).
+     * Deleting is always free; ignored with `allowCustom`.
+     */
+    restrictInput?: boolean;
     /**
      * Complete typed text to the one item left / an exact label on leaving.
      * Default true. False: the "pick from the list" rule (K-3, see the top).
@@ -2993,7 +3031,7 @@ interface GridLookupEditorProps {
  */
 declare function matchOptions(options: readonly LookupItem[], query: string, mode: LookupMatchMode): readonly LookupItem[];
 /** The editor's settings that come straight from a column's `lookup`. */
-type LookupEditorSettings = Pick<GridLookupEditorProps, 'matchMode' | 'codeMatchMode' | 'linked' | 'allowCustom' | 'autoCompleteSingle' | 'onNoMatch'>;
+type LookupEditorSettings = Pick<GridLookupEditorProps, 'matchMode' | 'codeMatchMode' | 'linked' | 'allowCustom' | 'autoCompleteSingle' | 'onNoMatch' | 'matchFold' | 'openOnEdit' | 'restrictInput'>;
 /** `lookup` → the editor's props, one reading for the cell, row and form editors. */
 declare function lookupEditorSettings(lookup: ColumnLookup<never> | undefined): LookupEditorSettings;
 /**
@@ -3002,7 +3040,7 @@ declare function lookupEditorSettings(lookup: ColumnLookup<never> | undefined):
  * neither — a plain pick, one cell, as before.
  */
 declare function lookupPickValues(lookup: ColumnLookup<never> | undefined, columnId: string, item: LookupItem): Record<string, unknown> | null;
-declare function GridLookupEditor({ options, value, matchMode, codeMatchMode, linked, allowCustom, autoCompleteSingle, onNoMatch, onPick, invalid, autoFocus, testId, columnId, ariaLabel, onChange, onCommit, commitOnPick, onCancel, onTab, onBlurCommit, }: GridLookupEditorProps): react.JSX.Element;
+declare function GridLookupEditor({ options, value, matchMode, codeMatchMode, matchFold, linked, allowCustom, openOnEdit, seeded, restrictInput, autoCompleteSingle, onNoMatch, onPick, invalid, autoFocus, testId, columnId, ariaLabel, onChange, onCommit, commitOnPick, onCancel, onTab, onBlurCommit, }: GridLookupEditorProps): react.JSX.Element;
 
 interface GridCellEditorProps {
     value: unknown;