Blazorise Table API

Explore the Blazorise Table API reference for parameters, events, methods, and related types.

For examples and usage guidance, see the Table documentation.

API

Parameters

Table

Parameter Description TypeDefault
Bordered

Adds borders to all the cells.

boolfalse
Borderless

Makes the table without any borders.

boolfalse
ChildContent

Specifies the content to be rendered inside this Table.

RenderFragmentnull
ContextMenuPreventDefault

Used to prevent the default action for an ContextMenu event.

boolfalse
DragEndPreventDefault

Used to prevent the default action for an DragEnd event.

boolfalse
DragEnterPreventDefault

Used to prevent the default action for an DragEnter event.

boolfalse
Draggable

Indicates whether the element can be dragged.

boolfalse
DragLeavePreventDefault

Used to prevent the default action for an DragLeave event.

boolfalse
DragOverPreventDefault

Used to prevent the default action for an DragOver event.

boolfalse
DragPreventDefault

Used to prevent the default action for an Drag event.

boolfalse
DragStartPreventDefault

Used to prevent the default action for an DragStart event.

boolfalse
DropPreventDefault

Used to prevent the default action for an Drop event.

boolfalse
FixedColumns

Makes table have a fixed set of columns. This will make it so that the table columns could be fixed to the side of the table.

boolfalse
FixedColumnsPositionSync

Determines whether the FixedColumns feature automatically resynchronizes the columns positions when they are added or removed.

Remarks

Enabling this feature may impact performance due to constant recalculations of fixed column positions.

boolfalse
FixedHeader

Makes table have a fixed header and enables a scrollbar in the table body.

boolfalse
FixedHeaderTableHeight

Sets the table height when FixedHeader feature is enabled (defaults to 300px).

string"300px"
FixedHeaderTableMaxHeight

Sets the table max height when FixedHeader feature is enabled (defaults to 300px).

string"300px"
FullWidth

Makes the table to fill entire horizontal space.

booltrue
Hoverable

Adds a hover effect when mousing over rows.

boolfalse
Narrow

Makes the table more compact by cutting cell padding in half.

boolfalse
Resizable

Determines whether users can resize Table's columns.

boolfalse
ResizeMode

Determines whether the user can resize on header or columns.

Possible values:Header, Columns

TableResizeModeTableResizeMode.Header
Responsive

Makes table responsive by adding the horizontal scroll bar.

Remarks

In some cases Dropdown component placed inside of a table marked with Responsive flag might not show dropdown menu properly. To make it work you might need to add some additional CSS rules.

boolfalse
ResponsiveMode

Specifies the Table's responsive mode.

Possible values:Default, Mobile

TableResponsiveModeTableResponsiveMode.Default
Striped

Adds stripes to the table.

boolfalse

TableBody

Parameter Description TypeDefault
ChildContent

Specifies the content to be rendered inside this TableBody.

RenderFragmentnull
ContextMenuPreventDefault

Used to prevent the default action for an ContextMenu event.

boolfalse
DragEndPreventDefault

Used to prevent the default action for an DragEnd event.

boolfalse
DragEnterPreventDefault

Used to prevent the default action for an DragEnter event.

boolfalse
Draggable

Indicates whether the element can be dragged.

boolfalse
DragLeavePreventDefault

Used to prevent the default action for an DragLeave event.

boolfalse
DragOverPreventDefault

Used to prevent the default action for an DragOver event.

boolfalse
DragPreventDefault

Used to prevent the default action for an Drag event.

boolfalse
DragStartPreventDefault

Used to prevent the default action for an DragStart event.

boolfalse
DropPreventDefault

Used to prevent the default action for an Drop event.

boolfalse

TableCaption

Parameter Description TypeDefault
ChildContent

Defines the content to be rendered inside the component.

RenderFragmentnull
Side

Specifies the position of the table caption relative to the table.

Possible values:Default, Top, Bottom

TableCaptionSideTableCaptionSide.Default

TableRow

Parameter Description TypeDefault
ChildContent

