@kanunilabs/pivotgrid-react 1.5.0 → 1.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (44) hide show
  1. package/README.md +1 -1
  2. package/dist/index.cjs +2 -2
  3. package/dist/index.d.cts +41 -5
  4. package/dist/index.d.ts +41 -5
  5. package/dist/index.js +2 -2
  6. package/dist/styles.css +249 -15
  7. package/dist/themes/all.css +1064 -0
  8. package/dist/themes/amber.css +28 -0
  9. package/dist/themes/aubergine.css +32 -0
  10. package/dist/themes/azure.css +28 -0
  11. package/dist/themes/burgundy.css +32 -0
  12. package/dist/themes/charcoal.css +32 -0
  13. package/dist/themes/contrast-dark.css +32 -0
  14. package/dist/themes/contrast-light.css +28 -0
  15. package/dist/themes/coral.css +28 -0
  16. package/dist/themes/corporate.css +28 -0
  17. package/dist/themes/deep-sea.css +32 -0
  18. package/dist/themes/editorial.css +28 -0
  19. package/dist/themes/ember.css +32 -0
  20. package/dist/themes/emerald.css +28 -0
  21. package/dist/themes/forest.css +32 -0
  22. package/dist/themes/glacier.css +28 -0
  23. package/dist/themes/graphite.css +32 -0
  24. package/dist/themes/indigo-night.css +32 -0
  25. package/dist/themes/indigo.css +28 -0
  26. package/dist/themes/ivory.css +28 -0
  27. package/dist/themes/lagoon.css +28 -0
  28. package/dist/themes/linen.css +28 -0
  29. package/dist/themes/midnight.css +32 -0
  30. package/dist/themes/mist.css +28 -0
  31. package/dist/themes/monochrome.css +28 -0
  32. package/dist/themes/onyx.css +32 -0
  33. package/dist/themes/orchid.css +28 -0
  34. package/dist/themes/porcelain.css +28 -0
  35. package/dist/themes/rose.css +28 -0
  36. package/dist/themes/sandstone.css +28 -0
  37. package/dist/themes/slate-night.css +32 -0
  38. package/dist/themes/slate.css +28 -0
  39. package/dist/themes/steel.css +32 -0
  40. package/dist/themes/stone.css +28 -0
  41. package/dist/themes/taupe.css +28 -0
  42. package/dist/themes/teal.css +28 -0
  43. package/dist/themes/terminal.css +32 -0
  44. package/package.json +7 -4
package/dist/index.d.cts CHANGED
@@ -1,8 +1,8 @@
1
1
  import * as React$1 from 'react';
2
2
  import React__default, { Component, ErrorInfo } from 'react';
3
3
  import * as _kanunilabs_pivotgrid_core from '@kanunilabs/pivotgrid-core';
