NEURALNG

PUBLIC CONTRACT

Table API

The Beta contract includes the complete Alpha feature surface and its typed helper APIs.

Inputs and models

NameTypeDefaultPurpose
valuereadonly T[][] Rows supplied to the table.
columnsreadonly NeuralTableColumn<T>[]required Typed leaf-column definitions.
rowKeykeyof T | path | callback | nullnull Stable identity for selection, expansion and remote state.
dataMode'client' | 'remote''client' Controls whether data operations are local or emitted.
stateKey / stateStorage / stateAdapterpersistence inputsnull / local / null Selects built-in or custom state persistence.
groupRowsBykeyof T | path | callback | nullnull Groups rows by a nested value or accessor.
rowGroupMode'subheader' | 'rowspan''subheader' Chooses grouped-row presentation.
expandableRowGroupsbooleanfalse Enables group disclosure controls.
expandedRowGroupKeysmodel<readonly RowKey[]>[] Controlled expanded group keys.
sortMode'single' | 'multiple''single' Sort contract for sortable columns.
selectionMode'none' | 'single' | 'multiple''none' Enables row selection.
selectionControl'auto' | 'checkbox' | 'radio''auto' Visible selection control.
selectAllMode'page' | 'filtered' | 'all''page' Scope of select-all.
selectOnRowClickbooleantrue Allows the row surface to select.
selectableRow(row, index) => boolean() => true Disables individual rows from selection.
selectAllKeysreadonly RowKey[][] Complete remote key scope for filtered/all selection.
sort / filters / globalFiltermodels[] / [] / null Controlled data-operation state.
selection / selectionKeysmodels[] Controlled row and key selection.
expandedRowKeysmodel<readonly RowKey[]>[] Controlled row expansion.
columnWidths / hiddenColumnIds / columnOrdermodels{} / [] / [] Controlled column layout.
headerGroups / footerGroupsreadonly NeuralTableHeaderGroup[][] Nested grouped header and footer definitions.
pageIndex / pageSizenumber models0 / 10 Controlled paging state.
paginate / totalItemsboolean / number | nullfalse / null Client slicing and remote result count.
editMode / editValidatorcell | row | null / callbacknull Editing mode and sync/async validation.
loading / loadingMode / loadingRowsstate inputsfalse / 'message' / 5 Loading message or skeleton rows.
errorstring | nullnull Error state message.
disabledbooleanfalse Disables interactive table behavior.
striped / hoverable / gridlinesbooleanfalse / true / false Visual row and grid variants.
stickyHeader / stickyFooterbooleanfalse Pins table edge sections in a scroll surface.
scrollHeightstring'' Constrains the scroll viewport block size.
resizableColumns / reorderableColumnsbooleanfalse Enables pointer and keyboard column layout.
columnResizeMode'fit' | 'expand''fit' Determines adjacent-width behavior.
minColumnWidth / columnResizeStepnumber64 / 8 Resize constraints in CSS pixels.
filterDelaynumber250 Text/number filter debounce in milliseconds.
density'compact' | 'comfortable' | 'spacious''comfortable' Semantic row-density preset.
captionstring'' Native table caption.
ariaLabel / ariaLabelledby / ariaDescribedbystring'' Accessible table naming and description.
labelsPartial<NeuralTableLabels>{} Component-level localized copy override.
unstyled / tableClass / classesheadless inputsfalse / empty / {} Visual ownership and additive classes.

Outputs

sortEvent / filterEventsort and filter events

Detailed user data-operation events.

selectionEventNeuralTableSelectionChange<T>

Selection rows, keys, reason and native event.

rowSelect / rowUnselectNeuralTableRowEvent<T>

Semantic row selection lifecycle.

rowClick / rowDoubleClickNeuralTableRowEvent<T>

Native row activation details.

expansionChange / rowGroupExpansionChangeexpansion events

Row and group disclosure changes.

columnResize / columnVisibilityChange / columnReordercolumn events

Controlled layout changes.

stateChange / stateRestorestate events

Serializable state requests and restoration.

cellEditStart / Complete / CancelNeuralTableEditEvent<T>

Cell editing lifecycle.

rowEditStart / Save / CancelNeuralTableRowEditEvent<T>

Row editing lifecycle.

Typed templates

neuralTableCell="id"

Typed body cell context.

neuralTableEditor="id"

Draft editor with setValue, save and cancel.

neuralTableHeader="id"

Leaf-column header.

neuralTableHeaderGroup="id"

Resolved grouped header.

neuralTableFilter="id"

Column filter control and apply/clear callbacks.

neuralTableFooter="id"

Leaf-column footer.

neuralTableFooterGroup="id"

Resolved grouped footer.

neuralTableExpansion

Expanded row content.

neuralTableGroupHeader

Row-group header and aggregate helper.

neuralTableGroupFooter

Row-group footer and aggregate helper.

neuralTableLoading

Custom loading state.

neuralTableEmpty

Custom empty state.

neuralTableError

Custom error state.

Public methods

clearFilters(includeGlobal?)

Clears filter state.

setFilters(filters, global?)

Replaces controlled filters.

setPage(index, size?)

Updates controlled paging.

startCellEdit / startRowEdit

Begins a typed draft.

saveEdit / cancelEdit

Commits validation or restores source data.

setColumnVisibility / toggleColumnVisibility / showAllColumns

Controls visible columns.

captureState / serializeState / restoreState

Creates and restores versioned JSON-safe state.

clearStoredState()

Removes the configured persistence snapshot.

isLatestRequest(id)

Rejects stale remote responses.

Column contract

id, header, field, valueAccessor, formatter
sortable, resizable, reorderable
filterable, filterType, filterMatchMode, filterOptions
align, width, minWidth, maxWidth, hidden, sticky
headerClass, cellClass, footer
editable, readOnly, disabled

Typed class slots

root, scroll, table, caption
header, headerRow, headerCell, headerGroupRow, headerGroupCell
filterRow, filterCell, filterControl, filterRange
sortButton, sortIcon, resizeHandle, reorderHandle, dropIndicator
body, row, selectedRow, disabledRow, focusedRow, cell
editableCell, editingCell, readOnlyCell, disabledCell, editor, editError, editingRow
selectionCell, selectionControl, expansionCell, expansionButton, expansionRow, expansionContent
groupHeaderRow, groupHeaderCell, groupToggle, groupFooterRow, groupFooterCell
stateRow, stateCell, loading, skeletonRow, skeletonCell, skeletonLine, empty, error
footer, footerRow, footerCell, footerGroupRow, footerGroupCell

Public types

NeuralTableColumn<T>, NeuralTableClasses, NeuralTableLabels
NeuralTableSort, NeuralTableFilter and match/filter types
Selection, row, expansion and grouping events/contexts
Cell/row editor events, contexts and validators
Column order, width, resize, visibility and reorder contracts
Versioned state, storage, adapter, restore and request state
Header/footer group definitions and template contexts

Pure utilities

resolveNeuralTablePath / resolveNeuralTableValue
compareNeuralTableValues / sortNeuralTableRows
matchesNeuralTableFilter / filterNeuralTableRows
paginateNeuralTableRows
aggregateNeuralTableValues / aggregateNeuralTableRows
serializeNeuralTableState / parseNeuralTableState

Legacy alias

TableComponent remains available for compatibility. New human and AI-generated code should import NeuralTable.