Specifies the content to be rendered inside this TableRow.

RenderFragmentnull
Color

Specifies the row variant color.

ColorColor.Default
ContextMenuPreventDefault

Used to prevent the default action for an ContextMenu event.

boolfalse
DragEndPreventDefault

Used to prevent the default action for an DragEnd event.

boolfalse
DragEnterPreventDefault

Used to prevent the default action for an DragEnter event.

boolfalse
Draggable

Indicates whether the element can be dragged.

boolfalse
DragLeavePreventDefault

Used to prevent the default action for an DragLeave event.

boolfalse
DragOverPreventDefault

Used to prevent the default action for an DragOver event.

boolfalse
DragPreventDefault

Used to prevent the default action for an Drag event.

boolfalse
DragStartPreventDefault

Used to prevent the default action for an DragStart event.

boolfalse
DropPreventDefault

Used to prevent the default action for an Drop event.

boolfalse
HoverCursor

Specifies the applied cursor when the row is hovered over.

Possible values:Default, Pointer

CursorCursor.Default
Intent

Specifies the row variant intent.

Intentnull
Selected

Sets a table row as selected by appending "selected" modifier on a tr element.

boolfalse

TableRowCell

Parameter Description TypeDefault
ChildContent

Specifies the content to be rendered inside this TableRowCell.

RenderFragmentnull
ClickPreventDefault

Used to prevent the default action for an OnClickHandler(MouseEventArgs) event.

boolfalse
ClickStopPropagation

Used to stop progation of the click action event.

boolfalse
Color

Specifies the cell variant color.

ColorColor.Default
ColumnSpan

Number of columns a cell should span.

int?null
ContextMenuPreventDefault

Used to prevent the default action for an ContextMenu event.

boolfalse
DragEndPreventDefault

Used to prevent the default action for an DragEnd event.

boolfalse
DragEnterPreventDefault

Used to prevent the default action for an DragEnter event.

boolfalse
Draggable

Indicates whether the element can be dragged.

boolfalse
DragLeavePreventDefault

Used to prevent the default action for an DragLeave event.

boolfalse
DragOverPreventDefault

Used to prevent the default action for an DragOver event.

boolfalse
DragPreventDefault

Used to prevent the default action for an Drag event.

boolfalse
DragStartPreventDefault

Used to prevent the default action for an DragStart event.

boolfalse
DropPreventDefault

Used to prevent the default action for an Drop event.

boolfalse
FixedPosition

Specifies the fixed position of the row cell within the table.

Possible values:None, Start, End

TableColumnFixedPositionTableColumnFixedPosition.None
Intent

Specifies the cell variant intent.

Intentnull
MobileModeCaption

When the ResponsiveMode is set to Mobile, this caption will be used for the row.

string
RowSpan

Number of rows a cell should span.

int?null

TableRowGroup

Parameter Description TypeDefault
ChildContent

Specifies the content to be rendered inside this TableRow.

RenderFragmentnull
ColumnSpan

Determines the column span for the inner table cell.

int1000
ContextMenuPreventDefault

Used to prevent the default action for an ContextMenu event.

boolfalse
DragEndPreventDefault

Used to prevent the default action for an DragEnd event.

boolfalse
DragEnterPreventDefault

Used to prevent the default action for an DragEnter event.

boolfalse
Draggable

Indicates whether the element can be dragged.

boolfalse
DragLeavePreventDefault

Used to prevent the default action for an DragLeave event.

boolfalse
DragOverPreventDefault

Used to prevent the default action for an DragOver event.

boolfalse
DragPreventDefault

Used to prevent the default action for an Drag event.

boolfalse
DragStartPreventDefault

Used to prevent the default action for an DragStart event.

boolfalse
DropPreventDefault

Used to prevent the default action for an Drop event.

boolfalse
Expanded

Specifies if the group is expanded.

boolfalse
IndentTableCells

Specifies a number of Table Cells to Indent on the Group Row.

int0
IndentTableCellTemplate

