Virtualized Table beta

Along with evolutionary web development, table component has always been the most popular component in our web apps especially for dashboards, data analysis. For Table V1, with even just 1000 records of data, it can be very annoying when using it, because of the poor performance.

With Virtualized Table, you can render massive chunks of data in a blink of an eye.


This component is still under testing, use at your own risk. If you find any bugs or issues, please report them at GitHub for us to fix. Also there were some APIs which are not mentioned in this documentation, some of them were not fully developed yet, which is why they are not mentioned here.

Even though Virtualized Table is efficient, when the data load is too large, your network and memory size can become the bottleneck of your app. So keep in mind that Virtualized Table is never the ultimate solution for everything, consider paginating your data, adding filters etc.


This component requires the <client-only></client-only> wrap when used in SSR (eg: Nuxt) and SSG (eg: VitePress).

Basic usage

Let's demonstrate the performance of the Virtualized Table by rendering a basic example with 10 columns and 1000 rows.

Auto resizer

When you do not want to manually pass the width and height properties to the table, you can wrap the table component with the AutoResizer. This will automatically update the width and height for you.

Resize your browser to see how it works.


Make sure the parent node of the AutoResizer HAS A FIXED HEIGHT, since its default height value is set to 100%. Alternatively, you can define it by passing the style attribute to AutoResizer.

Customize Cell Renderer

Of course, you can render the table cell according to your needs. Here's a simple example of how to customize your cell.

Table with selections

Using customized cell renderer to allow selection for your table.

Inline editing

Just as we demonstrated with selections above, you can use the same method to enable inline editing.

Table with status

You can highlight your table content to distinguish between "success, information, warning, danger" and other states.

To customize the appearance of rows, use the row-class-name attribute. For example, every 10th row is highlighted using the bg-blue-200 class, and every 5th row with the bg-red-100 class.

Table with sticky rows

You can make some rows stick to the top of the table, and that can be very easily achieved by using the fixed-data attribute.

You can dynamically set the sticky row based on scroll events, as shown in this example.

Table with fixed columns

If you want to have columns stick to the left or right for some reason, you can achieve this by adding special attributes to the table.

You can set the column's attribute fixed to true (representing FixedDir.LEFT) or FixedDir.LEFT or FixedDir.RIGHT

Grouping header

By customizing your header renderer, you can group your header as shown in this example.


In this case we used JSX feature which is not supported in the playground. You may try them out in your local environment or on online IDEs such as codesandbox.

It is recommended that you write your table component in JSX, since it contains VNode manipulations.


Virtualized Table provides custom header renderers for creating customized headers. We can then utilize these to render filters.


You can sort the table with sort state.

Controlled Sort

You can define multiple sortable columns as needed. Keep in mind that if you define multiple sortable columns, the UI may appear confusing to your users, as it becomes unclear which column is currently being sorted.

Cross hovering

When dealing with a large list, it's easy to lose track of the current row and column you are visiting. In such cases, using this feature can be very helpful.


The virtualized table doesn't use the built-in table element, so colspan and rowspan behave a bit differently compared to TableV1. However, with a customized row renderer, these features can still be implemented. In this section, we'll demonstrate how to achieve this.


Since we have covered Colspan, it's worth noting that we also have row span. It's a little bit different from colspan but the idea is basically the same.

Rowspan and Colspan together

We can combine rowspan and colspan together to meet your business goal!

Tree data

Virtual Table can also render data in a tree-like structure. By clicking the arrow icon, you can expand or collapse the tree nodes.

Dynamic height rows

Virtual Table is capable of rendering rows with dynamic heights. If you're working with data and are uncertain about the content size, this feature is ideal for rendering rows that adjust to the content's height. To enable this, pass down the estimated-row-height attribute. The closer the estimated height matches the actual content, the smoother the rendering experience.


Each row's height is dynamically measured during rendering the rows. As a result, if you're trying to display a large amount of data, the UI might be bouncing.

Detail view

Using dynamic height rendering, you can also display a detailed view within the table.

Render a customized footer when you want to show a concluding message or information.

Customized Empty Renderer

Render a customized empty element.


Render an overlay on top of the table when you want to show a loading indicator or something else.

Manual scrolling

Use the methods provided by Table V2 to scroll manually/programmatically with desired offset/rows.


