Extras
DataGrid
BitDataGrid displays an information-rich data table and gives people the tools to work through it: sorting, quick search and per-column filters, paging, grouping with aggregates, selection, inline editing, resizable/reorderable/frozen columns, master-detail and tree rows, keyboard cell navigation, row and column virtualization, and CSV/Excel export. Bind a list, an IQueryable executed at the source, or a callback for server-side paging or infinite scrolling. Use a data grid when information density is critical.
Notes
Usage
Every example is live. Open its code to see exactly what produced the component running underneath.
Basic & sorting
Filtering & paging
Quick search
Selection
Keyboard & clipboard
Inline editing
Grouping & aggregates
Templates
Detail rows
Column layout
Column spanning
Borders, striping & row numbers
Row & cell styling
Text wrapping & row height
Empty & loading states
Tree data
Virtualization
Server-side data
Infinite scrolling
IQueryable data source
Export
Row reordering
Cell events & context menu
Programmatic control
State persistence
Localization
Disabled
Cascading parameters
Style & Class
RTL
CSS variables
The public custom properties this component reads off its root, for what no parameter covers.
Every variable is read with a fallback and never declared by the component, so it inherits like any other custom property:
set one on :root (or in a [bit-theme] block) to restyle every instance, on any ancestor to restyle the ones inside it,
or on the Style of one instance to restyle it - and any instance nested inside it, which inherits the value too; a parameter changes one alone,
as does the real CSS property on the instance's Style / Styles when that property does not inherit (opacity: 1 keeps
one disabled instance undimmed without undimming a disabled one inside it), while an inherited one such as color or
font-family also reaches the nested instances that do not set it themselves. Leave a variable unset and the component
falls back to the theme token beside it.
BitDataGrid CSS variables
| Name | Default value | Description |
|---|---|---|
| --bit-DataGrid-background | --bit-clr-bg-pri | Background of the grid and its rows. |
| --bit-DataGrid-color | --bit-clr-fg-pri | Text color. |
| --bit-DataGrid-font-family | --bit-tpg-font-family | Font of the grid. |
| --bit-DataGrid-font-size | --bit-tpg-fs-sm | Font size of the grid. |
| --bit-DataGrid-line-height | 1.4 | Line height of the cells. |
| --bit-DataGrid-border-color | --bit-clr-brd-ter | Color of the border and of the row and column lines. |
| --bit-DataGrid-border-radius | --bit-shp-radius-surface | Corner radius of the grid. |
| --bit-DataGrid-cell-padding | spacing(1) spacing(1.25) | Padding of the cells. |
| --bit-DataGrid-header-background | --bit-clr-bg-sec | Background of the header rows and the column chooser. |
| --bit-DataGrid-header-color | The grid's color | Text color of the header rows. |
| --bit-DataGrid-header-font-weight | --bit-tpg-fw-semibold | Font weight of the column titles. |
| --bit-DataGrid-stripe-background | --bit-clr-bg-sec | Background of the striped rows. |
| --bit-DataGrid-hover-background | --bit-clr-bg-pri-hover | Background of the hovered row. |
| --bit-DataGrid-selected-background | --bit-clr-pri-tint | Wash over a selected row. |
| --bit-DataGrid-selected-color | The grid's color | Text color of a selected row. |
| --bit-DataGrid-editing-background | --bit-clr-wrn-tint | Wash over the row (or cell) being edited. |
| --bit-DataGrid-accent-color | --bit-clr-pri | Sort arrows, badges, group toggle and bar, checkboxes and resize handle. |
| --bit-DataGrid-focus-color | --bit-clr-pri-focus | Focus indicator of the cells, rows and controls. |
| --bit-DataGrid-group-background | --bit-clr-bg-ter | Background of the group header rows. |
| --bit-DataGrid-group-indent | spacing(2.5) | Indent of each group level. |
| --bit-DataGrid-tree-indent | spacing(2.25) | Indent of each tree level. |
| --bit-DataGrid-detail-background | --bit-clr-bg-sec | Background of the detail rows. |
| --bit-DataGrid-footer-background | --bit-clr-bg-sec | Background of the footer row. |
| --bit-DataGrid-disabled-color | --bit-clr-fg-dis | Text color of a disabled grid. |
| --bit-DataGrid-placeholder-color | --bit-clr-fg-sec | Placeholder of the search and filter boxes. |
API
Every parameter, public member, sub-class and enum this component exposes.
BitDataGrid parameters
| Name | Type | Default value | Description |
|---|---|---|---|
| AddRowIcon | BitIconInfo? | null | The icon of the Add row button from an external icon library (ligature sets such as Material Icons included), shown beside its text or alone with ToolbarIconOnly. Takes precedence over AddRowIconName. |
| AddRowIconName | string? | null | The name of the icon of the Add row button from the Fluent UI icon set of Bit.BlazorUI.Icons, whose stylesheet the app links, e.g. BitIconName.CirclePlus. |
| AllowUnsorted | bool | true | Whether a third header click removes the sort (ascending → descending → unsorted). Overridable per column. |
| AriaDescribedBy | string? | null | Id of the element that describes the grid. |
| AriaLabelledBy | string? | null | Id of the element that names the grid, in place of AriaLabel. |
| Bordered | bool | true | Draws the outer border and the column lines; the row lines are always drawn. |
| CellNavigation | bool | false | Makes the data cells one tab stop: the arrows, Home/End and PageUp/PageDown move; Enter/F2 or typing edits; Esc cancels; Space selects (Shift+Space a range); Ctrl+A selects all; Delete deletes when Editable. Without it (or Single selection, Cell editing, a tree) no cell takes the focus, so the grid is announced as a table: role=table, its cells cell. |
| ChildContent | RenderFragment? | null | Column definitions and other children. |
| ChildrenProvider | Func<TItem, Task<IEnumerable<TItem>?>>? | null | Async children loader of a lazy tree grid: a node's children load on its first expand and are cached. Use instead of ChildrenSelector, with HasChildrenSelector. |
| ChildrenSelector | Func<TItem, IEnumerable<TItem>?>? | null | Child selector that turns the grid into a tree grid. |
| Classes | BitDataGridClassStyles? | null | Custom CSS classes for the parts of the grid. |
| ClearFiltersIcon | BitIconInfo? | null | The icon of the Clear filters button from an external icon library, shown beside its text or alone with ToolbarIconOnly. Takes precedence over ClearFiltersIconName. |
| ClearFiltersIconName | string? | null | The name of the icon of the Clear filters button from the Fluent UI icon set of Bit.BlazorUI.Icons, e.g. BitIconName.FilterSolid. |
| ClipboardCopy | bool | false | Enables Ctrl/⌘+C on a focused cell (with CellNavigation) and CopyToClipboardAsync, copying the selected or focused rows as tab-separated text with a header. |
| ColumnChooserIcon | BitIconInfo? | null | The icon of the Columns button from an external icon library, shown beside its text or alone with ToolbarIconOnly. Takes precedence over ColumnChooserIconName. |
| ColumnChooserIconName | string? | null | The name of the icon of the Columns button from the Fluent UI icon set of Bit.BlazorUI.Icons, e.g. BitIconName.TripleColumn. |
| Columns | RenderFragment? | null | Alias of ChildContent for the column definitions (<Columns>...</Columns>). |
| CsvExportIcon | BitIconInfo? | null | The icon of the CSV export button from an external icon library, shown beside its text or alone with ToolbarIconOnly. Takes precedence over CsvExportIconName. |
| CsvExportIconName | string? | null | The name of the icon of the CSV export button from the Fluent UI icon set of Bit.BlazorUI.Icons, e.g. BitIconName.Download. |
| DetailTemplate | RenderFragment<TItem>? | null | Expandable master-detail content rendered under a row. |
| Editable | bool | false | Enables inline editing with a command column. |
| EditMode | BitDataGridEditMode | BitDataGridEditMode.Row | Row edits the whole row with Save/Cancel; Cell edits one cell at a time (Enter, F2, double-click or typing opens; Enter, Tab or blur commits; Escape cancels). |
| EmptyTemplate | RenderFragment? | null | Custom content rendered when there is no data. |
| ExcelExportIcon | BitIconInfo? | null | The icon of the Excel export button from an external icon library, shown beside its text or alone with ToolbarIconOnly. Takes precedence over ExcelExportIconName. |
| ExcelExportIconName | string? | null | The name of the icon of the Excel export button from the Fluent UI icon set of Bit.BlazorUI.Icons, e.g. BitIconName.ExcelLogo. |
| ExcelExportStyled | bool | false | Excel exports also carry the grid's rendered theme (colors, striping, borders, fonts), read from the DOM; plain styling without JS. |
| ExpandDetailOnRowClick | bool | false | Toggles a row's detail when the row is clicked (selecting it too with SelectionMode). Clicks on the grid's own cells or on a control in a cell are excluded. |
| ExpandedDetailItems | IReadOnlyList<TItem>? | null | The rows whose detail is expanded (two-way bindable). |
| ExpandedDetailItemsChanged | EventCallback<IReadOnlyList<TItem>> | Raised when the expanded detail rows change. | |
| ExportFileName | string? | null | Base name of the export files, e.g. "orders" for orders.csv. Defaults to "export". |
| Filterable | bool | false | Renders a per-column filter row. A tree is pruned to the matching branches; not available on a lazy tree. |
| FilterDebounce | int | 300 | Delay (ms) before a text/number filter applies; 0 applies each keystroke, a negative value only Enter or blur. |
| FilterOperators | bool | false | Shows an operator dropdown next to the text/number/date filters (contains, starts with, =, ≠, >, <, is blank, is any of, ...). |
| Groupable | bool | false | Enables grouping via a header button on groupable columns. |
| GroupsInitiallyCollapsed | bool | false | Groups start collapsed instead of expanded. |
| HasChildrenSelector | Func<TItem, bool>? | null | Whether an unloaded lazy node can have children, so it renders an expand toggle. ChildrenProvider and OnLoadChildren only. |
| Height | string? | null | Height of the scroll viewport, e.g. "480px". Required for virtualization and infinite scrolling. |
| Hoverable | bool | true | Highlights the row under the pointer. |
| IsRowSelectionDisabled | Func<TItem, bool>? | null | Returns true for the rows that may not be selected. |
| Items | IEnumerable<TItem>? | null | The client-side data source. An IQueryable<T> (e.g. an EF Core DbSet) has its filtering, sorting and paging executed at the source. |
| KeyField | Func<TItem, object>? | null | Key selector for selection/edit identity. Defaults to reference equality. |
| Loading | bool | false | Shows a loading row (LoadingTemplate, or a spinner) in place of the rows and marks the grid aria-busy. A server grid (OnRead) needs it for neither: it marks itself aria-busy while it reads, and shows the loading row while it has no rows to show yet. |
| LoadingTemplate | RenderFragment? | null | Custom content replacing the spinner while Loading, and while a server grid reads its first rows. |
| LoadMoreBatchSize | int | 50 | Rows fetched per batch in infinite-scrolling mode. |
| MultiSort | bool | true | Enables multi-column sorting via Ctrl/⌘+click. |
| NewItemFactory | Func<TItem>? | null | Creates the new row of the toolbar Add button. |
| OnCellClick | EventCallback<BitDataGridCellEventArgs<TItem>> | Raised when a data cell is clicked; not on a control in it (see OnRowClick). | |
| OnCellContextMenu | EventCallback<BitDataGridCellEventArgs<TItem>> | Raised when a data cell is right-clicked, suppressing the browser's menu; not on a control in it. | |
| OnCellDoubleClick | EventCallback<BitDataGridCellEventArgs<TItem>> | Raised when a data cell is double-clicked; not on a control in it. | |
| OnDetailToggle | EventCallback<BitDataGridDetailEventArgs<TItem>> | Raised when a row's detail is expanded or collapsed. | |
| OnFilterChange | EventCallback<IReadOnlyList<BitDataGridFilterDescriptor>> | Raised with the new filters whenever the filtering changes. | |
| OnGroupChange | EventCallback<IReadOnlyList<BitDataGridGroupDescriptor>> | Raised with the new groups whenever the grouping changes. | |
| OnLoadChildren | Func<BitDataGridChildrenRequest<TItem>, Task<IEnumerable<TItem>?>>? | null | ChildrenProvider with a cancellation token, cancelled once the grid no longer needs the children (new Items, or the grid is disposed). Use only one of ChildrenSelector, ChildrenProvider and OnLoadChildren. |
| OnLoadMore | Func<BitDataGridReadRequest, Task<BitDataGridReadResult<TItem>>>? | null | Infinite-scrolling callback, appending a batch as the user scrolls to the end. Exports request all rows with Take = null, so honor a null Take. |
| OnPageChange | EventCallback<int> | Raised with the new 1-based page when the page or the page size changes. | |
| OnRead | Func<BitDataGridReadRequest, Task<BitDataGridReadResult<TItem>>>? | null | Server-side data callback; the grid delegates sort/filter/page/group to it. |
| OnReadError | EventCallback<Exception> | Raised with what OnRead threw reading the rows the grid shows. Setting it makes the grid handle the failure: an error row with a Retry button in place of the rows. Without it the exception propagates. A failed export never raises it. | |
| OnRowCancel | EventCallback<TItem> | Raised when an edit is cancelled. | |
| OnRowClick | EventCallback<TItem> | Raised when a row is clicked. A click on a control in a cell (a button, link, field, ARIA widget, focusable or data-bit-interactive element, or anything in a dialog or grid in the cell) raises neither this nor OnCellClick, and selects or expands nothing. data-bit-interactive="false" opts a control out. | |
| OnRowCreate | EventCallback<TItem> | Raised when a new row is created. | |
| OnRowDelete | EventCallback<TItem> | Raised when a row is deleted (Delete button or Delete key). | |
| OnRowDoubleClick | EventCallback<TItem> | Raised when a row is double-clicked, e.g. to open the record or BeginEdit; not on a control in a cell. | |
| OnRowReorder | EventCallback<BitDataGridRowReorderEventArgs<TItem>> | Raised when a row is dropped onto another row. | |
| OnRowSave | EventCallback<TItem> | Raised when an edited row is saved. | |
| OnSortChange | EventCallback<IReadOnlyList<BitDataGridSortDescriptor>> | Raised with the new sorts whenever the sorting changes. | |
| OnStateChange | EventCallback<BitDataGridState> | Raised with a GetState snapshot after any state it captures changes (sorts, filters, search, groups, page, column layout), for persisting the view. Not raised by ApplyStateAsync. | |
| OnViewChange | EventCallback<IReadOnlyList<TItem>> | Raised with the rows of the view across every page (see GetViewItems) when the search, filters, sorts or Items change them, to keep a chart or a map in step. Rows are matched by KeyField. List, tree and IQueryable sources only; use GetViewItemsAsync in server/infinite modes. | |
| Pageable | bool | false | Enables paging with a pager UI. |
| PagerPlacement | BitPlacement | BitPlacement.Bottom | Where the pager renders: Top, Bottom or TopAndBottom. |
| PageSize | int | 20 | The number of rows per page. |
| PageSizeOptions | int[] | { 10, 20, 50, 100 } | The page sizes offered in the pager. |
| Reorderable | bool | false | Lets the columns be reordered by dragging a header, Ctrl+Left/Right, or the column chooser. |
| Resizable | bool | false | Lets the columns be resized by dragging a header's edge, double-clicking it (fit), or with the keyboard on it. |
| RowClass | Func<TItem, string?>? | null | Per-row CSS class selector, appended after the grid's own row classes. |
| RowHeight | float | 36 | Uniform row height in px (required when virtualizing). |
| RowHeightSelector | Func<TItem, float>? | null | Per-row height selector (ignored while virtualizing). |
| RowReorderable | bool | false | Enables drag-and-drop row reordering (pointer, or the drag handle's arrow keys). |
| RowStyle | Func<TItem, string?>? | null | Per-row inline style selector. |
| SearchDebounce | int | 300 | Delay (ms) after the last keystroke before the search applies; 0 applies each keystroke. |
| SearchText | string? | null | The quick-search term (two-way bindable). |
| SearchTextChanged | EventCallback<string?> | Raised when the quick-search term changes. | |
| SelectedItems | IReadOnlyList<TItem>? | null | The selected items (two-way bindable). |
| SelectedItemsChanged | EventCallback<IReadOnlyList<TItem>> | Raised when the selection changes. | |
| SelectionMode | BitSelectionMode | BitSelectionMode.None | None, Single (a row click or Space; turns CellNavigation on) or Multiple (a checkbox column). |
| ShowCellTooltips | bool | false | Gives each value cell a native tooltip with its full text. Overridable per column (ShowTooltip); Template cells are excluded. |
| ShowColumnChooser | bool | false | Renders the column chooser button, to show, hide and (with Reorderable) move columns. |
| ShowCsvExport | bool | false | Renders a CSV export button, exporting all matching rows in every data mode. |
| ShowDetailToggle | bool | true | Renders the expand/collapse column while a DetailTemplate is set. Turn it off to drive the details from row clicks or code. |
| ShowExcelExport | bool | false | Renders an Excel (.xlsx) export button. Built in-process, exporting all matching rows with the grid's layout (frozen header and columns, widths, merged ColSpan cells). |
| ShowFooter | bool | false | Renders the footer/aggregate row. |
| ShowHeader | bool | true | Renders the header rows (titles, header groups and the filter row). |
| ShowRowNumbers | bool | false | Renders a leading gutter numbering the rows by their position in the whole dataset, across pages and batches. Never exported or copied. |
| ShowSearchBox | bool | false | Renders a toolbar quick-search box filtering the rows across every searchable column, ignoring case. Sent as BitDataGridReadRequest.Search in server/infinite modes; not available on a lazy tree (ChildrenProvider, OnLoadChildren). |
| ShowToolbar | bool | false | Renders the toolbar with its Clear filters button. Search, export, the column chooser, Add and ToolbarTemplate show it on their own. |
| Sortable | bool | true | Enables column sorting by clicking headers. |
| Strings | BitDataGridStrings | new() | All user-visible strings; assign a customized instance to localize. |
| Striped | bool | true | Renders alternate-row striping. |
| Styles | BitDataGridClassStyles? | null | Custom CSS styles for the parts of the grid. |
| ToolbarIconOnly | bool | false | Renders the toolbar's buttons (Add row, Clear filters, the exports, Columns) as icons alone; each one's localized text stays its accessible name and is shown in a tooltip on hover, focus and touch. A button given no icon draws a built-in one (Add, ClearFilter, TextDocument, ExcelDocument, ColumnOptions) that needs no icon package. |
| ToolbarTemplate | RenderFragment? | null | Custom content at the toolbar's start. |
| TreeInitiallyExpanded | bool | false | Whether the tree nodes start expanded. Ignored in lazy mode. |
| Virtualize | bool | false | Renders only the visible rows. Requires Height and RowHeight; server mode without paging fetches the rows as they scroll in. A grouped view is virtualized too, its group rows RowHeight tall on one line. Ignores RowHeightSelector, WrapCellText and the height of expanded detail rows. |
| VirtualizeColumns | bool | false | Renders only the columns near the horizontal viewport. Requires px column widths; not applied with header groups or ColSpans. |
| WrapCellText | bool | false | Wraps long headers and values onto several lines instead of clipping them. Overridable per column (WrapText); ignored while virtualizing. |
BitDataGrid public members
| Name | Type | Default value | Description |
|---|---|---|---|
| RefreshAsync | Task | Recomputes the view (filter, sort, group, page) and re-renders. | |
| SortByAsync | Task | SortByAsync(columnId, direction, additive) - sorts by a column; BitDataGridSortDirection.None removes the sort. | |
| ClearSortsAsync | Task | Removes all the sorts. | |
| ApplyFilterAsync | Task | ApplyFilterAsync(columnId, operator, value) - applies a filter, replacing the column's existing one. | |
| ApplyRangeFilterAsync | Task | ApplyRangeFilterAsync(columnId, from, toExclusive) - applies a half-open range filter (>= from AND < toExclusive) as two comparison filters. | |
| ClearFilterAsync | Task | ClearFilterAsync(columnId) - removes a column's filters. | |
| ClearFiltersAsync | Task | Removes all the column filters. | |
| GroupByAsync | Task | GroupByAsync(columnId) - adds the column as the next grouping level. | |
| UngroupAsync | Task | UngroupAsync(columnId) - removes the column's grouping level. | |
| ClearGroupsAsync | Task | Removes all the groupings. | |
| ExpandAllGroupsAsync | Task | Expands every group, including the ones built later. | |
| CollapseAllGroupsAsync | Task | Collapses every group, including the ones built later. | |
| SearchAsync | Task | SearchAsync(text) - applies the quick-search term (null clears it) and goes to the first page. | |
| ActiveSearch | string? | null | The active quick-search term, or null. |
| SelectAllAsync | Task | Selects every selectable row of the view (only the loaded ones in server, queryable and infinite modes). Multiple mode only. | |
| ClearSelectionAsync | Task | Clears the row selection. | |
| CopyToClipboardAsync | Task<int> | CopyToClipboardAsync() / CopyToClipboardAsync(fallbackRow) - copies the selected rows (or the fallback row) as tab-separated text and returns how many were copied; 0 without a clipboard. | |
| AutoFitColumnAsync | Task | AutoFitColumnAsync(columnId) - sizes a column to its widest content. | |
| AutoFitAllColumnsAsync | Task | Auto-fits every visible column. | |
| GoToPageAsync | Task | GoToPageAsync(page) - goes to a 1-based page (clamped). | |
| MoveColumnAsync | Task | MoveColumnAsync(columnId, index) - moves a column to a 0-based position among all the columns. | |
| SetPageSizeAsync | Task | SetPageSizeAsync(size) - changes the page size and goes to the first page. | |
| GetViewItems | IReadOnlyList<TItem> | The rows of the view across every page, in display order. Server/infinite modes return only the loaded rows; use GetViewItemsAsync there. | |
| GetViewItemsAsync | Task<IReadOnlyList<TItem>> | GetViewItemsAsync(cancellationToken) - the rows of the view across every page in every mode; server/infinite modes read them with an unpaged request (Take = null). | |
| RevealItemAsync | Task<bool> | RevealItemAsync(item) - pages to, expands to and scrolls to a row of the view; false when the row is not in it. | |
| GetState | BitDataGridState | Captures the user-adjustable state (page, search, sorts, filters, groups, column layout) as a serializable snapshot. | |
| ApplyStateAsync | Task | ApplyStateAsync(state) - restores a GetState snapshot. | |
| ExportCsvAsync | Task | ExportCsvAsync(selectedOnly) - downloads all the matching rows (or the selected ones) as CSV, in every data mode. | |
| ToCsv | string | ToCsv(selectedOnly) - builds the CSV synchronously; server/infinite modes cover only the loaded rows (use ToCsvAsync). | |
| ToCsvAsync | Task<string> | ToCsvAsync(selectedOnly) - builds the CSV of all the matching (or selected) rows in every mode. | |
| ToExcelAsync | Task<byte[]> | ToExcelAsync(selectedOnly) - builds an .xlsx of all the matching (or selected) rows with native cell types and the grid's layout (and theme, with ExcelExportStyled). | |
| ExportExcelAsync | Task | ExportExcelAsync(selectedOnly) - builds the .xlsx and downloads it. | |
| ActiveSorts | IReadOnlyList<BitDataGridSortDescriptor> | [] | The active sorts, in priority order. |
| ActiveFilters | IReadOnlyList<BitDataGridFilterDescriptor> | [] | The active filters. |
| ActiveGroups | IReadOnlyList<BitDataGridGroupDescriptor> | [] | The active groups, in nesting order. |
| TotalCount | int | 0 | The rows of the filtered view; the server's total in server mode. |
| TotalPages | int | 1 | The number of pages while paging. |
| CurrentPage | int | 1 | The 1-based current page. |
| ExpandAllAsync | Task | Expands every tree node (tree mode only). | |
| CollapseAllAsync | Task | Collapses every tree node (tree mode only). | |
| IsDetailExpanded | bool | IsDetailExpanded(item) - whether the row's detail is expanded. | |
| ExpandDetailAsync | Task | ExpandDetailAsync(item) - expands the row's detail. | |
| CollapseDetailAsync | Task | CollapseDetailAsync(item) - collapses the row's detail. | |
| ToggleDetailAsync | Task | ToggleDetailAsync(item) - toggles the row's detail. | |
| SetDetailExpandedAsync | Task | SetDetailExpandedAsync(item, expanded) - expands or collapses the row's detail. | |
| ExpandAllDetailsAsync | Task | Expands the detail of every row of the view (only the loaded rows in server, queryable and infinite modes). | |
| CollapseAllDetailsAsync | Task | Collapses every expanded detail. | |
| EditingItem | TItem? | null | The row being edited, or null. |
| EditingColumnId | string? | null | The column of the cell being edited in Cell mode, or null. |
| BeginEditAsync | Task | BeginEditAsync(item, columnId) - opens an edit at a cell and focuses its editor. | |
| BeginEdit | void | BeginEdit(item) - puts a row into edit mode, as its Edit button does. | |
| CommitEditAsync | Task | Saves the open edit and raises OnRowSave; refused while a value is invalid. | |
| CancelEditAsync | Task | Abandons the open edit, restoring the row, and raises OnRowCancel. | |
| AddNewRowAsync | Task | Adds a row from NewItemFactory and opens it for editing, as the toolbar Add button does. | |
| DeleteRowAsync | Task | DeleteRowAsync(item) - deselects the row and raises OnRowDelete for the caller to remove it. |
BitComponentBase parameters
| Name | Type | Default value | Description |
|---|---|---|---|
| AriaLabel | string? | null | Gets or sets the accessible label for the component, used by assistive technologies. |
| Class | string? | null | Gets or sets the CSS class name(s) to apply to the rendered element. |
| Dir | BitDir? | null | Gets or sets the text directionality for the component's content. |
| Disabled | bool | false | Gets or sets a value indicating whether the component is disabled and cannot respond to user interaction. |
| ForceAnimation | bool | false | Gets or sets a value indicating whether the component's animations play at their full duration even when reduced motion is requested. |
| HtmlAttributes | Dictionary<string, object> | new Dictionary<string, object>() | Captures additional HTML attributes to be applied to the rendered element, in addition to the component's parameters. An attribute written on the component wins over an entry of the same name. |
| Id | string? | null | Gets or sets the unique identifier for the component's root element. |
| Style | string? | null | Gets or sets the CSS style string to apply to the rendered element. |
| TabIndex | string? | null | Gets or sets the tab order index for the component when navigating with the keyboard. |
| Visibility | BitVisibility | BitVisibility.Visible | Gets or sets the visibility state (visible, hidden, or collapsed) of the component. |
BitComponentBase public members
| Name | Type | Default value | Description |
|---|---|---|---|
| UniqueId | Guid | Guid.NewGuid() | Gets the readonly unique identifier for the component's root element, assigned when the component instance is constructed. |
| RootElement | ElementReference | Gets the reference to the root HTML element associated with this component. |
BitDataGridClassStyles properties
Defines per-part CSS class/style values for BitDataGrid.
| Name | Type | Default value | Description |
|---|---|---|---|
| Root | string? | null | Custom class or style of the root element. |
| Toolbar | string? | null | Custom class or style of the toolbar. |
| ColumnChooser | string? | null | Custom class or style of the column chooser. |
| Viewport | string? | null | Custom class or style of the scrolling viewport. |
| HeaderRow | string? | null | Custom class or style of the column titles row. |
| HeaderCell | string? | null | Custom class or style of each header cell, before the column's HeaderClass. |
| FilterRow | string? | null | Custom class or style of the filter row. |
| Row | string? | null | Custom class or style of each data row, before RowClass/RowStyle. |
| SelectedRow | string? | null | Custom class or style of each selected row, after Row. |
| Cell | string? | null | Custom class or style of each data cell, before the column's CellClass. |
| GroupRow | string? | null | Custom class or style of each group header cell. |
| DetailRow | string? | null | Custom class or style of each detail row's content. |
| FooterRow | string? | null | Custom class or style of the footer row. |
| Pager | string? | null | Custom class or style of the pager. |
| Empty | string? | null | Custom class or style of the empty message cell. |
| Loading | string? | null | Custom class or style of the loading indicator cell. |
| ReadError | string? | null | Custom class or style of the cell showing a failed read and its Retry button. |
BitDataGridColumn properties
A column of a BitDataGrid, placed in its child content.
| Name | Type | Default value | Description |
|---|---|---|---|
| Field | string? | null | Name of the bound property; supports nested paths ("Address.City"). Prefer Property. |
| Property | Expression<Func<TItem, object?>>? | null | Typed selector of the bound property, e.g. p => p.Address.City. Refactor-safe; takes precedence over Field. |
| ColumnId | string? | null | Stable column identifier. Defaults to the Property/Field path. |
| Title | string? | null | Header text. Defaults to the humanized Property/Field name. |
| Width | string? | null | CSS width, e.g. "120px" or "20%"; null shares the remaining space. |
| MinWidth | int | 60 | Minimum resize width in px. |
| MaxWidth | int? | null | Maximum resize width in px. |
| Sortable | bool? | null | Overrides the grid's Sortable. A template-only column sorts only through SortBy (in-memory sources) or ServerSortable (server/infinite modes). |
| SortBy | Func<TItem, object?>? | null | Custom sort key, making a template-only column sortable; in-memory sources only. |
| ServerSortable | bool | false | Lets a template-only column sort in server/infinite modes, sending its ColumnId (required) in the request. |
| SortDescendingFirst | bool | false | The first header click sorts descending. |
| AllowUnsorted | bool? | null | Overrides the grid's AllowUnsorted. |
| Comparer | IComparer<object?>? | null | Custom comparer of the column's sort keys; client-side only. |
| Validate | Func<TItem, object?, string?>? | null | Inline-edit validator: returns an error message to reject the value, or null to accept it. |
| Filterable | bool? | null | Overrides the grid's Filterable. |
| FilterOperators | bool? | null | Overrides the grid's FilterOperators. |
| FilterTemplate | RenderFragment<BitDataGridFilterContext>? | null | Custom filter editor; its context carries the filter and ApplyAsync/ApplyRangeAsync/ClearAsync. |
| Resizable | bool? | null | Overrides the grid's Resizable. |
| Reorderable | bool? | null | Overrides the grid's Reorderable. |
| Editable | bool? | null | Overrides the grid's Editable. |
| Groupable | bool? | null | Overrides the grid's Groupable. |
| Searchable | bool? | null | Whether the quick search covers the column. Defaults to the bound (or ExportValue) columns. |
| Exportable | bool? | null | Whether exports include the column. Defaults to the columns with a value (a bound field or ExportValue). |
| ExportValue | Func<TItem, object?>? | null | The value exports and the clipboard use instead of the bound field. |
| ShowTooltip | bool? | null | Overrides the grid's ShowCellTooltips. |
| WrapText | bool? | null | Overrides the grid's WrapCellText. |
| Frozen | bool | false | Pins the column to the start edge while scrolling horizontally. |
| FrozenEnd | bool | false | Pins the column to the end edge. |
| Group | string? | null | Header group name; consecutive columns sharing it render under one spanning header. |
| ColSpan | Func<TItem, int?>? | null | Per-row column span. |
| Visible | bool | true | Whether the column is visible. |
| RowHeader | bool | false | Makes the cells the headers of their rows (role rowheader), naming the row for screen readers. |
| Align | BitTextAlign | BitTextAlign.Start | Horizontal alignment of the cells: Start, Center, End, Left or Right; any other value is Start. |
| Format | string? | null | A .NET format string, e.g. "C2" or "yyyy-MM-dd". |
| ValueText | Func<object, string?>? | null | The text a value is shown as (e.g. a translated enum name) in the cells, tooltips, group headers, Min/Max aggregates, enum and boolean filter and editor options, and what the in-memory quick search and text filters match; null keeps the default. Display only: exports keep the value itself (use ExportValue for other text). An enum member otherwise shows its [Display] name, unless a Format is set. |
| DataType | BitDataGridColumnDataType | BitDataGridColumnDataType.Auto | The data type picking the editor and filter. |
| Aggregate | BitDataGridAggregateType | BitDataGridAggregateType.None | The footer/group aggregate function. |
| AggregateBy | Func<IReadOnlyList<TItem>, object?>? | null | Custom aggregate function (e.g. a distinct count); takes precedence over Aggregate. |
| AggregateFormat | string? | null | Format of the aggregate value; falls back to Format. |
| HeaderClass | string? | null | CSS class of the header cell. |
| CellClass | string? | null | CSS class of each data cell. |
| CellClassSelector | Func<TItem, string?>? | null | Per-row CSS class of the cells, after CellClass. |
| CellStyleSelector | Func<TItem, string?>? | null | Per-row inline style of the cells. Prefer color/font to background, which hides selection and hover. |
| Template | RenderFragment<TItem>? | null | Custom data cell content. |
| HeaderTemplate | RenderFragment? | null | Custom header cell content. |
| EditTemplate | RenderFragment<TItem>? | null | Custom editor in edit mode. |
| FooterTemplate | RenderFragment<BitDataGridAggregateResult>? | null | Custom footer/aggregate cell content. |
BitDataGridReadRequest properties
What the grid asks of OnRead/OnLoadMore.
| Name | Type | Default value | Description |
|---|---|---|---|
| Skip | int | 0 | Zero-based number of items to skip. |
| Take | int? | null | Maximum number of items to return; null means all. |
| Sorts | IReadOnlyList<BitDataGridSortDescriptor> | [] | The active sorts, by priority. |
| Filters | IReadOnlyList<BitDataGridFilterDescriptor> | [] | The active filters. |
| Groups | IReadOnlyList<BitDataGridGroupDescriptor> | [] | The active groups, in nesting order. |
| Search | string? | null | The quick-search term to match across the searchable columns, or null. |
| Aggregates | IReadOnlyList<BitDataGridAggregateDescriptor> | [] | The aggregates the footer shows, one per aggregating column: compute them over the whole filtered data and return them in the result's Aggregates. Empty for OnLoadMore and export reads. |
| CancellationToken | CancellationToken | Cancelled when a newer request supersedes this one. |
BitDataGridReadResult<TItem> properties
The result of OnRead/OnLoadMore.
| Name | Type | Default value | Description |
|---|---|---|---|
| Items | IReadOnlyList<TItem> | The items of the current page/window. | |
| TotalCount | int | The total of the matching items (ignored in infinite mode). | |
| Aggregates | IReadOnlyList<BitDataGridAggregateResult>? | null | Aggregates over the whole filtered data, shown in the footer instead of the page's own. |
BitDataGridChildrenRequest<TItem> properties
What a lazy tree grid asks of OnLoadChildren.
| Name | Type | Default value | Description |
|---|---|---|---|
| Parent | TItem | The node whose direct children are requested. | |
| CancellationToken | CancellationToken | Cancelled once the grid no longer needs the children: new Items replaced the hierarchy, or the grid is disposed. Collapsing the node does not cancel it. |
BitDataGridCellEventArgs<TItem> properties
Arguments of the cell events.
| Name | Type | Default value | Description |
|---|---|---|---|
| Item | TItem | The row item. | |
| Column | BitDataGridColumn<TItem> | The cell's column. | |
| ColumnId | string | The column's identifier. | |
| ColumnTitle | string | The column's title. | |
| Value | object? | null | The cell's raw value. |
| Mouse | MouseEventArgs | The browser mouse event. |
BitDataGridDetailEventArgs<TItem> properties
Arguments of a row's detail toggle.
| Name | Type | Default value | Description |
|---|---|---|---|
| Item | TItem | The toggled row. | |
| Expanded | bool | Whether the detail was expanded. |
BitDataGridRowReorderEventArgs<TItem> properties
Arguments of a row drop.
| Name | Type | Default value | Description |
|---|---|---|---|
| DraggedItem | TItem | The dragged row. | |
| TargetItem | TItem | The drop-target row. | |
| FromIndex | int? | The original index, or null when Items is not an indexable list. | |
| ToIndex | int? | The destination index, or null when Items is not an indexable list. |
BitDataGridSortDescriptor properties
A column's sort (in BitDataGridReadRequest.Sorts).
| Name | Type | Default value | Description |
|---|---|---|---|
| ColumnId | string | The sorted column's identifier. | |
| Direction | BitDataGridSortDirection | BitDataGridSortDirection.Ascending | The sort direction. |
| Priority | int | int.MaxValue | Multi-sort priority (1 = primary). |
BitDataGridFilterDescriptor properties
A column's filter (in BitDataGridReadRequest.Filters).
| Name | Type | Default value | Description |
|---|---|---|---|
| ColumnId | string | The filtered column's identifier. | |
| Operator | BitDataGridFilterOperator | BitDataGridFilterOperator.Unspecified | The comparison operator; Unspecified applies no filter. |
| Value | object? | null | The operand; a collection for In/NotIn. |
BitDataGridFilterContext properties
The context of a column's FilterTemplate: its filter and the calls that change it.
| Name | Type | Default value | Description |
|---|---|---|---|
| ColumnId | string | The filtered column's identifier. | |
| Title | string | The column's header text. | |
| Label | string | The editor's accessible name ("Filter by {Title}"). | |
| ValueType | Type? | null | The bound member's type, Nullable<T> unwrapped. |
| Disabled | bool | Whether the grid is disabled. | |
| Filters | IReadOnlyList<BitDataGridFilterDescriptor> | The column's filters: none, one, or a range's two halves. | |
| IsActive | bool | Whether the column is filtered. | |
| Operator | BitDataGridFilterOperator | The first filter's operator, or Unspecified. | |
| Value | object? | The first filter's value, or null. | |
| ApplyAsync | Task (BitDataGridFilterOperator, object?) | Replaces the filter; an empty value clears it. | |
| ApplyRangeAsync | Task (object?, object?) | Replaces the filter with a half-open range (>= from AND < toExclusive). | |
| ClearAsync | Task () | Removes the filter. |
BitDataGridGroupDescriptor properties
A column's grouping.
| Name | Type | Default value | Description |
|---|---|---|---|
| ColumnId | string | The grouped column's identifier. | |
| Direction | BitDataGridSortDirection | BitDataGridSortDirection.Ascending | The sort direction of the group keys. |
BitDataGridAggregateDescriptor properties
An aggregate the footer shows (in BitDataGridReadRequest.Aggregates).
| Name | Type | Default value | Description |
|---|---|---|---|
| ColumnId | string | The aggregating column's identifier. | |
| Type | BitDataGridAggregateType | The column's aggregate function; Custom for a column with its own AggregateBy, which the server computes its own way. |
BitDataGridAggregateResult properties
A computed footer or group aggregate (passed to FooterTemplate).
| Name | Type | Default value | Description |
|---|---|---|---|
| ColumnId | string | The aggregated column's identifier. | |
| Type | BitDataGridAggregateType | The aggregate function. | |
| Value | object? | null | The raw value. |
| FormattedValue | string | string.Empty | The value formatted with AggregateFormat/Format. |
BitDataGridState properties
A serializable snapshot of the user-adjustable state, from GetState() for ApplyStateAsync().
| Name | Type | Default value | Description |
|---|---|---|---|
| CurrentPage | int | 1 | The 1-based current page. |
| PageSize | int? | null | The user-chosen page size, or null for the PageSize parameter. |
| Search | string? | null | The quick-search term, or null. |
| Sorts | List<BitDataGridSortDescriptor> | [] | The active sorts. |
| Filters | List<BitDataGridFilterDescriptor> | [] | The active filters. |
| Groups | List<BitDataGridGroupDescriptor> | [] | The active groups. |
| GroupsCollapsed | bool | false | Whether the groups were collapsed by default. |
| GroupExpansionOverrides | List<string> | [] | The paths of the groups whose expansion differs from GroupsCollapsed. Tree expansion is not captured. |
| Columns | List<BitDataGridColumnState> | [] | The column layout. |
BitDataGridColumnState properties
A column's layout in BitDataGridState.Columns.
| Name | Type | Default value | Description |
|---|---|---|---|
| ColumnId | string | string.Empty | The column's identifier. |
| Visible | bool | true | Whether the column is shown. |
| Width | double? | null | The resized width in px, or null. |
| Order | int | 0 | The display position among all the columns. |
BitDataGridStrings properties
All the user-visible and screen-reader strings of the grid, in English by default; assign a customized instance to Strings to localize.
| Name | Type | Default value | Description |
|---|---|---|---|
| GridLabel | string | "Data grid" | The grid's accessible name when no AriaLabel is given. |
| EmptyText | string | BitStrings.NoItemsFound | Shown when there are no rows; "No items found" unless BitStrings.Current says otherwise. |
| NoMatchesText | string | BitStrings.NoResultsFound | Shown instead of EmptyText when the filters or the search exclude every row; "No results found" unless BitStrings.Current says otherwise. |
| LoadingText | string | "Loading…" | Shown while Loading is true, and while a server grid reads its first rows. |
| ReadErrorText | string | "The records could not be loaded." | Shown in place of the rows when a read fails and OnReadError is set. |
| RetryText | string | "Retry" | The button that reads the rows again after a failed read. |
| PagerRangeFormat | string | "{0}–{1} of {2}" | Pager range summary format. |
| PagerPageFormat | string | "Page {0} of {1}" | Pager page summary format. |
| InvalidValueError | string | "Invalid value for {0}." | Shown when an edited value can't be converted. |
| SearchPlaceholder | string | "Search…" | The quick-search placeholder. |
| … | string | Plus 86 more: button texts, labels, placeholders, operator and option texts, tooltips, aggregate formats and live announcements. |
BitTextAlign enum
| Name | Value | Description |
|---|---|---|
| Start | 0 | The leading edge, whatever the text direction. |
| End | 1 | The trailing edge, whatever the text direction. |
| Left | 2 | The left edge, whatever the text direction. |
| Right | 3 | The right edge, whatever the text direction. |
| Center | 4 | Centers the lines. |
| Justify | 5 | Lines up both edges of every line but the last. |
| JustifyAll | 6 | Justifies the last line too. Not implemented by browsers yet. |
| MatchParent | 7 | Inherits, resolving start/end against the parent's direction. |
| Inherit | 8 | Takes the parent's alignment. |
| Initial | 9 | Takes the initial value. |
| Revert | 10 | Reverts to the user agent or user stylesheet value. |
| RevertLayer | 11 | Reverts to the previous cascade layer's value. |
| Unset | 12 | Inherits, or takes the initial value where not inherited. |
BitDataGridSortDirection enum
| Name | Value | Description |
|---|---|---|
| None | 0 | Not sorted. SortByAsync removes the sort with it; a group keeps its keys in first-met order. |
| Ascending | 1 | Smallest to largest. |
| Descending | 2 | Largest to smallest. |
BitDataGridEditMode enum
| Name | Value | Description |
|---|---|---|
| Row | 0 | The whole row, with Save/Cancel. |
| Cell | 1 | One cell at a time; Enter, Tab or blur commits, Escape cancels. |
BitSelectionMode enum
| Name | Value | Description |
|---|---|---|
| None | 0 | Nothing can be selected: the items act as plain content or as plain action buttons. |
| Single | 1 | At most one item can be selected at a time, so selecting one clears the one before it. |
| Multiple | 2 | Any number of items can be selected at the same time. |
BitDataGridAggregateType enum
| Name | Value | Description |
|---|---|---|
| None | 0 | No aggregate, unless the column has an AggregateBy. |
| Sum | 1 | The total of the numeric values. |
| Average | 2 | The mean of the numeric values, or 0. |
| Count | 3 | The number of rows. |
| Min | 4 | The smallest non-null value. |
| Max | 5 | The largest non-null value. |
| Custom | 6 | Produced by the column's AggregateBy. |
BitPlacement enum
| Name | Value | Description |
|---|---|---|
| Top | 0 | The top edge. |
| Bottom | 1 | The bottom edge. |
| Start | 2 | The edge the reading direction starts from - the left in LTR, the right in RTL. On the vertical axis, which does not turn around, it is the top. |
| End | 3 | The edge the reading direction ends at - the right in LTR, the left in RTL. On the vertical axis, which does not turn around, it is the bottom. |
| Left | 4 | The left edge, in both reading directions. |
| Right | 5 | The right edge, in both reading directions. |
| Center | 6 | The middle of the axis, against neither edge. |
| TopAndBottom | 7 | Both edges of the block axis at once. |
| StartAndEnd | 8 | Both edges of the inline axis at once, following the reading direction the way Start and End do. |
BitDataGridColumnDataType enum
| Name | Value | Description |
|---|---|---|
| Auto | 0 | Inferred from the property type (bool, enum, date, numeric; otherwise Text). |
| Text | 1 | A text box with the text operators. |
| Number | 2 | A numeric text box with the comparison operators. |
| Boolean | 3 | A true/false dropdown. |
| Date | 4 | A date picker, without a time of day. |
| DateTime | 5 | A date picker; equality matches the whole day. |
| DateTimeOffset | 6 | A date picker; equality matches the whole day. |
| Enum | 7 | A dropdown of the enum's names. |
BitDataGridFilterOperator enum
| Name | Value | Description |
|---|---|---|
| Unspecified | 0 | No operator; the filter is ignored. |
| Contains | 1 | The text contains the term, ignoring case. |
| DoesNotContain | 2 | The text does not contain the term, ignoring case. |
| StartsWith | 3 | The text starts with the term, ignoring case. |
| EndsWith | 4 | The text ends with the term, ignoring case. |
| Equals | 5 | Equals the operand; a null operand matches nulls. |
| NotEquals | 6 | Does not equal the operand. |
| GreaterThan | 7 | Greater than the operand; nulls never match. |
| GreaterThanOrEqual | 8 | Greater than or equal to the operand; nulls never match. |
| LessThan | 9 | Less than the operand; nulls never match. |
| LessThanOrEqual | 10 | Less than or equal to the operand; nulls never match. |
| IsEmpty | 11 | Null or empty text; takes no operand. |
| IsNotEmpty | 12 | Neither null nor empty text; takes no operand. |
| In | 13 | Equals a member of the Value collection. |
| NotIn | 14 | Equals no member of the Value collection. |
BitVisibility enum
| Name | Value | Description |
|---|---|---|
| Visible | 0 | The content of the component is visible. |
| Hidden | 1 | The content of the component is hidden, but the space it takes on the page remains (visibility:hidden). |
| Collapsed | 2 | The component is hidden (display:none). |
BitDir enum
| Name | Value | Description |
|---|---|---|
| Ltr | 0 | Ltr (left to right) is to be used for languages that are written from the left to the right (like English). |
| Rtl | 1 | Rtl (right to left) is to be used for languages that are written from the right to the left (like Arabic). |
| Auto | 2 | Auto lets the user agent decide. It uses a basic algorithm as it parses the characters inside the element until it finds a character with a strong directionality, then applies that directionality to the whole element. |
Feedback
Found a mistake, a gap, or something that could be clearer? Every page and every component is one click from its source.