Specifies the custom content inside an Indented Table Cell on the Group Row. A contextual index is provided according to the Indentation.

RenderFragment<int>null
Title

Specifies the title to be rendered inside this TableRowGroup.

string
TitleTemplate

Specifies the custom title content to be rendered inside this TableRowGroup. It has higher priority over the Title parameter.

RenderFragmentnull
Toggleable

Specifies if the group Expanded property can be toggled by clicking. It is still possible to toggle it programatically.

booltrue

TableRowHeader

Parameter Description TypeDefault
ChildContent

Specifies the content to be rendered inside this TableRowHeader.

RenderFragmentnull
ColumnSpan

Number of columns a cell should span.

int?null
ContextMenuPreventDefault

Used to prevent the default action for an ContextMenu event.

boolfalse
DragEndPreventDefault

Used to prevent the default action for an DragEnd event.

boolfalse
DragEnterPreventDefault

Used to prevent the default action for an DragEnter event.

boolfalse
Draggable

Indicates whether the element can be dragged.

boolfalse
DragLeavePreventDefault

Used to prevent the default action for an DragLeave event.

boolfalse
DragOverPreventDefault

Used to prevent the default action for an DragOver event.

boolfalse
DragPreventDefault

Used to prevent the default action for an Drag event.

boolfalse
DragStartPreventDefault

Used to prevent the default action for an DragStart event.

boolfalse
DropPreventDefault

Used to prevent the default action for an Drop event.

boolfalse
FixedPosition

Specifies the fixed position of the row header within the table.

Possible values:None, Start, End

TableColumnFixedPositionTableColumnFixedPosition.None
MobileModeCaption

When the ResponsiveMode is set to Mobile, this caption will be used for the row.

string
RowSpan

Number of rows a cell should span.

int?null

TableHeader

Parameter Description TypeDefault
ChildContent

Specifies the content to be rendered inside this TableHeader.

RenderFragmentnull
ContextMenuPreventDefault

Used to prevent the default action for an ContextMenu event.

boolfalse
DragEndPreventDefault

Used to prevent the default action for an DragEnd event.

boolfalse
DragEnterPreventDefault

Used to prevent the default action for an DragEnter event.

boolfalse
Draggable

Indicates whether the element can be dragged.

boolfalse
DragLeavePreventDefault

Used to prevent the default action for an DragLeave event.

boolfalse
DragOverPreventDefault

Used to prevent the default action for an DragOver event.

boolfalse
DragPreventDefault

Used to prevent the default action for an Drag event.

boolfalse
DragStartPreventDefault

Used to prevent the default action for an DragStart event.

boolfalse
DropPreventDefault

Used to prevent the default action for an Drop event.

boolfalse
ThemeContrast

Sets the preferred color contrast for the header.

Possible values:None, Light, Dark

ThemeContrastThemeContrast.None

TableHeaderCell

Parameter Description TypeDefault
ChildContent

Specifies the content to be rendered inside this TableHeaderCell.

RenderFragmentnull
ColumnSpan

Number of columns a cell should span.

int?null
ContextMenuPreventDefault

Used to prevent the default action for an ContextMenu event.

boolfalse
Cursor

Specifies the mouse cursor based on the behaviour by the current css framework.

Possible values:Default, Pointer

CursorCursor.Default
DragEndPreventDefault

Used to prevent the default action for an DragEnd event.

boolfalse
DragEnterPreventDefault

Used to prevent the default action for an DragEnter event.

boolfalse
Draggable

Indicates whether the element can be dragged.

boolfalse
DragLeavePreventDefault

Used to prevent the default action for an DragLeave event.

boolfalse
DragOverPreventDefault

Used to prevent the default action for an DragOver event.

boolfalse
DragPreventDefault

Used to prevent the default action for an Drag event.

boolfalse
DragStartPreventDefault

Used to prevent the default action for an DragStart event.

boolfalse
DropPreventDefault

Used to prevent the default action for an Drop event.

boolfalse
FixedPosition

Specifies the fixed position of the header cell within the table.