The second parameter for scrollToRow is the scrolling strategy which by default is auto, it calculates the position to scroll by itself. If you wish to scroll to a specific position, you can define the strategy yourself. The available options are "auto" | "center" | "end" | "start" | "smart"

The difference between smart and auto is that auto is a subset of smart scroll strategy.

TableV2 Attributes

cacheNumber of rows rendered in advance to boost the performanceNumber2
estimated-row-heightThe estimated row height for rendering dynamic height rowsNumber
header-classCustomized class name passed to header wrapperString/Function<HeaderClassGetter>
header-propsCustomized props name passed to header componentObject/Function<HeaderPropsGetter>
header-cell-propsCustomized props name passed to header cell componentObject/Function<HeaderCellPropsGetter>
header-heightThe height of the header is set by height. If given an array, it renders header rows equal to its lengthNumber/Array<Number>50
footer-heightThe height of the footer element, when provided, will be part to the calculation of the table's height.Number0
row-classCustomized class name passed to row wrapperString/Function<RowClassGetter>
row-keyThe key of each row, if not provided, will be the index of the rowString/Symbol/Numberid
row-propsCustomized props name passed to row componentObject/Function<RowPropsGetter>
row-heightThe height of each row, used for calculating the total height of the tableNumber50
cell-propsextra props passed to each cell (except header cells)Object/Function<CellPropsGetter>
columnsAn array of column definitions.Array<Column>
dataAn array of data to be rendered in the table.Array<Data>[]
data-getterA method to customize data fetch from the data source.Function
fixed-dataData for rendering rows above the main content and below the headerArray<Data>
expand-column-keyThe column key indicates which row is expandableString
expanded-row-keysAn array of keys for expanded rows, can be used with v-modelArray<KeyType>
default-expanded-row-keysAn array of keys for default expanded rows, NON REACTIVEArray<KeyType>
classClass name for the virtual table, will be applied to all three tables (left, right, main)String/Array/Object
fixedFlag indicates the table column's width to be fixed or flexible.Booleanfalse
width requiredWidth of the tableNumber
height requiredHeight of the tableNumber
max-heightMaximum height of the tableNumber
h-scrollbar-sizeIndicates the horizontal scrollbar's size for the table, used to prevent the horizontal and vertical scrollbar to collapseNumber6
v-scrollbar-sizeIndicates the vertical scrollbar's size for the table, used to prevent the horizontal and vertical scrollbar to collapseNumber6
scrollbar-always-onIf true, the scrollbar will always be shown instead of when mouse is placed above the tableBooleanfalse
sort-bySort indicatorObject<SortBy>{}
sort-stateMultiple sort indicatorObject<SortState>undefined

TableV2 Slots


TableV2 Events

column-sortInvoked when column sortedObject<ColumnSortParam>
expanded-rows-changeInvoked when expanded rows changedArray<KeyType>
end-reachedInvoked when the end of the table is reached
scrollInvoked after scrollingObject<ScrollParams>
rows-renderedInvoked when rows are renderedObject<RowsRenderedParams>
row-expandInvoked when expand/collapse the tree node by clicking the arrow iconObject<RowExpandParams>
row-event-handlersA collection of handlers attached to each rowObject<RowEventHandlers>

TableV2 Methods

Event NameDescriptionParameters
scrollToScroll to a given position{ scrollLeft?: number, scrollTop?: number}
scrollToLeftScroll to a given horizontal positionscrollLeft: number
scrollToTopScroll to a given vertical positionscrollTop: number
scrollToRowscroll to a given row with specified scroll strategyrow: number, strategy?: "auto" |"center" | "end" | "start" | "smart"


Note that these are JavaScript Objects, so you CANNOT USE kebab-case for these attributes

Column Attribute

alignAlignment of the table cell contentAlignmentleft
classClass name for the columnString
fixedFixed direction of the columnBoolean/FixedDirfalse
flexGrowCSSProperties flex grow, Only useful when this is not a fixed tableNumber0
flexShrinkCSSProperties flex shrink, Only useful when this is not a fixed tableNumber1
headerClassUsed for customizing header column classString
hiddenWhether the column is invisibleBoolean
styleCustomized style for column cell, will be merged with grid cellCSSProperties
sortableIndicates whether the column is sortableBoolean
titleThe default text rendered in header cellString
maxWidthMaximum width for the columnNumber
minWidthMinimum width for the columnNumber
width requiredWidth for the columnNumber
cellRendererCustomized Cell rendererVueComponent/(props: CellRenderProps) => VNode
headerCellRendererCustomized Header rendererVueComponent/(props: HeaderRenderProps) => VNode


