Skip to content
This repository was archived by the owner on Jun 28, 2026. It is now read-only.

Commit 61188d6

Browse files
author
GitHub Actions Bot
committed
Update API doc
1 parent 65c537c commit 61188d6

1 file changed

Lines changed: 45 additions & 0 deletions

File tree

components/doc/common/apidoc/index.json

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16597,6 +16597,30 @@
1659716597
"default": "960px",
1659816598
"description": "The breakpoint to define the maximum width boundary when using stack responsive layout."
1659916599
},
16600+
{
16601+
"name": "cellMemo",
16602+
"optional": true,
16603+
"readonly": false,
16604+
"type": "boolean",
16605+
"default": "true",
16606+
"description": "Whether to enable cell memoization.\n\nWhen the memoization is enabled, be sure to:\n 1- Update the value prop (i.e., row data) to trigger a re-render of the cells of a given row.\n 2- Where necessary, use the spread operator (...) when updating the value prop objs which creates new fresh\n objects and avoids mutating the same objects.\n\nWhen the memoization is disabled, a re-render of the datatable will trigger a re-render of all cells, which can\nlead to performance issues with large datasets and is therefore not recommended."
16607+
},
16608+
{
16609+
"name": "cellMemoProps",
16610+
"optional": true,
16611+
"readonly": false,
16612+
"type": "string[]",
16613+
"default": "['rowData', 'field', 'allowCellSelection', 'isCellSelected', 'editMode', 'index', 'tabIndex',\n'editing', 'expanded', 'editingMeta', 'frozenCol', 'alignFrozenCol']",
16614+
"description": "The cell props to be checked at memoization.\n\nPossible cell props are:\n 'hostName', 'allowCellSelection', 'cellMemo', 'cellMemoProps', 'cellMemoPropsDepth', 'cellClassName', 'checkIcon', 'collapsedRowIcon',\n 'field', 'resolveFieldData', 'column', 'cProps', 'dataKey', 'editMode', 'editing', 'editingMeta', 'onEditingMetaChange', 'editingKey',\n 'getEditingRowData', 'expanded', 'expandedRowIcon', 'frozenRow', 'frozenCol', 'alignFrozenCol', 'index', 'isSelectable', 'onCheckboxChange',\n 'onClick', 'onMouseDown', 'onMouseUp', 'onRadioChange', 'onRowEditCancel', 'onRowEditInit', 'onRowEditSave', 'onRowToggle', 'responsiveLayout',\n 'rowData', 'rowEditorCancelIcon', 'rowEditorInitIcon', 'rowEditorSaveIcon', 'rowIndex', 'rowSpan', 'selectOnEdit', 'isRowSelected', 'isCellSelected',\n 'selectionAriaLabel', 'showRowReorderElement', 'showSelectionElement', 'tabIndex', 'getTabIndex', 'tableProps', 'tableSelector', 'value',\n 'getVirtualScrollerOption', 'ptCallbacks', 'metaData', 'unstyled', 'findNextSelectableCell', 'findPrevSelectableCell', 'findDownSelectableCell',\n 'findUpSelectableCell', 'focusOnElement', 'focusOnInit', 'updateStickyPosition'\n\nIMPORTANT: Including a function to be checked will in general disable the memoization in practice, since functions are\ncompared by reference."
16615+
},
16616+
{
16617+
"name": "cellMemoPropsDepth",
16618+
"optional": true,
16619+
"readonly": false,
16620+
"type": "number",
16621+
"default": "1",
16622+
"description": "The comparison depth when checking cell props (e.g., rowData) at memoization."
16623+
},
1660016624
{
1660116625
"name": "cellSelection",
1660216626
"optional": true,
@@ -19664,6 +19688,27 @@
1966419688
"type": "string",
1966519689
"description": "The breakpoint to define the maximum width boundary when using stack responsive layout."
1966619690
},
19691+
{
19692+
"name": "cellMemo",
19693+
"optional": true,
19694+
"readonly": false,
19695+
"type": "boolean",
19696+
"description": "Whether to enable cell memoization.\n\nWhen the memoization is enabled, be sure to:\n 1- Update the value prop (i.e., row data) to trigger a re-render of the cells of a given row.\n 2- Where necessary, use the spread operator (...) when updating the value prop objs which creates new fresh\n objects and avoids mutating the same objects.\n\nWhen the memoization is disabled, a re-render of the datatable will trigger a re-render of all cells, which can\nlead to performance issues with large datasets and is therefore not recommended."
19697+
},
19698+
{
19699+
"name": "cellMemoProps",
19700+
"optional": true,
19701+
"readonly": false,
19702+
"type": "string[]",
19703+
"description": "The cell props to be checked at memoization.\n\nPossible cell props are:\n 'hostName', 'allowCellSelection', 'cellMemo', 'cellMemoProps', 'cellMemoPropsDepth', 'cellClassName', 'checkIcon', 'collapsedRowIcon',\n 'field', 'resolveFieldData', 'column', 'cProps', 'dataKey', 'editMode', 'editing', 'editingMeta', 'onEditingMetaChange', 'editingKey',\n 'getEditingRowData', 'expanded', 'expandedRowIcon', 'frozenRow', 'frozenCol', 'alignFrozenCol', 'index', 'isSelectable', 'onCheckboxChange',\n 'onClick', 'onMouseDown', 'onMouseUp', 'onRadioChange', 'onRowEditCancel', 'onRowEditInit', 'onRowEditSave', 'onRowToggle', 'responsiveLayout',\n 'rowData', 'rowEditorCancelIcon', 'rowEditorInitIcon', 'rowEditorSaveIcon', 'rowIndex', 'rowSpan', 'selectOnEdit', 'isRowSelected', 'isCellSelected',\n 'selectionAriaLabel', 'showRowReorderElement', 'showSelectionElement', 'tabIndex', 'getTabIndex', 'tableProps', 'tableSelector', 'value',\n 'getVirtualScrollerOption', 'ptCallbacks', 'metaData', 'unstyled', 'findNextSelectableCell', 'findPrevSelectableCell', 'findDownSelectableCell',\n 'findUpSelectableCell', 'focusOnElement', 'focusOnInit', 'updateStickyPosition'\n\nIMPORTANT: Including a function to be checked will in general disable the memoization in practice, since functions are\ncompared by reference."
19704+
},
19705+
{
19706+
"name": "cellMemoPropsDepth",
19707+
"optional": true,
19708+
"readonly": false,
19709+
"type": "number",
19710+
"description": "The comparison depth when checking cell props (e.g., rowData) at memoization."
19711+
},
1966719712
{
1966819713
"name": "checkIcon",
1966919714
"optional": true,

0 commit comments

Comments
 (0)