Possible values:None, Start, End

TableColumnFixedPositionTableColumnFixedPosition.None
RowSpan

Number of rows a cell should span.

int?null

TableFooter

Parameter Description TypeDefault
ChildContent

Specifies the content to be rendered inside this TableFooter.

RenderFragmentnull
ContextMenuPreventDefault

Used to prevent the default action for an ContextMenu event.

boolfalse
DragEndPreventDefault

Used to prevent the default action for an DragEnd event.

boolfalse
DragEnterPreventDefault

Used to prevent the default action for an DragEnter event.

boolfalse
Draggable

Indicates whether the element can be dragged.

boolfalse
DragLeavePreventDefault

Used to prevent the default action for an DragLeave event.

boolfalse
DragOverPreventDefault

Used to prevent the default action for an DragOver event.

boolfalse
DragPreventDefault

Used to prevent the default action for an Drag event.

boolfalse
DragStartPreventDefault

Used to prevent the default action for an DragStart event.

boolfalse
DropPreventDefault

Used to prevent the default action for an Drop event.

boolfalse

Events

Table

Event Description Type
ContextMenu

The event is fired when an element or text selection is right clicked to show the context menu.

EventCallback<MouseEventArgs>
Drag

The drag event is fired every few hundred milliseconds as an element or text selection is being dragged by the user.

EventCallback<DragEventArgs>
DragEnd

The DragEnd event is fired when a drag operation is being ended (by releasing a mouse button or hitting the escape key).

EventCallback<DragEventArgs>
DragEnter

The DragEnter event is fired when a dragged element or text selection enters a valid drop target.

EventCallback<DragEventArgs>
DragLeave

The DragLeave event is fired when a dragged element or text selection leaves a valid drop target.

EventCallback<DragEventArgs>
DragOver

The DragOver event is fired when an element or text selection is being dragged over a valid drop target (every few hundred milliseconds).

EventCallback<DragEventArgs>
DragStart

The DragStart event is fired when the user starts dragging an element or text selection.

EventCallback<DragEventArgs>
Drop

The drop event is fired when an element or text selection is dropped on a valid drop target.

EventCallback<DragEventArgs>

TableBody

Event Description Type
ContextMenu

The event is fired when an element or text selection is right clicked to show the context menu.

EventCallback<MouseEventArgs>
Drag

The drag event is fired every few hundred milliseconds as an element or text selection is being dragged by the user.

EventCallback<DragEventArgs>
DragEnd

The DragEnd event is fired when a drag operation is being ended (by releasing a mouse button or hitting the escape key).

EventCallback<DragEventArgs>
DragEnter

The DragEnter event is fired when a dragged element or text selection enters a valid drop target.

EventCallback<DragEventArgs>
DragLeave

The DragLeave event is fired when a dragged element or text selection leaves a valid drop target.

EventCallback<DragEventArgs>
DragOver

The DragOver event is fired when an element or text selection is being dragged over a valid drop target (every few hundred milliseconds).

EventCallback<DragEventArgs>
DragStart

The DragStart event is fired when the user starts dragging an element or text selection.

EventCallback<DragEventArgs>
Drop

The drop event is fired when an element or text selection is dropped on a valid drop target.

EventCallback<DragEventArgs>

TableRow

Event Description Type
Clicked

Notifies when the row is clicked.

EventCallback<MouseEventArgs>
ContextMenu

The event is fired when an element or text selection is right clicked to show the context menu.

EventCallback<MouseEventArgs>
DoubleClicked

Notifies when the row is double clicked.

EventCallback<MouseEventArgs>
Drag

The drag event is fired every few hundred milliseconds as an element or text selection is being dragged by the user.

EventCallback<DragEventArgs>
DragEnd

The DragEnd event is fired when a drag operation is being ended (by releasing a mouse button or hitting the escape key).

EventCallback<DragEventArgs>
DragEnter

The DragEnter event is fired when a dragged element or text selection enters a valid drop target.

EventCallback<DragEventArgs>
DragLeave