4
- import { PivotField as PivotField$1, PivotCellTemplate as PivotCellTemplate$1, CellClickEvent as CellClickEvent$1, CellPreparedEvent as CellPreparedEvent$1, PivotGridRef as PivotGridRef$1, PivotRowTransaction, PivotTransactionResult, PivotController, PivotConditionRule as PivotConditionRule$1, PivotCell, PivotEngineResult, PivotControllerOptions, PivotLayoutState, PivotTheme, PivotStateStoringConfig, PivotToolbarConfig, PivotEngineRegistry, PivotLocale, PivotDictionary, PivotColumnWidthDefaults, FieldMoveEvent, ExportingEvent, ExportFormat, PivotReport, PivotArea, PivotNode, PivotControllerState } from '@kanunilabs/pivotgrid-core';
5
- export { CustomSummaryOptions, DropIntent, ExportingEvent, FieldMoveEvent, FilterCondition, FilterGroup, FilterOperator, PivotArea, PivotCell, PivotCellTextAccessor, PivotCellValueAccessor, PivotColumnWidthDefaults, PivotControllerCallbacks, PivotControllerOptions, PivotControllerState, PivotDataSource, PivotDictionary, PivotDragIntentState, PivotGroupInterval, PivotImportStatus, PivotLabelFilter, PivotLayoutProfile, PivotLayoutState, PivotLocale, PivotNode, PivotPrefilter, PivotRowKey, PivotRowKeyResolver, PivotRowTransaction, PivotSelectionMode, PivotSelectionRange, PivotSelectionState, PivotSelectionStats, PivotStateStoringConfig, PivotSummaryDisplayMode, PivotSummaryType, PivotTheme, PivotToolbarConfig, PivotTransactionResult, PivotValueFilter, defaultPivotLayout } from '@kanunilabs/pivotgrid-core';
4
+ import { PivotField as PivotField$1, PivotCellTemplate as PivotCellTemplate$1, CellClickEvent as CellClickEvent$1, CellPreparedEvent as CellPreparedEvent$1, PivotGridRef as PivotGridRef$1, PivotRowTransaction, PivotTransactionResult, PivotController, PivotConditionRule as PivotConditionRule$1, PivotCell, PivotEngineResult, PivotControllerOptions, PivotLayoutState, PivotTheme, PivotStateStoringConfig, PivotToolbarConfig, PivotEngineRegistry, PivotLocale, PivotDictionary, PivotDensity, PivotColumnWidthDefaults, FieldMoveEvent, ExportingEvent, ExportFormat, PivotReport, PivotArea, PivotNode, PivotControllerState } from '@kanunilabs/pivotgrid-core';
5
+ export { CustomSummaryOptions, DropIntent, ExportingEvent, FieldMoveEvent, FilterCondition, FilterGroup, FilterOperator, PivotArea, PivotCell, PivotCellTextAccessor, PivotCellValueAccessor, PivotColumnWidthDefaults, PivotControllerCallbacks, PivotControllerOptions, PivotControllerState, PivotDataSource, PivotDensity, PivotDictionary, PivotDragIntentState, PivotGroupInterval, PivotImportStatus, PivotLabelFilter, PivotLayoutProfile, PivotLayoutState, PivotLocale, PivotNode, PivotPrefilter, PivotRowKey, PivotRowKeyResolver, PivotRowTransaction, PivotSelectionMode, PivotSelectionRange, PivotSelectionState, PivotSelectionStats, PivotStateStoringConfig, PivotSummaryDisplayMode, PivotSummaryType, PivotTheme, PivotToolbarConfig, PivotTransactionResult, PivotValueFilter, defaultPivotLayout } from '@kanunilabs/pivotgrid-core';
6
6
  import * as _dnd_kit_core from '@dnd-kit/core';
7
7
  import { DragMoveEvent, DragEndEvent } from '@dnd-kit/core';
8
8
 
