Skip to content

VDatatableServerPlus API

All base VDataTableServer props/events/slots are supported. Use table-height instead of height.

Component

VDatatableServerPlus

Props

NameTypeDefaultDetails
headersrequiredHeader model used by the column menu, filter row, and grouping UI.
titleundefinedTitle text in the toolbar.
hide-title-barfalseHide toolbar including title and header commands.
hide-column-menufalseHide column menu button and popup.
drag-menu-height250Max height for column menu popup list.
column-menu-z-indexundefinedCustom z-index for column menu.
drag-menu-icon$menuColumn menu activator icon.
drag-item-iconmdi-drag-verticalDrag icon in column menu rows.
drag-item-freeze-iconmdi-table-lockFreeze icon in column menu rows.
drag-item-un-freeze-iconmdi-tableUnfreeze icon in column menu rows.
hide-filter-rowfalseHide column-level filter row.
filter-iconmdi-filterFilter type menu icon.
filter-menu-z-indexundefinedCustom z-index for filter menu.
hide-footerfalseHide pagination footer.
show-right-panelfalseEnable splitter and show right panel slot.
right-panel-fixedtrueDisable/enable splitter dragging.
right-panel-width20Initial right panel width in percent.
table-height50vhMain table height.
select-on-rowfalseToggle row selection on row click.
highlight-rowfalseEnable selected row highlight behavior.
row-highlight-classundefinedClass used when row highlight is enabled.
selected-rownullSelected row model (`v-model:selected-row`).
header-text-sizeundefinedHeader text font size.
header-icon-sizeundefinedHeader icon font size.
header-cell-classundefinedCustom class for both header and filter-row cells.
header-cell-styleundefinedCustom inline style for both header and filter-row cells.
table-classundefinedCustom class for internal `v-data-table-server` root.
table-styleundefinedCustom style for internal `v-data-table-server` root.
right-panel-classundefinedCustom class for right panel container.
right-panel-styleundefinedCustom style for right panel container.
data-table-props{}Pass-through props spread to internal `v-data-table-server`.
group-by-iconmdi-table-plusGroup-by toggle icon.
group-sort-asc-iconmdi-sort-ascendingGroup sort ascending icon.
group-sort-desc-iconmdi-sort-descendingGroup sort descending icon.

Events

NamePayloadDetails
update:selectedRowanyEmits when `selected-row` changes.
click:row{ $event, param }Fires on row click.
columnMenuOpenedbooleanColumn menu open state changed.
columnMenuDragChange{ moved: { element, oldIndex, newIndex } }Column reordered from drag-and-drop.
columnMenuChecked{ element, $event }Column show/hide checkbox changed.
columnMenuFixed{ element, $event }Column freeze/unfreeze toggled.

Slots

NameSlot PropsDetails
title-Toolbar title area.
header-commands{ clearSearch }Right side of toolbar actions.
header-expand-section-Area between toolbar and table.
footer-append-Footer append area after pagination text.
right-panel-Right panel content when splitter is enabled.
bottom-area-Bottom area below table/splitter.