The DragLeave event is fired when a dragged element or text selection leaves a valid drop target.

EventCallback<DragEventArgs>
DragOver

The DragOver event is fired when an element or text selection is being dragged over a valid drop target (every few hundred milliseconds).

EventCallback<DragEventArgs>
DragStart

The DragStart event is fired when the user starts dragging an element or text selection.

EventCallback<DragEventArgs>
Drop

The drop event is fired when an element or text selection is dropped on a valid drop target.

EventCallback<DragEventArgs>
MouseLeave

Notifies when the row is mouse leaved.

EventCallback<MouseEventArgs>
MouseOver

Notifies when the row is mouse overed.

EventCallback<MouseEventArgs>

TableRowCell

Event Description Type
Clicked

Notifies when the row cell is clicked.

EventCallback<MouseEventArgs>
ContextMenu

The event is fired when an element or text selection is right clicked to show the context menu.

EventCallback<MouseEventArgs>
Drag

The drag event is fired every few hundred milliseconds as an element or text selection is being dragged by the user.

EventCallback<DragEventArgs>
DragEnd

The DragEnd event is fired when a drag operation is being ended (by releasing a mouse button or hitting the escape key).

EventCallback<DragEventArgs>
DragEnter

The DragEnter event is fired when a dragged element or text selection enters a valid drop target.

EventCallback<DragEventArgs>
DragLeave

The DragLeave event is fired when a dragged element or text selection leaves a valid drop target.

EventCallback<DragEventArgs>
DragOver

The DragOver event is fired when an element or text selection is being dragged over a valid drop target (every few hundred milliseconds).

EventCallback<DragEventArgs>
DragStart

The DragStart event is fired when the user starts dragging an element or text selection.

EventCallback<DragEventArgs>
Drop

The drop event is fired when an element or text selection is dropped on a valid drop target.

EventCallback<DragEventArgs>

TableRowGroup

Event Description Type
Clicked

Notifies when the row is clicked.

EventCallback<MouseEventArgs>
ContextMenu

The event is fired when an element or text selection is right clicked to show the context menu.

EventCallback<MouseEventArgs>
DoubleClicked

Notifies when the row is double clicked.

EventCallback<MouseEventArgs>
Drag

The drag event is fired every few hundred milliseconds as an element or text selection is being dragged by the user.

EventCallback<DragEventArgs>
DragEnd

The DragEnd event is fired when a drag operation is being ended (by releasing a mouse button or hitting the escape key).

EventCallback<DragEventArgs>
DragEnter

The DragEnter event is fired when a dragged element or text selection enters a valid drop target.

EventCallback<DragEventArgs>
DragLeave

The DragLeave event is fired when a dragged element or text selection leaves a valid drop target.

EventCallback<DragEventArgs>
DragOver

The DragOver event is fired when an element or text selection is being dragged over a valid drop target (every few hundred milliseconds).

EventCallback<DragEventArgs>
DragStart

The DragStart event is fired when the user starts dragging an element or text selection.

EventCallback<DragEventArgs>
Drop

The drop event is fired when an element or text selection is dropped on a valid drop target.

EventCallback<DragEventArgs>
ExpandedChanged

Specifies if the group is expanded.

EventCallback<bool>

TableRowHeader

Event Description Type
Clicked

Notifies when the row header is clicked.

EventCallback<MouseEventArgs>
ContextMenu

The event is fired when an element or text selection is right clicked to show the context menu.

EventCallback<MouseEventArgs>
Drag

The drag event is fired every few hundred milliseconds as an element or text selection is being dragged by the user.

EventCallback<DragEventArgs>
DragEnd

The DragEnd event is fired when a drag operation is being ended (by releasing a mouse button or hitting the escape key).

EventCallback<DragEventArgs>
DragEnter

The DragEnter event is fired when a dragged element or text selection enters a valid drop target.

EventCallback<DragEventArgs>
DragLeave

The DragLeave event is fired when a dragged element or text selection leaves a valid drop target.

EventCallback<DragEventArgs>
DragOver

