Virtualized Table beta

Along with the 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 the poor performance.

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

TIP

This component is still under testing, use at your own risk. if you found any bug or issue please report it at GitHub for us to fix. Also there were some APIs which was not mentioned in this documentation, some of them were not fully developed yet, so that we are not mentioning them here.

Even though Virtualized Table is efficient, but when the data load is too big, your network, memory size can be the bottle neck of your app. So keep in mind that Virtualized Table is never the ultimate solution for everything, consider paginate your data, add filters etc.

Basic usage

Let's render a basic case of Virtualized Table with 10 columns by 1000 rows, to demonstrate how performant it is.

Auto resizer

When you do not feel like you want to pass the width and height property to the table, you can use the AutoResizer component to wrap the table component and it will update the width and height for you automatically.

Resize your browser to see how it works.

TIP

Make sure the parent node of AutoResizer HAS A FIXED HEIGHT, because the height value was set to 100% by default. You may also set it via passing through style attribute to AutoResizer.

Customize Cell Renderer

Of course, you can render the table cell per your needs, here is 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 like selections we demonstrated 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.

Use row-class-name to customize how the row looks. In this case, every 10th row will be highlighted with bg-blue-200 class, every 5th row will be highlighted with 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 fixed-data attribute.

You can add dynamically set the sticky row with scroll events like this example did.

Table with fixed columns

For some reason, you want to make the columns stick on the left and right, you can do that by adding special attributes for 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 like this example did.

TIP

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

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

Filter

Virtualized Table providers customizing header renderers for rendering customized header, then we can use that to render filters

Sortable

You can sort the table with sort state.

Controlled Sort

You can define multiple sortable column when you need it. Keep in mind that if you define multiple sortable columns, the UI might seem strange to your users since the it is unclear which column is being sorted.

Cross hovering

When the list is big, and sometimes you get lost which row and column you are currently visiting, using this is extremely helpful.

Colspan

Virtualized table did not use built-in table element, so that colspan and rowspan is a little bit different than TableV1. With customized row renderer, we can still do that. In this case, you'll learn how to do that.

Rowspan

Since we have Colspan of course we have row span as well, it is a little bit different than 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 like tree, you can expand/collapse the tree node by clicking the arrow icon.

Dynamic height rows

Virtual Table can also render rows with dynamic height, when you have data without knowing how big the content it would be, you might want to use this feature for rendering a dynamic height row. You must pass down estimated-row-height to enable this feature, and the closer the estimated height is, the smoother the rendering will be.

TIP

The height of each row is dynamically measured while rendering the rows, so that the UI might be bouncing if you are trying to render a large amount of data.

Detail view

With dynamic height rendering, we can use that to render detail view in the table.

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

Customized Empty Renderer

Render customized empty element

Overlay

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

Manual scrolling

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

TIP

The second parameter for scrollToRow is the scrolling strategy which by default is auto, it calculates the position to scroll by itself. You can pass the strategy yourselves if you want to scroll to a specific position. 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

AttributeDescriptionTypeDefault
cacheNumber of rows rendered in advance for boosting 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 entire header, when it's array, it will render as many header rows as the given array's lengthNumber/Array<Number>50
footer-heightThe height of the footer element, when presented, it will be part of 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, it 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-getterAn method which helps customizing the how to fetch the data 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 the virtual table, will be applied to all three tables (left, right, main)String/Array/Object-
fixedFlag indicates the table column's width is a fixed or flexible.Booleanfalse
width *Width for the table, requiredNumber-
height *Height for the table, requiredNumber-
max-heightMaximum height for 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 horizontal 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

NameParams
cellCellSlotProps
headerHeaderSlotProps
header-cellHeaderCellSlotProps
rowRowSlotProps
footer-
empty-
overlay-

Table Events

Event NameDescriptionParameters
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 scrolledObject<ScrollParams>
rows-renderedInvoked when rows are renderedObject<RowsRenderedParams>
row-event-handlersA collection of handlers attached to each rowObject<RowEventHandlers>

Table 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"

TIP

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

Column Attribute

AttributeDescriptionTypeDefault
alignAlignment of the table cell contentAlignmentleft
classClass name for the columnString-
fixedFixed direction of the columnBoolean/FixedDirfalse
flexGrowCSSProperties flex grow, Only useful when not this is not a fixed tableNumber0
flexShrinkCSSProperties flex shrink, Only useful when not 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 columnString-
minWidthMinimum width for the columnString-
width *Width for the column RequiredNumber-
cellRendererCustomized Cell rendererVueComponent/(props: CellRenderProps) => VNode-
headerRendererCustomized Header rendererVueComponent/(props: HeaderRenderProps) => VNode-

Typings

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
  expandIconProps?:
    | {
        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 RowSlotProps = {
  columnIndex: number
  rowIndex: number
  data: any
  key: number | string
  isScrolling?: boolean | undefined
  style: CSSProperties
}

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>

FAQs

How do I render a list with 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 yourselves, and maintaining the state by yourselves.

Why virtualized table provides less features than TableV1

For virtualized table, we intend to provide less feature and let our users to implement their own features per demand. 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.

Source

ComponentDocs

Contributors