@opencorestack/opengridx 3.8.1 → 3.9.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.
- package/CHANGELOG.md +24 -0
- package/dist/index.d.ts +340 -1
- package/dist/opengridx.css +1 -1
- package/dist/opengridx.es.js +7529 -7285
- package/dist/opengridx.es.js.map +1 -1
- package/dist/opengridx.umd.js +16 -16
- package/dist/opengridx.umd.js.map +1 -1
- package/docs/API_REFERENCE.md +93 -4
- package/docs/customization/theming.md +11 -2
- package/docs/features/ai-toolkit.md +1 -1
- package/lib/components/AiAssistant/GridAiAssistantPanel.tsx +16 -14
- package/lib/components/Cell/CellErrorBoundary.tsx +17 -10
- package/lib/components/CellSelectionStats/CellSelectionStats.tsx +5 -3
- package/lib/components/ColumnResizeHandle/ColumnResizeHandle.tsx +3 -1
- package/lib/components/ColumnVisibilityPanel/ColumnVisibilityPanel.tsx +6 -4
- package/lib/components/DataGrid/GridAggregationFooter.tsx +3 -1
- package/lib/components/DataGrid/GridErrorOverlay.tsx +4 -2
- package/lib/components/DataGrid/GridListView.tsx +7 -5
- package/lib/components/DataGrid/GridLiveRegion.tsx +5 -3
- package/lib/components/DataGrid/GridLoadingOverlay.tsx +3 -1
- package/lib/components/DataGrid/GridPinnedRows.tsx +1 -1
- package/lib/components/DataGrid/GridRoot.tsx +8 -1
- package/lib/components/DataGrid/GridStandaloneColumnPanel.tsx +3 -1
- package/lib/components/DataGrid/GridViewport.tsx +3 -1
- package/lib/components/DataGrid/GridVirtualRows.tsx +1 -1
- package/lib/components/DataGrid/gridLocaleContext.ts +13 -0
- package/lib/components/FilterPanel/FilterPanel.tsx +18 -17
- package/lib/components/Header/ColumnMenu.css +5 -5
- package/lib/components/Header/ColumnMenu.tsx +17 -15
- package/lib/components/Header/Header.tsx +8 -6
- package/lib/components/HeaderFilter/HeaderFilterRow.tsx +3 -1
- package/lib/components/ListView/ListViewRow.tsx +3 -1
- package/lib/components/Pagination/Pagination.tsx +15 -18
- package/lib/components/QuickFilter/QuickFilter.tsx +5 -2
- package/lib/components/Row/Row.tsx +5 -3
- package/lib/components/Toolbar/GlobalSearch.tsx +6 -3
- package/lib/components/Toolbar/GridToolbar.tsx +35 -29
- package/lib/components/Toolbar/PivotPanel.tsx +26 -24
- package/lib/components/ui/Checkbox.css +5 -5
- package/lib/components/ui/DragHandleIcon.tsx +3 -1
- package/lib/components/ui/ExpandIcon.css +3 -3
- package/lib/components/ui/ExpandIcon.tsx +3 -1
- package/lib/hooks/core/useGridRowInteractions.ts +13 -3
- package/lib/hooks/core/useGridToolbarStack.ts +2 -2
- package/lib/hooks/core/useGridVirtualization.ts +40 -25
- package/lib/hooks/core/useShallowStableValue.ts +29 -0
- package/lib/hooks/features/useGridAiAssistant.ts +52 -22
- package/lib/theme/DataGridThemeProvider.tsx +9 -0
- package/lib/theme/types.ts +18 -0
- package/lib/types/locale.ts +344 -0
- package/lib/utils/gridLocale.ts +241 -0
- package/llms.txt +3 -1
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -5,6 +5,30 @@
|
|
|
5
5
|
|
|
6
6
|
---
|
|
7
7
|
|
|
8
|
+
## [3.9.0] — 2026-10-13
|
|
9
|
+
|
|
10
|
+
### Added
|
|
11
|
+
|
|
12
|
+
- **Nine theme keys** (additive; each defaults to exactly what the grid draws today, checked by the default-theme baseline in Chromium, Firefox and WebKit): `grid.checkboxCheckedBackground` (`--ogx-checkbox-checked-bg`, the fill and border of a checked or indeterminate checkbox, default the primary colour), `grid.checkboxCheckmark` (`--ogx-checkbox-checkmark`, default white), `grid.expandIconColor` / `expandIconHoverColor` (`--ogx-expand-icon-color` / `-hover-color`, the group and tree chevron, default header text / row text), and for menus `overlays.itemIndicatorColor` (`--ogx-overlay-item-indicator`, the selection dot, default the selected item text), `itemSelectedIcon` (`--ogx-overlay-item-selected-icon`, default primary), `iconColor` (`--ogx-overlay-icon`, default gray-400), `sectionLabelText` (`--ogx-overlay-section-label-text`, default gray-400) and `dividerColor` (`--ogx-overlay-divider`, default the overlay border).
|
|
13
|
+
- **Theme Builder controls** for those keys and for existing keys it did not offer: a *Checkboxes* group (background, border, checked fill, check mark), a *Group and tree rows* group (chevron, chevron hover), *Selected row hover*, a *Toolbar and search box* group (toolbar text, search box background, text, border, focus border), and in *Column menu and panels* the item hover text, selected item text, selection dot, selected item icon, icons, section labels, dividers and danger item colours.
|
|
14
|
+
|
|
15
|
+
- **`localeText` covers every built-in UI string** (196 optional keys, additive; without them the grid shows the same English as before): the column menu, toolbar and quick search, filter panel (including operator names), columns panel, pivot panel, AI assistant panel and its status line, pagination buttons, row and header checkboxes and handles, cell selection statistics, list view, loading and error overlays, the error cell and screen-reader announcements. The strings are resolved once per grid and shared through a context, so rows read them without a new prop. Components used outside a grid (`GridToolbar`, `ColumnVisibilityPanel`, `FilterPanel`) show English; their explicit props still win. Not covered: the AI assistant's change-chip texts, the grouping column's default header (`groupingColDef.headerName` sets it), and row data or file contents such as the pivot "Grand Total" row and export subtotals. An inline `localeText` object of strings keeps the rows memoised; function entries are compared by identity. See *Locale text for every UI string* in `docs/API_REFERENCE.md`; the Locale Text demo shows a French grid.
|
|
16
|
+
|
|
17
|
+
### Demo
|
|
18
|
+
|
|
19
|
+
- **Sidebar reorganised by what developers look for first**: *Getting started* (with Basic Usage and the API reference), *Sorting & filtering*, *Editing*, *Pagination & server data*, *Export & clipboard*, *Grouping & aggregation*, *Selection & spreadsheet*, *Layout*, *Theming & customization*, *AI*, *Advanced*, *Tutorials*, then *Resources* (licensing, support, migration guides). Page URLs are unchanged. Text pages are marked `doc` (full width) instead of relying on their category.
|
|
20
|
+
- The header shows the package version from `package.json` (it was fixed at v3.7.0).
|
|
21
|
+
|
|
22
|
+
### Performance
|
|
23
|
+
|
|
24
|
+
- **Selecting a row, starting or committing an edit, and scrolling no longer re-render every visible row.** Three props broke the rows' memoisation: the row click and checkbox handlers changed identity on every selection change (they now keep one identity and read the latest handlers when called), `editingCell` was passed to every row (now only to the row being edited), and the visible column list was rebuilt on every row change or vertical scroll (it now has its own memo over column widths and the horizontal scroll). Measured on the editing demo: a click re-rendered all 14 visible rows, now 1; starting an edit re-rendered all rows twice, now 2 renders in total. Guarded by `DataGrid.rowMemo.test.tsx`.
|
|
25
|
+
|
|
26
|
+
### Internal
|
|
27
|
+
|
|
28
|
+
- Four tests that failed now and then under load are steadier: the row and column drag-reorder browser test releases the mouse before and after each test and waits for layout; the header-filter scroll test clicks at the cell's coordinates (Playwright's click scrolled the cell into view, which re-rendered the virtualized rows and detached it); the PDF heartbeat test takes the better of two runs; the tree-data linear-time test interleaves its two sizes over five rounds.
|
|
29
|
+
|
|
30
|
+
---
|
|
31
|
+
|
|
8
32
|
## [3.8.1] — 2026-10-13
|
|
9
33
|
|
|
10
34
|
### Fixed
|
package/dist/index.d.ts
CHANGED
|
@@ -1545,6 +1545,327 @@ export declare interface GridLocaleText {
|
|
|
1545
1545
|
* operators keep their English name. @since v3.6
|
|
1546
1546
|
*/
|
|
1547
1547
|
headerFilterOperators?: Partial<Record<GridFilterOperator, string>>;
|
|
1548
|
+
/** `aria-label` of the grid when no `aria-label` prop is set. Default: `"Data grid"` @since v3.9 */
|
|
1549
|
+
gridLabel?: string;
|
|
1550
|
+
/** `aria-label` of the list view when no `aria-label` prop is set. Default: `"Data grid list view"` @since v3.9 */
|
|
1551
|
+
listViewLabel?: string;
|
|
1552
|
+
/** List view item count. Default: `` (n) => `${n} items` `` (`"1 item"` for 1) @since v3.9 */
|
|
1553
|
+
listViewItemCount?: (count: number) => string;
|
|
1554
|
+
/** List view page, after `" · "`. Default: `` (p, pc) => `page ${p} of ${pc}` `` @since v3.9 */
|
|
1555
|
+
listViewPage?: (page: number, pageCount: number) => string;
|
|
1556
|
+
/** List view selected count, after `" · "`. Default: `` (n) => `${n} selected` `` @since v3.9 */
|
|
1557
|
+
listViewSelectedCount?: (count: number) => string;
|
|
1558
|
+
/** `aria-label` of the loading progress bar. Default: `"Loading data"` @since v3.9 */
|
|
1559
|
+
loadingLabel?: string;
|
|
1560
|
+
/** Live-region announcement while loading. Default: `"Loading data..."` @since v3.9 */
|
|
1561
|
+
liveRegionLoading?: string;
|
|
1562
|
+
/** Live-region announcement of a load error. Default: `` (m) => `Error: ${m}` `` @since v3.9 */
|
|
1563
|
+
liveRegionError?: (message: string) => string;
|
|
1564
|
+
/** Live-region announcement of the filtered row count. Default: `` (n) => `${n} rows found` `` (`"1 row found"`) @since v3.9 */
|
|
1565
|
+
liveRegionRowsFound?: (count: number) => string;
|
|
1566
|
+
/** Title of the data source error overlay. Default: `"Oops! Something went wrong"` @since v3.9 */
|
|
1567
|
+
errorOverlayTitle?: string;
|
|
1568
|
+
/** Retry button of the error overlay. Default: `"Retry"` @since v3.9 */
|
|
1569
|
+
errorOverlayRetry?: string;
|
|
1570
|
+
/** `aria-label` of the aggregation footer row. Default: `"Aggregation totals"` @since v3.9 */
|
|
1571
|
+
aggregationFooterLabel?: string;
|
|
1572
|
+
/** `aria-label` of a cell whose `renderCell` threw. Default: `` (field) => `Error in cell: ${field}` `` @since v3.9 */
|
|
1573
|
+
cellErrorLabel?: (field: string) => string;
|
|
1574
|
+
/** Tooltip of such a cell when the error has no message. Default: `"Render error"` @since v3.9 */
|
|
1575
|
+
cellErrorTooltip?: string;
|
|
1576
|
+
/** `aria-label` of the row reorder column header. Default: `"Row reorder handle"` @since v3.9 */
|
|
1577
|
+
headerRowReorderLabel?: string;
|
|
1578
|
+
/** Tooltip of the row reorder column header. Default: `"Drag to reorder rows"` @since v3.9 */
|
|
1579
|
+
headerRowReorderTooltip?: string;
|
|
1580
|
+
/** `aria-label` of the detail panel column header. Default: `"Expand row details"` @since v3.9 */
|
|
1581
|
+
headerDetailPanelLabel?: string;
|
|
1582
|
+
/** `aria-label` of the select-all checkbox. Default: `"Select all rows"` @since v3.9 */
|
|
1583
|
+
headerSelectAllLabel?: string;
|
|
1584
|
+
/** `aria-label` of the select-all checkbox when every row is selected. Default: `"Deselect all rows"` @since v3.9 */
|
|
1585
|
+
headerDeselectAllLabel?: string;
|
|
1586
|
+
/**
|
|
1587
|
+
* Description of a sorted column with multi-sort. Receives the direction, the 1-based priority and the
|
|
1588
|
+
* number of sorted columns. Default: `` (d, p, n) => `Sorted ${d === 'asc' ? 'ascending' : 'descending'}, sort priority ${p} of ${n}` `` @since v3.9
|
|
1589
|
+
*/
|
|
1590
|
+
headerSortDescription?: (direction: 'asc' | 'desc', priority: number, total: number) => string;
|
|
1591
|
+
/** `aria-label` of the column menu button. Default: `` (h) => `Open column menu for ${h}` `` @since v3.9 */
|
|
1592
|
+
headerColumnMenuButtonLabel?: (header: string) => string;
|
|
1593
|
+
/** `aria-label` of a column resize handle. Receives the field. Default: `` (f) => `Resize ${f} column` `` @since v3.9 */
|
|
1594
|
+
headerColumnResizeLabel?: (field: string) => string;
|
|
1595
|
+
/** `aria-label` of the header filter cell of a column that cannot be filtered. Default: `` (h) => `No filter for ${h}` `` @since v3.9 */
|
|
1596
|
+
headerFilterNoFilterLabel?: (header: string) => string;
|
|
1597
|
+
/** `aria-label` of a row checkbox. Default: `` (id) => `Select row ${id}` `` @since v3.9 */
|
|
1598
|
+
rowSelectLabel?: (id: GridRowId) => string;
|
|
1599
|
+
/** `aria-label` of a selected row's checkbox. Default: `` (id) => `Deselect row ${id}` `` @since v3.9 */
|
|
1600
|
+
rowDeselectLabel?: (id: GridRowId) => string;
|
|
1601
|
+
/** `aria-label` of the row drag handle. Default: `"Drag to reorder row"` @since v3.9 */
|
|
1602
|
+
rowReorderLabel?: string;
|
|
1603
|
+
/** `aria-label` of the detail panel toggle. Default: `"Expand row details"` @since v3.9 */
|
|
1604
|
+
rowDetailPanelExpandLabel?: string;
|
|
1605
|
+
/** `aria-label` of an open detail panel's toggle. Default: `"Collapse row details"` @since v3.9 */
|
|
1606
|
+
rowDetailPanelCollapseLabel?: string;
|
|
1607
|
+
/** `aria-label` of a tree / group expand button. Default: `"Expand row"` @since v3.9 */
|
|
1608
|
+
rowExpandLabel?: string;
|
|
1609
|
+
/** `aria-label` of an expanded tree / group row's button. Default: `"Collapse row"` @since v3.9 */
|
|
1610
|
+
rowCollapseLabel?: string;
|
|
1611
|
+
/** `aria-label` of the column menu. Default: `` (h) => `Column options for ${h}` `` @since v3.9 */
|
|
1612
|
+
columnMenuLabel?: (header: string) => string;
|
|
1613
|
+
/** Default: `"Sort Ascending"` @since v3.9 */
|
|
1614
|
+
columnMenuSortAscending?: string;
|
|
1615
|
+
/** Default: `"Sort Descending"` @since v3.9 */
|
|
1616
|
+
columnMenuSortDescending?: string;
|
|
1617
|
+
/** Default: `"Unsort"` @since v3.9 */
|
|
1618
|
+
columnMenuUnsort?: string;
|
|
1619
|
+
/** Section label above the pin items. Default: `"Pin column"` @since v3.9 */
|
|
1620
|
+
columnMenuPinColumn?: string;
|
|
1621
|
+
/** Default: `"Pin to Left"` @since v3.9 */
|
|
1622
|
+
columnMenuPinLeft?: string;
|
|
1623
|
+
/** `aria-label` of the item. Default: `"Pin to left"` @since v3.9 */
|
|
1624
|
+
columnMenuPinLeftLabel?: string;
|
|
1625
|
+
/** Default: `"Pin to Right"` @since v3.9 */
|
|
1626
|
+
columnMenuPinRight?: string;
|
|
1627
|
+
/** `aria-label` of the item. Default: `"Pin to right"` @since v3.9 */
|
|
1628
|
+
columnMenuPinRightLabel?: string;
|
|
1629
|
+
/** Default: `"Unpin"` @since v3.9 */
|
|
1630
|
+
columnMenuUnpin?: string;
|
|
1631
|
+
/** `aria-label` of the item. Default: `"Unpin column"` @since v3.9 */
|
|
1632
|
+
columnMenuUnpinLabel?: string;
|
|
1633
|
+
/** Default: `"Hide Column"` @since v3.9 */
|
|
1634
|
+
columnMenuHideColumn?: string;
|
|
1635
|
+
/** `aria-label` of the item. Default: `` (h) => `Hide ${h} column` `` @since v3.9 */
|
|
1636
|
+
columnMenuHideColumnLabel?: (header: string) => string;
|
|
1637
|
+
/** Default: `"Manage columns"` @since v3.9 */
|
|
1638
|
+
columnMenuManageColumns?: string;
|
|
1639
|
+
/** `aria-label` of the item. Default: `"Manage all columns"` @since v3.9 */
|
|
1640
|
+
columnMenuManageColumnsLabel?: string;
|
|
1641
|
+
/** Placeholder of the search box. Default: `"Search"` @since v3.9 */
|
|
1642
|
+
columnsPanelSearchPlaceholder?: string;
|
|
1643
|
+
/** Tooltip of a drag handle. Default: `"Drag to reorder"` @since v3.9 */
|
|
1644
|
+
columnsPanelDragToReorder?: string;
|
|
1645
|
+
/** Default: `"Show/Hide All"` @since v3.9 */
|
|
1646
|
+
columnsPanelShowHideAll?: string;
|
|
1647
|
+
/** Default: `"Reset"` @since v3.9 */
|
|
1648
|
+
columnsPanelReset?: string;
|
|
1649
|
+
/** `aria-label` of the close button of the panel opened from the column menu. Default: `"Close"` @since v3.9 */
|
|
1650
|
+
columnsPanelClose?: string;
|
|
1651
|
+
/** `aria-label` of a value input. Default: `` (h) => `Filter value for ${h}` `` @since v3.9 */
|
|
1652
|
+
filterPanelValueLabel?: (header: string) => string;
|
|
1653
|
+
/** `aria-label` of an operator select. Default: `` (h) => `Filter operator for ${h}` `` @since v3.9 */
|
|
1654
|
+
filterPanelOperatorLabel?: (header: string) => string;
|
|
1655
|
+
/** `aria-label` of a clear button. Default: `` (h) => `Clear filter for ${h}` `` @since v3.9 */
|
|
1656
|
+
filterPanelClearLabel?: (header: string) => string;
|
|
1657
|
+
/** Tooltip of a clear button. Default: `"Clear"` @since v3.9 */
|
|
1658
|
+
filterPanelClearTooltip?: string;
|
|
1659
|
+
/** Empty choice of the boolean and single-select values. Default: `"Any"` @since v3.9 */
|
|
1660
|
+
filterPanelAny?: string;
|
|
1661
|
+
/** "true" choice of the boolean value. Default: `"true"` @since v3.9 */
|
|
1662
|
+
filterPanelTrue?: string;
|
|
1663
|
+
/** "false" choice of the boolean value. Default: `"false"` @since v3.9 */
|
|
1664
|
+
filterPanelFalse?: string;
|
|
1665
|
+
/** Placeholder of a number value. Default: `"Number…"` @since v3.9 */
|
|
1666
|
+
filterPanelNumberPlaceholder?: string;
|
|
1667
|
+
/** Placeholder of other values. Default: `"Value…"` @since v3.9 */
|
|
1668
|
+
filterPanelValuePlaceholder?: string;
|
|
1669
|
+
/** Label before the And / Or choice. Default: `"Match:"` @since v3.9 */
|
|
1670
|
+
filterPanelMatch?: string;
|
|
1671
|
+
/** Default: `"ALL (AND)"` @since v3.9 */
|
|
1672
|
+
filterPanelAnd?: string;
|
|
1673
|
+
/** Default: `"ANY (OR)"` @since v3.9 */
|
|
1674
|
+
filterPanelOr?: string;
|
|
1675
|
+
/**
|
|
1676
|
+
* Note about conditions the panel cannot show. Default for 1: `"1 more condition (a filter group or a
|
|
1677
|
+
* second condition on a column) is applied and not shown here."`, plural otherwise. @since v3.9
|
|
1678
|
+
*/
|
|
1679
|
+
filterPanelHiddenConditions?: (count: number) => string;
|
|
1680
|
+
/** Default: `"No filterable columns."` @since v3.9 */
|
|
1681
|
+
filterPanelNoColumns?: string;
|
|
1682
|
+
/** Operator names in the operator select. Missing operators show their id (`"contains"`). @since v3.9 */
|
|
1683
|
+
filterPanelOperators?: Partial<Record<GridFilterOperator, string>>;
|
|
1684
|
+
/** `aria-label` of the toolbar. Default: `"Grid toolbar"` @since v3.9 */
|
|
1685
|
+
toolbarLabel?: string;
|
|
1686
|
+
/** Placeholder of the toolbar search and of `QuickFilter`. Default: `"Search..."` @since v3.9 */
|
|
1687
|
+
toolbarSearchPlaceholder?: string;
|
|
1688
|
+
/** `aria-label` of the toolbar search. Default: `"Global Search"` @since v3.9 */
|
|
1689
|
+
toolbarSearchLabel?: string;
|
|
1690
|
+
/** `aria-label` of the search clear button. Default: `"Clear search"` @since v3.9 */
|
|
1691
|
+
toolbarSearchClear?: string;
|
|
1692
|
+
/** Tooltip of the columns button. Default: `"Columns"` @since v3.9 */
|
|
1693
|
+
toolbarColumns?: string;
|
|
1694
|
+
/** `aria-label` of the columns button. Default: `"Manage columns"` @since v3.9 */
|
|
1695
|
+
toolbarColumnsLabel?: string;
|
|
1696
|
+
/** `aria-label` of the columns panel. Default: `"Column visibility"` @since v3.9 */
|
|
1697
|
+
toolbarColumnsPanelLabel?: string;
|
|
1698
|
+
/** Tooltip of the filters button and title of the filters panel. Default: `"Filters"` @since v3.9 */
|
|
1699
|
+
toolbarFilters?: string;
|
|
1700
|
+
/** `aria-label` of the filters button and panel. Default: `"Advanced filters"` @since v3.9 */
|
|
1701
|
+
toolbarFiltersLabel?: string;
|
|
1702
|
+
/** `aria-label` of the active-filters dot. Default: `"Filters active"` @since v3.9 */
|
|
1703
|
+
toolbarFiltersActive?: string;
|
|
1704
|
+
/** Default: `"Clear all"` @since v3.9 */
|
|
1705
|
+
toolbarFiltersClearAll?: string;
|
|
1706
|
+
/** Default: `"Clear all filters"` @since v3.9 */
|
|
1707
|
+
toolbarFiltersClearAllTooltip?: string;
|
|
1708
|
+
/** Default: `"Close"` @since v3.9 */
|
|
1709
|
+
toolbarFiltersClose?: string;
|
|
1710
|
+
/** Default: `"Close filters"` @since v3.9 */
|
|
1711
|
+
toolbarFiltersCloseTooltip?: string;
|
|
1712
|
+
/** Default: `"Close filters panel"` @since v3.9 */
|
|
1713
|
+
toolbarFiltersCloseLabel?: string;
|
|
1714
|
+
/** Tooltip of the pivot button. Default: `"Pivot"` @since v3.9 */
|
|
1715
|
+
toolbarPivot?: string;
|
|
1716
|
+
/** `aria-label` of the pivot button. Default: `"Configure pivot"` @since v3.9 */
|
|
1717
|
+
toolbarPivotLabel?: string;
|
|
1718
|
+
/** `aria-label` of the active-pivot dot. Default: `"Pivot active"` @since v3.9 */
|
|
1719
|
+
toolbarPivotActive?: string;
|
|
1720
|
+
/** Tooltip of the summaries button and title of its panel. Default: `"Summaries"` @since v3.9 */
|
|
1721
|
+
toolbarSummaries?: string;
|
|
1722
|
+
/** `aria-label` of the summaries button. Default: `"Configure summaries"` @since v3.9 */
|
|
1723
|
+
toolbarSummariesLabel?: string;
|
|
1724
|
+
/** `aria-label` of the active-summaries dot. Default: `` (n) => `${n} active summaries` `` @since v3.9 */
|
|
1725
|
+
toolbarSummariesActive?: (count: number) => string;
|
|
1726
|
+
/** `aria-label` of the summaries panel. Default: `"Summaries configuration"` @since v3.9 */
|
|
1727
|
+
toolbarSummariesPanelLabel?: string;
|
|
1728
|
+
/** Default: `"Clear all"` @since v3.9 */
|
|
1729
|
+
toolbarSummariesClearAll?: string;
|
|
1730
|
+
/** Default: `"Clear all summaries"` @since v3.9 */
|
|
1731
|
+
toolbarSummariesClearAllTooltip?: string;
|
|
1732
|
+
/** Default: `"No aggregable columns."` @since v3.9 */
|
|
1733
|
+
toolbarSummariesEmpty?: string;
|
|
1734
|
+
/** Text before `aggregable: true` in the empty panel. Default: `"Set"` @since v3.9 */
|
|
1735
|
+
toolbarSummariesEmptyHintBefore?: string;
|
|
1736
|
+
/** Text after `aggregable: true` in the empty panel. Default: `"on a column to enable."` @since v3.9 */
|
|
1737
|
+
toolbarSummariesEmptyHintAfter?: string;
|
|
1738
|
+
/** Names of the aggregation functions in the summaries panel (`none`, `sum`, …). Missing ones show their id. @since v3.9 */
|
|
1739
|
+
toolbarAggregationFunctions?: Partial<Record<string, string>>;
|
|
1740
|
+
/** `aria-label` of the panel. Default: `"Pivot configuration"` @since v3.9 */
|
|
1741
|
+
pivotPanelLabel?: string;
|
|
1742
|
+
/** Default: `"Pivot Mode"` @since v3.9 */
|
|
1743
|
+
pivotMode?: string;
|
|
1744
|
+
/** Default: `"Reset"` @since v3.9 */
|
|
1745
|
+
pivotReset?: string;
|
|
1746
|
+
/** Default: `"Reset pivot"` @since v3.9 */
|
|
1747
|
+
pivotResetTooltip?: string;
|
|
1748
|
+
/** Default: `"Row Fields"` @since v3.9 */
|
|
1749
|
+
pivotRowFields?: string;
|
|
1750
|
+
/** Default: `"Column Fields"` @since v3.9 */
|
|
1751
|
+
pivotColumnFields?: string;
|
|
1752
|
+
/** Default: `"Value Fields (aggregated)"` @since v3.9 */
|
|
1753
|
+
pivotValueFields?: string;
|
|
1754
|
+
/** Default: `"Add fields here — each becomes a row label"` @since v3.9 */
|
|
1755
|
+
pivotRowFieldsPlaceholder?: string;
|
|
1756
|
+
/** Default: `"Add fields here — unique values become column headers"` @since v3.9 */
|
|
1757
|
+
pivotColumnFieldsPlaceholder?: string;
|
|
1758
|
+
/** Default: `"Add numeric fields here — values are aggregated"` @since v3.9 */
|
|
1759
|
+
pivotValueFieldsPlaceholder?: string;
|
|
1760
|
+
/** Tooltip of a chip's remove button. Default: `` (h) => `Remove ${h}` `` @since v3.9 */
|
|
1761
|
+
pivotRemoveTooltip?: (header: string) => string;
|
|
1762
|
+
/** Default: `` (h) => `Remove ${h} from Row Fields` `` @since v3.9 */
|
|
1763
|
+
pivotRemoveRowLabel?: (header: string) => string;
|
|
1764
|
+
/** Default: `` (h) => `Remove ${h} from Column Fields` `` @since v3.9 */
|
|
1765
|
+
pivotRemoveColumnLabel?: (header: string) => string;
|
|
1766
|
+
/** Receives the header and the function's name. Default: `` (h, fn) => `Remove ${h} (${fn}) from Value Fields` `` @since v3.9 */
|
|
1767
|
+
pivotRemoveValueLabel?: (header: string, aggregationFunction: string) => string;
|
|
1768
|
+
/** Tooltip of a value field's function select. Default: `"Aggregation function"` @since v3.9 */
|
|
1769
|
+
pivotAggregationTooltip?: string;
|
|
1770
|
+
/** Default: `` (h) => `Aggregation function for ${h}` `` @since v3.9 */
|
|
1771
|
+
pivotAggregationLabel?: (header: string) => string;
|
|
1772
|
+
/** Names of the aggregation functions in the pivot panel. Missing ones show the id in upper case (`"SUM"`). @since v3.9 */
|
|
1773
|
+
pivotAggregationFunctions?: Partial<Record<string, string>>;
|
|
1774
|
+
/** Default: `"Available Fields"` @since v3.9 */
|
|
1775
|
+
pivotAvailableFields?: string;
|
|
1776
|
+
/** Default: `"All fields are in use."` @since v3.9 */
|
|
1777
|
+
pivotAllFieldsInUse?: string;
|
|
1778
|
+
/** Default: `"Row"` @since v3.9 */
|
|
1779
|
+
pivotAddRow?: string;
|
|
1780
|
+
/** Default: `"Col"` @since v3.9 */
|
|
1781
|
+
pivotAddColumn?: string;
|
|
1782
|
+
/** Default: `"Val"` @since v3.9 */
|
|
1783
|
+
pivotAddValue?: string;
|
|
1784
|
+
/** Default: `"Add to Row Fields"` @since v3.9 */
|
|
1785
|
+
pivotAddRowTooltip?: string;
|
|
1786
|
+
/** Default: `"Add to Column Fields"` @since v3.9 */
|
|
1787
|
+
pivotAddColumnTooltip?: string;
|
|
1788
|
+
/** Default: `"Add to Value Fields"` @since v3.9 */
|
|
1789
|
+
pivotAddValueTooltip?: string;
|
|
1790
|
+
/** Default: `` (h) => `Add ${h} to Row Fields` `` @since v3.9 */
|
|
1791
|
+
pivotAddRowLabel?: (header: string) => string;
|
|
1792
|
+
/** Default: `` (h) => `Add ${h} to Column Fields` `` @since v3.9 */
|
|
1793
|
+
pivotAddColumnLabel?: (header: string) => string;
|
|
1794
|
+
/** Default: `` (h) => `Add ${h} to Value Fields` `` @since v3.9 */
|
|
1795
|
+
pivotAddValueLabel?: (header: string) => string;
|
|
1796
|
+
/** Panel title and `aria-label`. Default: `"Ask AI"` @since v3.9 */
|
|
1797
|
+
aiAssistantTitle?: string;
|
|
1798
|
+
/** `aria-label` of the close button. Default: `"Close"` @since v3.9 */
|
|
1799
|
+
aiAssistantClose?: string;
|
|
1800
|
+
/** `aria-label` of the prompt input. Default: `"Prompt"` @since v3.9 */
|
|
1801
|
+
aiAssistantPromptLabel?: string;
|
|
1802
|
+
/** Placeholder of the prompt input; `aiAssistant.placeholder` wins. Default: `"Ask about this table…"` @since v3.9 */
|
|
1803
|
+
aiAssistantPlaceholder?: string;
|
|
1804
|
+
/** Default: `"Dictate a prompt"` @since v3.9 */
|
|
1805
|
+
aiAssistantStartDictation?: string;
|
|
1806
|
+
/** Default: `"Stop dictation"` @since v3.9 */
|
|
1807
|
+
aiAssistantStopDictation?: string;
|
|
1808
|
+
/** Default: `"Ask"` @since v3.9 */
|
|
1809
|
+
aiAssistantAsk?: string;
|
|
1810
|
+
/** Default: `"Stop"` @since v3.9 */
|
|
1811
|
+
aiAssistantStop?: string;
|
|
1812
|
+
/** Default: `"Suggestions"` @since v3.9 */
|
|
1813
|
+
aiAssistantSuggestions?: string;
|
|
1814
|
+
/** Default: `"Applied changes"` @since v3.9 */
|
|
1815
|
+
aiAssistantAppliedChanges?: string;
|
|
1816
|
+
/** `aria-label` of a chip's remove button. Default: `` (label) => `Remove ${label}` `` @since v3.9 */
|
|
1817
|
+
aiAssistantRemoveChange?: (label: string) => string;
|
|
1818
|
+
/** Default: `"Undo"` @since v3.9 */
|
|
1819
|
+
aiAssistantUndo?: string;
|
|
1820
|
+
/** `aria-label` of the ignored list. Default: `"Ignored"` @since v3.9 */
|
|
1821
|
+
aiAssistantIgnored?: string;
|
|
1822
|
+
/** An ignored item. Default: `` (message) => `Ignored: ${message}` `` @since v3.9 */
|
|
1823
|
+
aiAssistantIgnoredItem?: (message: string) => string;
|
|
1824
|
+
/** Default: `"Earlier"` @since v3.9 */
|
|
1825
|
+
aiAssistantEarlier?: string;
|
|
1826
|
+
/** Status while a request runs. Default: `"Thinking…"` @since v3.9 */
|
|
1827
|
+
aiAssistantThinking?: string;
|
|
1828
|
+
/** Default: `"Stopped"` @since v3.9 */
|
|
1829
|
+
aiAssistantStopped?: string;
|
|
1830
|
+
/** Default: `"Undone"` @since v3.9 */
|
|
1831
|
+
aiAssistantUndone?: string;
|
|
1832
|
+
/** Default: `"Change removed"` @since v3.9 */
|
|
1833
|
+
aiAssistantChangeRemoved?: string;
|
|
1834
|
+
/**
|
|
1835
|
+
* Status after a reply. Receives the applied and ignored counts. Default: `"No changes"`,
|
|
1836
|
+
* `"Applied 1 change"`, `"Applied 3 changes, 1 ignored"` @since v3.9
|
|
1837
|
+
*/
|
|
1838
|
+
aiAssistantApplied?: (applied: number, ignored: number) => string;
|
|
1839
|
+
/** Status when a reply was not validated. Default: `"The reply was not validated"` @since v3.9 */
|
|
1840
|
+
aiAssistantNotValidated?: string;
|
|
1841
|
+
/** Status when the request failed. Default: `` (m) => `The assistant could not answer: ${m}` `` @since v3.9 */
|
|
1842
|
+
aiAssistantFailed?: (message: string) => string;
|
|
1843
|
+
/** Error text when a failed request has no message. Default: `"Unknown error"` @since v3.9 */
|
|
1844
|
+
aiAssistantUnknownError?: string;
|
|
1845
|
+
/** `aria-label` of the pagination bar. Default: `"Pagination"` @since v3.9 */
|
|
1846
|
+
paginationLabel?: string;
|
|
1847
|
+
/** Default: `"Go to first page"` @since v3.9 */
|
|
1848
|
+
paginationFirstPageLabel?: string;
|
|
1849
|
+
/** Default: `"First page"` @since v3.9 */
|
|
1850
|
+
paginationFirstPageTooltip?: string;
|
|
1851
|
+
/** Default: `"Go to previous page"` @since v3.9 */
|
|
1852
|
+
paginationPreviousPageLabel?: string;
|
|
1853
|
+
/** Default: `"Previous page"` @since v3.9 */
|
|
1854
|
+
paginationPreviousPageTooltip?: string;
|
|
1855
|
+
/** Default: `"Go to next page"` @since v3.9 */
|
|
1856
|
+
paginationNextPageLabel?: string;
|
|
1857
|
+
/** Default: `"Next page"` @since v3.9 */
|
|
1858
|
+
paginationNextPageTooltip?: string;
|
|
1859
|
+
/** Default: `"Go to last page"` @since v3.9 */
|
|
1860
|
+
paginationLastPageLabel?: string;
|
|
1861
|
+
/** Default: `"Last page"` @since v3.9 */
|
|
1862
|
+
paginationLastPageTooltip?: string;
|
|
1863
|
+
/** Default: `"Count"` @since v3.9 */
|
|
1864
|
+
cellSelectionStatsCount?: string;
|
|
1865
|
+
/** Default: `"Sum"` @since v3.9 */
|
|
1866
|
+
cellSelectionStatsSum?: string;
|
|
1867
|
+
/** Default: `"Average"` @since v3.9 */
|
|
1868
|
+
cellSelectionStatsAverage?: string;
|
|
1548
1869
|
}
|
|
1549
1870
|
|
|
1550
1871
|
/**
|
|
@@ -1909,6 +2230,14 @@ export declare interface GridThemeGrid {
|
|
|
1909
2230
|
pinnedRightShadow?: string;
|
|
1910
2231
|
checkboxBg?: string;
|
|
1911
2232
|
checkboxBorder?: string;
|
|
2233
|
+
/** Fill and border of a checked or indeterminate checkbox (`--ogx-checkbox-checked-bg`). Default: the primary colour. @since v3.9 */
|
|
2234
|
+
checkboxCheckedBackground?: string;
|
|
2235
|
+
/** The check mark and indeterminate dash (`--ogx-checkbox-checkmark`). Default: white. @since v3.9 */
|
|
2236
|
+
checkboxCheckmark?: string;
|
|
2237
|
+
/** The expand / collapse chevron of group and tree rows (`--ogx-expand-icon-color`). Default: the header text colour. @since v3.9 */
|
|
2238
|
+
expandIconColor?: string;
|
|
2239
|
+
/** The chevron on hover (`--ogx-expand-icon-hover-color`). Default: the row text colour. @since v3.9 */
|
|
2240
|
+
expandIconHoverColor?: string;
|
|
1912
2241
|
}
|
|
1913
2242
|
|
|
1914
2243
|
export declare interface GridThemeOverlays {
|
|
@@ -1922,6 +2251,16 @@ export declare interface GridThemeOverlays {
|
|
|
1922
2251
|
itemSelectedText?: string;
|
|
1923
2252
|
itemDangerBackground?: string;
|
|
1924
2253
|
itemDangerText?: string;
|
|
2254
|
+
/** The dot before the selected option of a menu group (`--ogx-overlay-item-indicator`). Default: `itemSelectedText`. @since v3.9 */
|
|
2255
|
+
itemIndicatorColor?: string;
|
|
2256
|
+
/** The icon of the selected option (`--ogx-overlay-item-selected-icon`). Default: the primary colour. @since v3.9 */
|
|
2257
|
+
itemSelectedIcon?: string;
|
|
2258
|
+
/** Menu item icons (`--ogx-overlay-icon`). Default: gray-400. @since v3.9 */
|
|
2259
|
+
iconColor?: string;
|
|
2260
|
+
/** Section labels such as "Pin column" (`--ogx-overlay-section-label-text`). Default: gray-400. @since v3.9 */
|
|
2261
|
+
sectionLabelText?: string;
|
|
2262
|
+
/** Lines between menu sections (`--ogx-overlay-divider`). Default: `border`. @since v3.9 */
|
|
2263
|
+
dividerColor?: string;
|
|
1925
2264
|
/** Font of column menus, header filter menus, toolbar panels and the AI panel (`--ogx-overlay-font-family`). Default: the grid font. @since v3.7 */
|
|
1926
2265
|
fontFamily?: string;
|
|
1927
2266
|
/** Weight of menu items and panel labels (`--ogx-overlay-font-weight`). Default: each item's own weight (400, labels 500). @since v3.7 */
|
|
@@ -1998,7 +2337,7 @@ export declare interface GridThemeTypography {
|
|
|
1998
2337
|
fontSizeXl?: string;
|
|
1999
2338
|
}
|
|
2000
2339
|
|
|
2001
|
-
export declare function GridToolbar({ columns, baseColumns, aggregationModel, onAggregationModelChange, pivotModel, onPivotModelChange, filterModel, onFilterModelChange, columnVisibilityModel, onColumnVisibilityModelChange, onColumnReorder, onColumnOrderReset, forceColumnsOpen, onColumnsPanelClose, forceFiltersOpen, onFiltersPanelClose, children, rightContent, style, renderColumnsButton, renderFilterButton, renderAggregationButton, renderExportButton, renderQuickFilter, className, showNonHideableColumns, onAiAssistantToggle, aiAssistantOpen, aiAssistantLabel, }: GridToolbarProps): JSX.Element;
|
|
2340
|
+
export declare function GridToolbar({ columns, baseColumns, aggregationModel, onAggregationModelChange, pivotModel, onPivotModelChange, filterModel, onFilterModelChange, columnVisibilityModel, onColumnVisibilityModelChange, onColumnReorder, onColumnOrderReset, forceColumnsOpen, onColumnsPanelClose, forceFiltersOpen, onFiltersPanelClose, children, rightContent, style, renderColumnsButton, renderFilterButton, renderAggregationButton, renderExportButton, renderQuickFilter, className, showNonHideableColumns, onAiAssistantToggle, aiAssistantOpen, aiAssistantLabel: aiAssistantLabelProp, }: GridToolbarProps): JSX.Element;
|
|
2002
2341
|
|
|
2003
2342
|
export declare interface GridToolbarProps {
|
|
2004
2343
|
columns?: GridColDef[];
|