Show Type Declarations
type HeaderClassGetter = (param: {
  columns: Column<any>[]
  headerIndex: number
}) => string

type HeaderPropsGetter = (param: {
  columns: Column<any>[]
  headerIndex: number
}) => Record<string, any>

type HeaderCellPropsGetter = (param: {
  columns: Column<any>[]
  column: Column<any>
  columnIndex: number
  headerIndex: number
  style: CSSProperties
}) => Record<string, any>

type RowClassGetter = (param: {
  columns: Column<any>[]
  rowData: any
  rowIndex: number
}) => string

type RowPropsGetter = (param: {
  columns: Column<any>[]
  rowData: any
  rowIndex: number
}) => Record<string, any>

type CellPropsGetter = (param: {
  column: Column<any>
  columns: Column<any>[]
  columnIndex: number
  cellData: any
  rowData: any
  rowIndex: number
}) => void

type CellRenderProps<T> = {
  cellData: T
  column: Column<T>
  columns: Column<T>[]
  columnIndex: number
  rowData: any
  rowIndex: number

type HeaderRenderProps<T> = {
  column: Column<T>
  columns: Column<T>[]
  columnIndex: number
  headerIndex: number

type ScrollParams = {
  xAxisScrollDir: 'forward' | 'backward'
  scrollLeft: number
  yAxisScrollDir: 'forward' | 'backward'
  scrollTop: number

type CellSlotProps<T> = {
  column: Column<T>
  columns: Column<T>[]
  columnIndex: number
  depth: number
  style: CSSProperties
  rowData: any
  rowIndex: number
  isScrolling: boolean
    | {
        rowData: any
        rowIndex: number
        onExpand: (expand: boolean) => void
    | undefined

type HeaderSlotProps = {
  cells: VNode[]
  columns: Column<any>[]
  headerIndex: number

type HeaderCellSlotProps = {
  class: string
  columns: Column<any>[]
  column: Column<any>
  columnIndex: number
  headerIndex: number
  style: CSSProperties
  headerCellProps?: any
  sortBy: SortBy
  sortState?: SortState | undefined
  onColumnSorted: (e: MouseEvent) => void

type RowCommonParams = {
  rowData: any
  rowIndex: number

type RowEventHandlerParams = {
  rowKey: KeyType
  event: Event
} & RowCommonParams

type RowEventHandler = (params: RowEventHandlerParams) => void
type RowEventHandlers = {
  onClick?: RowEventHandler
  onContextmenu?: RowEventHandler
  onDblclick?: RowEventHandler
  onMouseenter?: RowEventHandler
  onMouseleave?: RowEventHandler

type RowsRenderedParams = {
  rowCacheStart: number
  rowCacheEnd: number
  rowVisibleStart: number
  rowVisibleEnd: number

type RowSlotProps = {
  columns: Column<any>[]
  rowData: any
  columnIndex: number
  rowIndex: number
  data: any
  key: number | string
  isScrolling?: boolean
  style: CSSProperties

type RowExpandParams = {
  expanded: boolean
  rowKey: KeyType
} & RowCommonParams

type Data = {
  [key: KeyType]: any
  children?: Array<any>

type FixedData = Data

type KeyType = string | number | symbol

type ColumnSortParam<T> = { column: Column<T>; key: KeyType; order: SortOrder }

enum SortOrder {
  ASC = 'asc',
  DESC = 'desc',

type SortBy = { key: KeyType; Order: SortOrder }
type SortState = Record<KeyType, SortOrder>


How do I render a list with a checkbox in the first column?

Since you are allowed to define your own cell renderer, you can do what the example Customize Cell Renderer did to render checkbox yourself, and maintain the state by yourself.

Why does virtualized table provide less features than TableV1

For virtualized table, we intend to provide less feature and let our users implement their own features as needed. Integrating too many features makes the code hard to maintain and for most users the basic features are enough. Some key features were not developed yet. We would love to hear from you. Join Discord to stay tuned.