Skip to content

VDataGrid

Props

NameTypeDescription
cell-item-template@microsoft/fast-element#ViewTemplate<any, any>Templete to use when rendering cells
column-definitionsEnum:
{columnDataKey: string; gridColumn?: string; title?: string; headerCellTemplate?: @microsoft/fast-element#ViewTemplate<any, any>; headerCellInternalFocusQueue?: false
true; headerCellFocusTargetCallback?: ((cell: @vonage/vivid#VwcDataGridCellElement) => HTMLElement); cellTemplate?: @microsoft/fast-element#ViewTemplate<any, any>; cellInternalFocusQueue?: false | true; cellFocusTargetCallback?: ((cell: @vonage/vivid#VwcDataGridCellElement) => HTMLElement); isRowHeader?: false | true}[]
Configure the grid header columns
fixed-columnsnumberSets the number of columns fixed to the left when horizontal scrolling
focus-column-indexnumberIndex of column to be focused on when the Data Grid receives focus
focus-row-indexnumberIndex of row to be focused on when the Data Grid receives focus
generate-headerEnum:
none
default
sticky
Whether the grid should automatically generate a header row and its type
grid-template-columnsstringString that gets applied to the css gridTemplateColumns attribute of child rows
header-cell-item-template@microsoft/fast-element#ViewTemplate<any, any>Templete to use when rendering grid header cells
no-tabbingbooleanRemove the grid from the tab order
row-element-tagstringElement tag for header rows
row-item-template@microsoft/fast-element#ViewTemplate<any, any>Templete to use when rendering rows
rows-dataobject[]Content of the grid in data format
selection-modeEnum:
none
single-row
multi-row
single-cell
multi-cell
Set the selection mode

Events

NameEvent TypeDescription
cell-clickCustomEvent<{cell: HTMLElement, row: HTMLElement, isHeaderCell: boolean, columnDataKey: string}>Event that fires when a cell is clicked

Slots

NameDescription
defaultDefault slot.