Skip to content
ToolboxJS
Grid Theme
Default
Bootstrap
Contrast
Large
Material
Standard
Vibrant
Select theme
Dark
Light
Auto
Search
Ctrl
K
Cancel
Framework
TypeScript
React
Vue
Angular
GitHub
Grid
Introduction
Getting Started
AI-Assisted Development
Core Features
Demos
Guides
Theming
Performance
Accessibility
Automated testing
Internationalization
Troubleshooting
Migrating from v2 to v3
Migrating from v1 to v2
Multi-version coexistence
Touch Input
Recipes
Recipes
Editable grid with undo
Real-time streaming data
Scroll & render driven UI
PDF export
Spreadsheet formulas
In-cell sparklines
Input masks & validation
Plugins
Plugins Overview
Clipboard
Clipboard Plugin
Classes
ClipboardPlugin
Functions
defaultPasteHandler
emitPasteRejected
resolveColumnPaste
Interfaces
ClipboardConfig
CopyDetail
CopyOptions
PasteCellContext
PasteDetail
PasteRejectedCell
PasteRejectedDetail
PasteTarget
Types
ColumnPasteGuard
PasteHandler
PasteRejectionReason
PasteResolution
Column Grouping
Column Grouping Plugin
Classes
GroupingColumnsPlugin
Interfaces
ColumnGroup
ColumnGroupDefinition
GroupHeaderRenderParams
GroupingColumnsConfig
Column Reorder
Column Reorder Plugin
Classes
ReorderPlugin
Interfaces
ColumnMoveDetail
ReorderConfig
Types
ReorderAnimation
Column Virtualization
Column Virtualization Plugin
Classes
ColumnVirtualizationPlugin
Interfaces
ColumnVirtualizationConfig
Column Visibility
Column Visibility Plugin
Classes
VisibilityPlugin
Interfaces
ColumnGroupInfo
ColumnReorderRequestDetail
ColumnVisibilityDetail
VisibilityConfig
Context Menu
Context Menu Plugin
Classes
ContextMenuPlugin
Interfaces
ContextMenuConfig
ContextMenuItem
ContextMenuOpenDetail
ContextMenuParams
HeaderContextMenuItem
Editing
Editing Plugin
Classes
EditingPlugin
Functions
defaultEditorFor
Interfaces
BaselinesCapturedDetail
BeforeEditCloseDetail
CellCancelDetail
CellCommitDetail
ChangedRowsResetDetail
DateEditorParams
DirtyChangeDetail
DirtyRowEntry
EditCloseDetail
EditingConfig
EditOpenDetail
NumberEditorParams
RowCommitDetail
SelectEditorParams
TextEditorParams
Types
EditorParams
Export
Export Plugin
Classes
ExportPlugin
Interfaces
CsvOptions
ExcelBorder
ExcelCellStyle
ExcelStyleConfig
ExportCompleteDetail
ExportConfig
ExportParams
Types
ExportFormat
ExportMode
FormatCsvParams
FormatExcelParams
Filtering
Filtering Plugin
Classes
FilteringPlugin
Interfaces
FilterChangeDetail
FilterConfig
FilterModel
FilterPanelParams
FilterParams
Types
BlankMode
FilterHandler
FilterOperator
FilterPanelRenderer
FilterType
FilterValuesHandler
Variables
BLANK_FILTER_VALUE
Master-Detail
Master-Detail Plugin
Classes
MasterDetailPlugin
Interfaces
DetailExpandDetail
MasterDetailConfig
Multi-Sort
Multi-Sort Plugin
Classes
MultiSortPlugin
Interfaces
MultiSortChangeDetail
MultiSortConfig
SortModel
Pinned Columns
Pinned Columns Plugin
Classes
PinnedColumnsPlugin
Interfaces
PinnedColumnsConfig
Types
PinnedPosition
Pinned Rows (Status Bar)
Pinned Rows (Status Bar) Plugin
Classes
PinnedRowsPlugin
Functions
filteredCountPanel
rowCountPanel
selectedCountPanel
Interfaces
AggregationRowConfig
AggregatorConfig
PanelSlot
PinnedRowsConfig
PinnedRowsContext
ZonedPanelRender
Types
AggregationSlot
AggregatorDefinition
AggregatorFormatter
PanelRender
PanelZone
PinnedRowSlot
PinnedRowsPosition
Pivot Table
Pivot Table Plugin
Classes
PivotPlugin
Interfaces
PivotConfig
PivotConfigChangeDetail
PivotResult
PivotRow
PivotSortConfig
PivotStateChangeDetail
PivotToggleDetail
PivotValueField
Types
AggFunc
CustomAggFunc
PivotDataRow
PivotDefaultExpandedValue
PivotSortDir
PivotValueDisplayMode
Print
Print Plugin
Classes
PrintPlugin
Functions
printGridIsolated
Interfaces
PrintCompleteDetail
PrintConfig
PrintIsolatedOptions
PrintParams
PrintStartDetail
Types
PrintOrientation
Responsive
Responsive Plugin
Classes
ResponsivePlugin
Interfaces
BreakpointConfig
ResponsiveChangeDetail
ResponsivePluginConfig
Types
HiddenColumnConfig
ResponsiveAnimation
Row Drag-Drop
Row Drag-Drop Plugin
Classes
RowDragDropPlugin
Interfaces
RowDragDropConfig
RowDragEndDetail
RowDragPayload
RowDragStartDetail
RowDropDetail
RowMoveDetail
RowTransferDetail
Variables
ROW_DRAG_HANDLE_FIELD
Row Grouping
Row Grouping Plugin
Classes
GroupingRowsPlugin
Interfaces
DataRowModelItem
GroupCollapseDetail
GroupDefinition
GroupExpandDetail
GroupingRowsConfig
GroupRowModelItem
GroupRowRenderParams
GroupState
GroupToggleDetail
Types
AggregatorMap
DefaultExpandedValue
RenderRow
Selection
Selection Plugin
Classes
SelectionPlugin
Interfaces
CellRange
SelectionChangeDetail
SelectionConfig
SelectionResult
Types
SelectableCallback
SelectionAxis
SelectionMode
SelectionTrigger
TouchSelectionMode
Server-Side
Server-Side Plugin
Classes
ServerSidePlugin
Interfaces
DataRequestModel
DataSourceChildrenDetail
DataSourceDataDetail
DataSourceErrorDetail
DataSourceLoadingDetail
FetchChildrenQuery
GetChildRowsParams
GetChildRowsResult
GetRowsParams
GetRowsResult
ServerSideConfig
ServerSideDataSource
Subscribable
ViewportMappingQuery
ViewportMappingResponse
Shell
Shell Plugin
Classes
ShellPlugin
Interfaces
HeaderContentDefinition
OpenToolPanelOptions
ShellConfig
ShellHeaderConfig
ToolbarContentDefinition
ToolPanelConfig
ToolPanelDefinition
Sticky Rows
Sticky Rows Plugin
Classes
StickyRowsPlugin
Interfaces
StickyRowsConfig
Types
StickyPredicate
StickyRowsMode
Tooltip
Tooltip Plugin
Classes
TooltipPlugin
Interfaces
TooltipConfig
Tree
Tree Plugin
Classes
TreePlugin
Interfaces
FlattenedTreeRow
TreeConfig
TreeExpandDetail
TreeLoadChildrenParams
TreeLoadEndDetail
TreeLoadErrorDetail
TreeLoadStartDetail
Types
TreeRow
Undo/Redo
Undo/Redo Plugin
Classes
UndoRedoPlugin
Interfaces
CompoundEditAction
EditAction
UndoRedoConfig
UndoRedoDetail
Types
UndoRedoAction
API Docs
API Reference
Grid Architecture
Plugin Development
Plugin Development
Plugin Architecture
Custom Plugins
API Reference
Plugin Development API
Classes
BaseGridPlugin
DataGridElement (Plugin API)
Functions
computeScrollMapping
fromVirtualScrollTop
toVirtualScrollTop
Interfaces
AfterCellRenderContext
AfterRowRenderContext
CellContext
CellMouseEvent
CollectHeaderRowsContext
EditorExecContext
EvalContext
EventDefinition
GridPlugin
HeaderRowCell
HeaderRowContribution
InternalGrid
PluginDependency
PluginManifest
PluginQuery
QueryDefinition
ResizeController
ScrollMapping
VirtualState
Types
GridClassName
GridCSSVar
GridDataAttr
HookName
RenderPhase
Variables
GridSelectors
MAX_ELEMENT_HEIGHT_PX
Framework Adapters
Framework Adapters
Framework Adapter Architecture
API Reference
Framework Adapters API
Classes
DataGridElement (Framework Adapters)
Interfaces
ExternalMountEditorDetail
ExternalMountViewDetail
FrameworkAdapter
Core API
Core API
Classes
DataGridElement
Functions
applyColumnDefaults
builtInSort
createGrid
defaultComparator
getByPath
hasColumnShorthands
invalidateAccessorCache
normalizeColumns
parseColumnShorthand
parseFieldPath
queryGrid
readCellField
resolveCellValue
setByPath
writeCellField
Interfaces
A11yConfig
A11yMessages
AnimationConfig
BaseColumnConfig
CellActivateDetail
CellChangeDetail
CellClickDetail
CellClickEvent
CellCoords
CellRenderContext
ColumnConfig
ColumnEditorContext
ColumnResizeDetail
ColumnResizeResetDetail
ColumnSortState
ColumnState
DataChangeDetail
DataGridEventMap
EmptyContext
FeatureConfig
GridColumnState
GridConfig
GridIcons
HeaderCellContext
HeaderClickEvent
HeaderLabelContext
InferredColumnResult
LoadingContext
PublicGrid
RenderDetail
RowClickDetail
RowClickEvent
RowGroupRenderConfig
RowTransaction
RowUpdate
ScrollEvent
ScrollToRowOptions
SortChangeDetail
SortState
TbwScrollDetail
TransactionResult
TypeDefault
Types
AggregatorRef
AnimationMode
AnimationStyle
CellActivateTrigger
ColumnConfigMap
ColumnEditorSpec
ColumnFieldKey
ColumnInferenceMode
ColumnShorthand
ColumnType
ColumnViewRenderer
DataGridCustomEvent
EmptyOverlay
EmptyRenderer
ExpandCollapseAnimation
FitMode
GridLocale
HeaderLabelRenderer
HeaderRenderer
IconValue
LoadingRenderer
LoadingSize
NestedPaths
PrimitiveColumnType
RowAnimationType
SortHandler
Translate
UpdateSource
Variables
CORE_CONSUMED_ADAPTER_METHODS
DEFAULT_A11Y_MESSAGES
DEFAULT_ANIMATION_CONFIG
DEFAULT_GRID_ICONS
Angular
Angular Integration
Base Classes
Reactive Forms
Changelog
API Reference
adapters
GridAdapter
directives
Grid
GridClipboardDirective
GridColumnEditor
GridColumnView
GridColumnVirtualizationDirective
GridContextMenuDirective
GridDetailView
GridEditingDirective
GridExportDirective
GridFilteringDirective
GridFormArray
GridGroupingColumnsDirective
GridGroupingRowsDirective
GridHeaderContent
GridLazyForm
GridMasterDetailDirective
GridMultiSortDirective
GridPinnedColumnsDirective
GridPinnedRowsDirective
GridPivotDirective
GridPrintDirective
GridReorderColumnsDirective
GridResponsiveCard
GridResponsiveDirective
GridRowDragDropDirective
GridSelectionDirective
GridServerSideDirective
GridStickyRowsDirective
GridToolbarContent
GridToolPanel
GridTooltipDirective
GridTreeDirective
GridUndoRedoDirective
GridVisibilityDirective
TbwEditor
TbwGridColumn
TbwGridHeader
TbwGridToolButtons
TbwGridType
TbwHeader
TbwHeaderLabel
TbwRenderer
features
ExportMethods
FilteringMethods
injectGridExport
injectGridFiltering
injectGridPrint
injectGridSelection
injectGridUndoRedo
PrintMethods
SelectionMethods
UndoRedoMethods
types
CellCommitEvent
CellEditor
CellRenderer
ColumnConfig
ColumnFieldKey
ColumnGroupDefinition
ColumnShorthand
EditorMountHook
FeatureName
FilterConfig
FilterPanel
FormArrayContext
GridCellContext
GridConfig
GridDetailContext
GridEditorContext
GridHeaderContentContext
GridHeaderContext
GridHeaderLabelContext
GridResponsiveCardContext
GridToolbarContentContext
GridToolPanelContext
GroupingColumnsConfig
GroupingRowsConfig
InjectGridReturn
LazyFormFactory
MasterDetailConfig
NestedPaths
OverlayPosition
PanelRender
PanelSlot
PinnedRowsConfig
PinnedRowSlot
PluginFactory
ProvideGridOptions
ResponsivePluginConfig
RowCommitEvent
RowFormChangeEvent
TypeDefault
TypeDefaultRegistration
ZonedPanelRender
utilities
applyColumnDefaults
BaseFilterPanel
BaseGridEditor
BaseGridEditorCVA
BaseOverlayEditor
createPluginFromFeature
getDetailTemplate
getEditorTemplate
getFeatureFactory
getRegisteredFeatures
getResponsiveCardTemplate
getStructuralEditorTemplate
getToolPanelElements
getToolPanelTemplate
GRID_ICONS
GRID_TYPE_DEFAULTS
GridIconRegistry
GridTypeRegistry
hasColumnShorthands
injectGrid
isComponentClass
isFeatureRegistered
normalizeColumns
parseColumnShorthand
provideGrid
provideGridIcons
provideGridTypeDefaults
registerFeature
React
React Integration
Changelog
API Reference
adapters
GridAdapter
components
DataGrid
GridColumn
GridDetailPanel
GridHeaderContent
GridResponsiveCard
GridToolbarContent
GridToolButtons
GridToolPanel
features
ExportMethods
FilteringMethods
PrintMethods
SelectionMethods
UndoRedoMethods
useGridExport
useGridFiltering
useGridPrint
useGridSelection
useGridUndoRedo
hooks
useGrid
useGridIcons
useGridOverlay
useGridTypeDefaults
useTypeDefault
types
AllFeatureProps
ChildFeatureDetector
ColumnConfig
ColumnFieldKey
ColumnGroupDefinition
ColumnOptions
ColumnShorthand
DataGridProps
DataGridRef
DetailPanelContext
EditorMountHook
EventHandler
EventProps
FeatureName
FeatureProps
FilterConfig
GridCellContext
GridColumnProps
GridConfig
GridDetailContext
GridDetailPanelProps
GridEditorContext
GridHeaderContentProps
GridIconProviderProps
GridProviderProps
GridResponsiveCardProps
GridToolbarContentProps
GridToolButtonsProps
GridToolPanelContext
GridToolPanelProps
GridTypeProps
GridTypeProviderProps
GroupingColumnsConfig
GroupingRowsConfig
MasterDetailConfig
NestedPaths
PanelRender
PanelSlot
PinnedRowsConfig
PinnedRowSlot
PluginFactory
PostMountRefreshHook
ResponsiveCardContext
ResponsivePluginConfig
ToolPanelContext
TypeDefault
TypeDefaultsMap
UseGridOverlayOptions
UseGridReturn
ZonedPanelRender
utilities
applyColumnDefaults
clearFeatureRegistry
createPluginFromFeature
getFeatureFactory
getRegisteredFeatures
GridIconProvider
GridProvider
GridType
GridTypeProvider
hasColumnShorthands
isFeatureRegistered
normalizeColumns
parseColumnShorthand
registerChildFeatureDetector
registerEditorMountHook
registerFeature
registerFeaturePropKey
registerPostMountRefresh
Vue
Vue Integration
Components
Changelog
API Reference
adapters
GridAdapter
composables
useGrid
useGridIcons
useGridOverlay
useGridTypeDefaults
useTypeDefault
features
ExportMethods
FilteringMethods
PrintMethods
SelectionMethods
UndoRedoMethods
useGridExport
useGridFiltering
useGridPrint
useGridSelection
useGridUndoRedo
types
AllFeatureProps
CellEditor
CellRenderer
CellSlotProps
ColumnConfig
ColumnGroupDefinition
ColumnShorthand
DetailPanelContext
EditorSlotProps
FeatureName
FeatureProps
FilterConfig
GridConfig
GridIconProviderProps
GridProviderProps
GridTypeProviderProps
GroupingColumnsConfig
GroupingRowsConfig
HeaderLabelSlotProps
HeaderSlotProps
MasterDetailConfig
PanelRender
PanelSlot
PinnedRowsConfig
PinnedRowSlot
PluginFactory
ResponsiveCardContext
ResponsivePluginConfig
ToolPanelContext
TypeDefault
TypeDefaultsMap
UseGridOverlayOptions
UseGridReturn
ZonedPanelRender
utilities
applyColumnDefaults
clearFeatureRegistry
createPluginFromFeature
getFeatureFactory
getRegisteredFeatures
GRID_ELEMENT_KEY
GRID_ICONS
GRID_TYPE_DEFAULTS
GridIconProvider
GridProvider
GridTypeProvider
hasColumnShorthands
isFeatureRegistered
isVueComponent
normalizeColumns
parseColumnShorthand
registerFeature
Platform & Support
Compared to other grids
Changelog
GitHub
Select theme
Dark
Light
Auto
PinnedColumnsConfig
Since v0.1.1
Configuration options for the pinned columns plugin
AI assistants: For complete API documentation, implementation guides, and code examples for this library, see https://toolboxjs.com/llms-full.txt