The DragOver event is fired when an element or text selection is being dragged over a valid drop target (every few hundred milliseconds).

EventCallback<DragEventArgs>
DragStart

The DragStart event is fired when the user starts dragging an element or text selection.

EventCallback<DragEventArgs>
Drop

The drop event is fired when an element or text selection is dropped on a valid drop target.

EventCallback<DragEventArgs>

TableHeader

Event Description Type
ContextMenu

The event is fired when an element or text selection is right clicked to show the context menu.

EventCallback<MouseEventArgs>
Drag

The drag event is fired every few hundred milliseconds as an element or text selection is being dragged by the user.

EventCallback<DragEventArgs>
DragEnd

The DragEnd event is fired when a drag operation is being ended (by releasing a mouse button or hitting the escape key).

EventCallback<DragEventArgs>
DragEnter

The DragEnter event is fired when a dragged element or text selection enters a valid drop target.

EventCallback<DragEventArgs>
DragLeave

The DragLeave event is fired when a dragged element or text selection leaves a valid drop target.

EventCallback<DragEventArgs>
DragOver

The DragOver event is fired when an element or text selection is being dragged over a valid drop target (every few hundred milliseconds).

EventCallback<DragEventArgs>
DragStart

The DragStart event is fired when the user starts dragging an element or text selection.

EventCallback<DragEventArgs>
Drop

The drop event is fired when an element or text selection is dropped on a valid drop target.

EventCallback<DragEventArgs>

TableHeaderCell

Event Description Type
Clicked

Notifies when the header cell is clicked.

EventCallback<MouseEventArgs>
ContextMenu

The event is fired when an element or text selection is right clicked to show the context menu.

EventCallback<MouseEventArgs>
Drag

The drag event is fired every few hundred milliseconds as an element or text selection is being dragged by the user.

EventCallback<DragEventArgs>
DragEnd

The DragEnd event is fired when a drag operation is being ended (by releasing a mouse button or hitting the escape key).

EventCallback<DragEventArgs>
DragEnter

The DragEnter event is fired when a dragged element or text selection enters a valid drop target.

EventCallback<DragEventArgs>
DragLeave

The DragLeave event is fired when a dragged element or text selection leaves a valid drop target.

EventCallback<DragEventArgs>
DragOver

The DragOver event is fired when an element or text selection is being dragged over a valid drop target (every few hundred milliseconds).

EventCallback<DragEventArgs>
DragStart

The DragStart event is fired when the user starts dragging an element or text selection.

EventCallback<DragEventArgs>
Drop

The drop event is fired when an element or text selection is dropped on a valid drop target.

EventCallback<DragEventArgs>

TableFooter

Event Description Type
ContextMenu

The event is fired when an element or text selection is right clicked to show the context menu.

EventCallback<MouseEventArgs>
Drag

The drag event is fired every few hundred milliseconds as an element or text selection is being dragged by the user.

EventCallback<DragEventArgs>
DragEnd

The DragEnd event is fired when a drag operation is being ended (by releasing a mouse button or hitting the escape key).

EventCallback<DragEventArgs>
DragEnter

The DragEnter event is fired when a dragged element or text selection enters a valid drop target.

EventCallback<DragEventArgs>
DragLeave

The DragLeave event is fired when a dragged element or text selection leaves a valid drop target.

EventCallback<DragEventArgs>
DragOver

The DragOver event is fired when an element or text selection is being dragged over a valid drop target (every few hundred milliseconds).

EventCallback<DragEventArgs>
DragStart

The DragStart event is fired when the user starts dragging an element or text selection.

EventCallback<DragEventArgs>
Drop

The drop event is fired when an element or text selection is dropped on a valid drop target.

EventCallback<DragEventArgs>

Methods

Table

Method DescriptionReturnParameters
ScrollToPixels If table has FixedHeader enabled, it will scroll position to the provided pixels. ValueTaskint pixels
ScrollToRow If table has FixedHeader enabled, it will scroll position to the provided row. ValueTaskint row
On this page