@@ -16,6 +16,12 @@ interface PivotGridRef extends PivotGridRef$1 {
16
16
  * one column and keep the rest.
17
17
  */
18
18
  setColumnWidths: (widths: Record<string, number>) => void;
19
+ /**
20
+ * Quick search: show only the row members whose caption contains `text`
21
+ * (ignoring case and accents), with the members above them. `''` clears it.
22
+ * Works with or without the `search` box.
23
+ */
24
+ setSearchText: (text: string) => void;
19
25
  /**
20
26
  * Add, update and remove rows without rebuilding the pivot (live updates).
21
27
  * Rows are matched by the `rowKey` prop (by object identity without it); an
@@ -148,7 +154,10 @@ interface BasePivotGridProps<TRow> {
148
154
  serverSource?: PivotControllerOptions<TRow>['serverSource'];
149
155
  /** The plugin registry containing custom functions and formatters. */
150
156
  registry?: PivotEngineRegistry;
151
- /** Locale for the grid (tr, en, ar). Defaults to tr. */
157
+ /**
158
+ * Interface language: 'en', 'tr', 'ar', 'de', 'fr', 'es', 'it', 'pt', 'ru', 'zh-CN', 'ja' or 'ko'.
159
+ * Defaults to 'en'. Also sets the number formatting, and right-to-left for 'ar' (see `rtl`).
160
+ */
152
161
  locale?: PivotLocale;
153
162
  /** Right-to-Left (RTL) mode. Defaults to false (except for 'ar'). */
154
163
  rtl?: boolean;
@@ -156,6 +165,12 @@ interface BasePivotGridProps<TRow> {
156
165
  dictionary?: Partial<PivotDictionary>;
157
166
  /** Apply zebra striping to the data rows. */
158
167
  striped?: boolean;
168
+ /**
169
+ * Row rhythm: `'compact'` (24px rows, one size smaller type), `'normal'`
170
+ * (28px, the default) or `'comfortable'` (36px). Changing it repaints in
171
+ * place, without re-running the pivot engine.
172
+ */
173
+ density?: PivotDensity;
159
174
  /**
160
175
  * Starting widths in pixels: `{ rowHeader, data }` for every row-header
161
176
  * column and every data column. Defaults 150 and 95. A width the user drags
@@ -217,6 +232,17 @@ interface BasePivotGridProps<TRow> {
217
232
  onError?: (error: Error) => void;
218
233
  /** Disables all interactive features (drag & drop, expand/collapse, context menu, filtering, etc.) */
219
234
  disabled?: boolean;
235
+ /**
236
+ * A search box in the footer: shows only the row members whose caption
237
+ * contains the text, on top of the reader's own filters. Default false.
238
+ * `ref.setSearchText(text)` works either way.
239
+ */
240
+ search?: boolean;
241
+ /**
242
+ * Most column members drawn (default 1000); past it the grid says so and
243
+ * totals still count all the data. `0` or `Infinity` turns the cap off.
244
+ */
245
+ maxColumns?: number;
220
246
  /** Slot for injecting Enterprise Calculated Field Modal */
221
247
  renderCalculatedFieldModal?: (props: any) => React__default.ReactNode;
222
248
  /** Slot for injecting Enterprise Prefilter Builder */
@@ -283,8 +309,14 @@ interface PivotGridBodyProps {
283
309
  onCellPrepared?: (e: CellPreparedEvent<any>) => void;
284
310
  disabled?: boolean;
285
311
  renderNodeContextMenu?: (props: any) => React.ReactNode;
312
+ /**
313
+ * Body row height in px — the grid's `density` resolved (`pivotRowHeight`).
314
+ * The virtualizer, spacers and keyboard scrolling all run on it; the
315
+ * stylesheet's density class sets the matching line heights. Default 28.
316
+ */
317
+ rowHeight?: number;
286
318
  }
287
- declare function PivotGridBody({ engineResult, isBuilding, buildProgress, rowFields, colFields: _colFields, dataFields, layout, expandedPaths, allExpanded, onToggleExpand, onExpandPaths, onCollapsePaths, expandedColPaths, allColExpanded, onToggleColExpand, onExpandColPaths, onCollapseColPaths, onCellClick, onContextMenu, onFilterClick, onRemoveField, onSort, onMoveField, onGlobalContextMenu, columnWidths, defaultColumnWidths, onColumnWidthsChange, onSelectionStatsChange, registry, keyboardNavigation, onCellPrepared, renderNodeContextMenu }: PivotGridBodyProps): React$1.JSX.Element;
319
+ declare function PivotGridBody({ engineResult, isBuilding, buildProgress, rowFields, colFields: _colFields, dataFields, layout, expandedPaths, allExpanded, onToggleExpand, onExpandPaths, onCollapsePaths, expandedColPaths, allColExpanded, onToggleColExpand, onExpandColPaths, onCollapseColPaths, onCellClick, onContextMenu, onFilterClick, onRemoveField, onSort, onMoveField, onGlobalContextMenu, columnWidths, defaultColumnWidths, onColumnWidthsChange, onSelectionStatsChange, registry, keyboardNavigation, onCellPrepared, renderNodeContextMenu, rowHeight }: PivotGridBodyProps): React$1.JSX.Element;
288
320
 
289
321
  interface PivotFooterProps {
290
322
  onToggleFieldChooser: () => void;
@@ -331,8 +363,12 @@ interface PivotFooterProps {
331
363
  * item — e.g. your pricing / Enterprise sales page.
332
364
  */
333
365
  upgradeUrl?: string;
366
+ /** Present → the quick-search box is drawn; called with the typed text. */
367
+ onSearch?: (text: string) => void;
368
+ /** The search in effect, so one set through `ref.setSearchText` shows in the box. */
369
+ searchText?: string;
334
370
  }
335
- declare function PivotFooter({ onToggleFieldChooser, fieldChooserOpen, onRefresh, onExport, onImportFile, onImportFiles, onPasteImport, onExpandAll, onCollapseAll, onAddCalculatedField, onOpenPrefilter, onToggleChart, isFullscreen, onToggleFullscreen, reports, activeReportId, onSaveNewReport, onUpdateCurrentReport, onSaveAsReport, onLoadReport, onDeleteReport, onSetDefaultReport, onGlobalContextMenu, selectionStats, toolbarConfig, registry, advancedExport, upgradeUrl }: PivotFooterProps): React$1.JSX.Element;
371
+ declare function PivotFooter({ onToggleFieldChooser, fieldChooserOpen, onRefresh, onExport, onImportFile, onImportFiles, onPasteImport, onExpandAll, onCollapseAll, onAddCalculatedField, onOpenPrefilter, onToggleChart, isFullscreen, onToggleFullscreen, reports, activeReportId, onSaveNewReport, onUpdateCurrentReport, onSaveAsReport, onLoadReport, onDeleteReport, onSetDefaultReport, onGlobalContextMenu, selectionStats, toolbarConfig, registry, advancedExport, upgradeUrl, onSearch, searchText }: PivotFooterProps): React$1.JSX.Element;
336
372
 
337
373
  type MoveDirection = 'start' | 'end' | 'left' | 'right';
338
374
  interface PivotAreaStripsProps {
package/dist/index.d.ts CHANGED
@@ -1,8 +1,8 @@
1
1
  import * as React$1 from 'react';
2
2
  import React__default, { Component, ErrorInfo } from 'react';
3
3
  import * as _kanunilabs_pivotgrid_core from '@kanunilabs/pivotgrid-core';
4
- import { PivotField as PivotField$1, PivotCellTemplate as PivotCellTemplate$1, CellClickEvent as CellClickEvent$1, CellPreparedEvent as CellPreparedEvent$1, PivotGridRef as PivotGridRef$1, PivotRowTransaction, PivotTransactionResult, PivotController, PivotConditionRule as PivotConditionRule$1, PivotCell, PivotEngineResult, PivotControllerOptions, PivotLayoutState, PivotTheme, PivotStateStoringConfig, PivotToolbarConfig, PivotEngineRegistry, PivotLocale, PivotDictionary, PivotColumnWidthDefaults, FieldMoveEvent, ExportingEvent, ExportFormat, PivotReport, PivotArea, PivotNode, PivotControllerState } from '@kanunilabs/pivotgrid-core';
5
- export { CustomSummaryOptions, DropIntent, ExportingEvent, FieldMoveEvent, FilterCondition, FilterGroup, FilterOperator, PivotArea, PivotCell, PivotCellTextAccessor, PivotCellValueAccessor, PivotColumnWidthDefaults, PivotControllerCallbacks, PivotControllerOptions, PivotControllerState, PivotDataSource, PivotDictionary, PivotDragIntentState, PivotGroupInterval, PivotImportStatus, PivotLabelFilter, PivotLayoutProfile, PivotLayoutState, PivotLocale, PivotNode, PivotPrefilter, PivotRowKey, PivotRowKeyResolver, PivotRowTransaction, PivotSelectionMode, PivotSelectionRange, PivotSelectionState, PivotSelectionStats, PivotStateStoringConfig, PivotSummaryDisplayMode, PivotSummaryType, PivotTheme, PivotToolbarConfig, PivotTransactionResult, PivotValueFilter, defaultPivotLayout } from '@kanunilabs/pivotgrid-core';
4
+ import { PivotField as PivotField$1, PivotCellTemplate as PivotCellTemplate$1, CellClickEvent as CellClickEvent$1, CellPreparedEvent as CellPreparedEvent$1, PivotGridRef as PivotGridRef$1, PivotRowTransaction, PivotTransactionResult, PivotController, PivotConditionRule as PivotConditionRule$1, PivotCell, PivotEngineResult, PivotControllerOptions, PivotLayoutState, PivotTheme, PivotStateStoringConfig, PivotToolbarConfig, PivotEngineRegistry, PivotLocale, PivotDictionary, PivotDensity, PivotColumnWidthDefaults, FieldMoveEvent, ExportingEvent, ExportFormat, PivotReport, PivotArea, PivotNode, PivotControllerState } from '@kanunilabs/pivotgrid-core';
5
+ export { CustomSummaryOptions, DropIntent, ExportingEvent, FieldMoveEvent, FilterCondition, FilterGroup, FilterOperator, PivotArea, PivotCell, PivotCellTextAccessor, PivotCellValueAccessor, PivotColumnWidthDefaults, PivotControllerCallbacks, PivotControllerOptions, PivotControllerState, PivotDataSource, PivotDensity, PivotDictionary, PivotDragIntentState, PivotGroupInterval, PivotImportStatus, PivotLabelFilter, PivotLayoutProfile, PivotLayoutState, PivotLocale, PivotNode, PivotPrefilter, PivotRowKey, PivotRowKeyResolver, PivotRowTransaction, PivotSelectionMode, PivotSelectionRange, PivotSelectionState, PivotSelectionStats, PivotStateStoringConfig, PivotSummaryDisplayMode, PivotSummaryType, PivotTheme, PivotToolbarConfig, PivotTransactionResult, PivotValueFilter, defaultPivotLayout } from '@kanunilabs/pivotgrid-core';
6
6
  import * as _dnd_kit_core from '@dnd-kit/core';
7
7
  import { DragMoveEvent, DragEndEvent } from '@dnd-kit/core';
8
8
 
@@ -16,6 +16,12 @@ interface PivotGridRef extends PivotGridRef$1 {
16
16
  * one column and keep the rest.
17
17
  */
18
18
  setColumnWidths: (widths: Record<string, number>) => void;
19
+ /**
20
+ * Quick search: show only the row members whose caption contains `text`
21
+ * (ignoring case and accents), with the members above them. `''` clears it.
22
+ * Works with or without the `search` box.
23
+ */
24
+ setSearchText: (text: string) => void;
19
25
  /**
20
26
  * Add, update and remove rows without rebuilding the pivot (live updates).
21
27
  * Rows are matched by the `rowKey` prop (by object identity without it); an
@@ -148,7 +154,10 @@ interface BasePivotGridProps<TRow> {
148
154
  serverSource?: PivotControllerOptions<TRow>['serverSource'];
149
155
  /** The plugin registry containing custom functions and formatters. */
150
156
  registry?: PivotEngineRegistry;
151
- /** Locale for the grid (tr, en, ar). Defaults to tr. */
157
+ /**
158
+ * Interface language: 'en', 'tr', 'ar', 'de', 'fr', 'es', 'it', 'pt', 'ru', 'zh-CN', 'ja' or 'ko'.
159
+ * Defaults to 'en'. Also sets the number formatting, and right-to-left for 'ar' (see `rtl`).
160
+ */
152
161
  locale?: PivotLocale;
153
162
  /** Right-to-Left (RTL) mode. Defaults to false (except for 'ar'). */
154
163
  rtl?: boolean;
@@ -156,6 +165,12 @@ interface BasePivotGridProps<TRow> {
156
165
  dictionary?: Partial<PivotDictionary>;
157
166
  /** Apply zebra striping to the data rows. */
158
167
  striped?: boolean;
168
+ /**
169
+ * Row rhythm: `'compact'` (24px rows, one size smaller type), `'normal'`
170
+ * (28px, the default) or `'comfortable'` (36px). Changing it repaints in
171
+ * place, without re-running the pivot engine.
172
+ */
173
+ density?: PivotDensity;
159
174
  /**
160
175
  * Starting widths in pixels: `{ rowHeader, data }` for every row-header
161
176
  * column and every data column. Defaults 150 and 95. A width the user drags
@@ -217,6 +232,17 @@ interface BasePivotGridProps<TRow> {
217
232
  onError?: (error: Error) => void;
218
233
  /** Disables all interactive features (drag & drop, expand/collapse, context menu, filtering, etc.) */
219
234
  disabled?: boolean;
235
+ /**
236
+ * A search box in the footer: shows only the row members whose caption
237
+ * contains the text, on top of the reader's own filters. Default false.
238
+ * `ref.setSearchText(text)` works either way.
239
+ */
240
+ search?: boolean;
241
+ /**
242
+ * Most column members drawn (default 1000); past it the grid says so and
243
+ * totals still count all the data. `0` or `Infinity` turns the cap off.
244
+ */
245
+ maxColumns?: number;
220
246
  /** Slot for injecting Enterprise Calculated Field Modal */
221
247
  renderCalculatedFieldModal?: (props: any) => React__default.ReactNode;
222
248
  /** Slot for injecting Enterprise Prefilter Builder */
@@ -283,8 +309,14 @@ interface PivotGridBodyProps {
283
309
  onCellPrepared?: (e: CellPreparedEvent<any>) => void;
284
310
  disabled?: boolean;
285
311
  renderNodeContextMenu?: (props: any) => React.ReactNode;
312
+ /**
313
+ * Body row height in px — the grid's `density` resolved (`pivotRowHeight`).
314
+ * The virtualizer, spacers and keyboard scrolling all run on it; the
315
+ * stylesheet's density class sets the matching line heights. Default 28.
316
+ */
317
+ rowHeight?: number;
286
318
  }
287
- declare function PivotGridBody({ engineResult, isBuilding, buildProgress, rowFields, colFields: _colFields, dataFields, layout, expandedPaths, allExpanded, onToggleExpand, onExpandPaths, onCollapsePaths, expandedColPaths, allColExpanded, onToggleColExpand, onExpandColPaths, onCollapseColPaths, onCellClick, onContextMenu, onFilterClick, onRemoveField, onSort, onMoveField, onGlobalContextMenu, columnWidths, defaultColumnWidths, onColumnWidthsChange, onSelectionStatsChange, registry, keyboardNavigation, onCellPrepared, renderNodeContextMenu }: PivotGridBodyProps): React$1.JSX.Element;
319
+ declare function PivotGridBody({ engineResult, isBuilding, buildProgress, rowFields, colFields: _colFields, dataFields, layout, expandedPaths, allExpanded, onToggleExpand, onExpandPaths, onCollapsePaths, expandedColPaths, allColExpanded, onToggleColExpand, onExpandColPaths, onCollapseColPaths, onCellClick, onContextMenu, onFilterClick, onRemoveField, onSort, onMoveField, onGlobalContextMenu, columnWidths, defaultColumnWidths, onColumnWidthsChange, onSelectionStatsChange, registry, keyboardNavigation, onCellPrepared, renderNodeContextMenu, rowHeight }: PivotGridBodyProps): React$1.JSX.Element;
288
320
 
289
321
  interface PivotFooterProps {
290
322
  onToggleFieldChooser: () => void;
@@ -331,8 +363,12 @@ interface PivotFooterProps {
331
363
  * item — e.g. your pricing / Enterprise sales page.
332
364
  */
333
365
  upgradeUrl?: string;
366
+ /** Present → the quick-search box is drawn; called with the typed text. */
367
+ onSearch?: (text: string) => void;
368
+ /** The search in effect, so one set through `ref.setSearchText` shows in the box. */
369
+ searchText?: string;
334
370
  }
335
- declare function PivotFooter({ onToggleFieldChooser, fieldChooserOpen, onRefresh, onExport, onImportFile, onImportFiles, onPasteImport, onExpandAll, onCollapseAll, onAddCalculatedField, onOpenPrefilter, onToggleChart, isFullscreen, onToggleFullscreen, reports, activeReportId, onSaveNewReport, onUpdateCurrentReport, onSaveAsReport, onLoadReport, onDeleteReport, onSetDefaultReport, onGlobalContextMenu, selectionStats, toolbarConfig, registry, advancedExport, upgradeUrl }: PivotFooterProps): React$1.JSX.Element;
371
+ declare function PivotFooter({ onToggleFieldChooser, fieldChooserOpen, onRefresh, onExport, onImportFile, onImportFiles, onPasteImport, onExpandAll, onCollapseAll, onAddCalculatedField, onOpenPrefilter, onToggleChart, isFullscreen, onToggleFullscreen, reports, activeReportId, onSaveNewReport, onUpdateCurrentReport, onSaveAsReport, onLoadReport, onDeleteReport, onSetDefaultReport, onGlobalContextMenu, selectionStats, toolbarConfig, registry, advancedExport, upgradeUrl, onSearch, searchText }: PivotFooterProps): React$1.JSX.Element;
336
372
 
337
373
  type MoveDirection = 'start' | 'end' | 'left' | 'right';
338
374
  interface PivotAreaStripsProps {