# ListView

# Props

Prop name Description Type Values Default Required
hide-filter-button bool()
icon custom(isFontAwesome) false
per-page number() false
active-id The id of a row that is currently active. Will be automatically scrolled into view. string() false
defaults Default values for the ListViewFilters. The id of the filter should exist in the /metadata-call, otherwise it will not be applied arrayOf(shape({ id: string(), value: any(), values: any(), type: string() }))
supported-filter-types The types that are supported in the ListViewFilters. It is not recommended to override this prop. array() false
excluded-filters Add a list of filters that you do not want to show in the ListViewFilters, should always include the QuickSearch or it will show a duplicate QuickSearch array() false
title string() true
line-numbers bool() false
column-options array() false
group-options shape false
data-transform-fn Is called from setRecords, if the property is set with a func oneOfType [bool( false
max-height string() false
mode oneOf ['remote', 'local'] false
distance-offset number() false
url string() true
additional-sort-options object() false
additional-select-options object() false
row-style-class-fn Is called in handleRowStyling oneOfType [string( false
minimize-new-button bool() false
hide-new-button bool() false
header-row bool() false

# Events

Event name Properties Description
on-create-clicked
on-row-click
on-active-row-change
on-select-all
on-cell-click
on-row-dblclick
on-selected-rows-change
on-sort-change

# Slots

Name Description Bindings
buttons
default
header-row

<ListView>Default Example Usage</ListView>