Skip to content

Props

title

NameTypeDefault OptionsDescription
titleString""Table-title

is-slot-mode

NameTypeDefault OptionsDescription
is-slot-modeBooleanfalseIf you want to use v-slot (V-slot Mode), set TRUE.

is-static-mode

NameTypeDefault OptionsDescription
is-static-modeBooleanfalseIf you do not need to use ajax or axios to get any data, set TRUE.

has-checkbox

NameTypeDefault OptionsDescription
has-checkboxBooleanfalseShow checkbox on rows

checked-return-type

NameTypeDefault OptionsDescription
checked-return-typeString"key"Return checked row data's type

is-loading

NameTypeDefault OptionsDescription
is-loadingBooleanfalseShow loading mask (Not required on is-static-mode)
NameTypeDefault OptionsDescription
is-re-searchBooleanfalseIf you reload data, set true (Not required on is-static-mode)

is-fixed-first-column

NameTypeDefault OptionsDescription
is-fixed-first-columnBooleanfalseFixed first column on scrolling

max-height

NameTypeDefault OptionsDescription
max-heightString"auto"Table's max height

columns Required

NameTypeDefault OptionsDescription
columnsArraynullThe table columns
More Options

Some more options related to columns.

NameTypeDefault OptionsDescription
isKeyBooleanfalseIf the field is the primary key, set to true
labelStringnullField label for display (HTML support)
fieldStringnullRow field keyname
widthStringnullField's width size
sortableBooleanfalseIf the field can be sorted, set to true
displayFunctionnullYou can customize the display data in there (HTML tag or Etc.)
headerClassesArraynullData header's classes array
columnClassesArraynullData column's classes array
headerStylesObjectnullData header's in-line style object
columnStylesObjectnullData column's in-line style object

rows Required

NameTypeDefault OptionsDescription
rowsArraynullRecords

rowClasses

NameTypeDefault OptionsDescription
rowClassesArray/Functionnull<tr/> tag's classes

total Required

NameTypeDefault OptionsDescription
totalNumbernullRecords count

sortable Required

NameDescriptionRequiredType
orderOrder field and sort for SortableYesstring
More Options

Some more options related to sortable.

NameDescriptionRequiredType
orderOrder field and sort for SortableYesstring
sortSortable value for the databaseYesstring

messages

NameDescriptionRequiredType
messagesLocale's messagesNoObject
More Options

Some more options related to messages.

NameDescriptionRequiredTypeDefault Options
pagingInfoLocale's messagesNostring"Showing {0}-{1} of {2}"
pageSizeChangeLabelLocale's messagesNostring"Row count:"
gotoPageLabelLocale's messagesNostring"Go to page:"
noDataAvailableLocale's messagesNostring"No data"

is-hide-paging

NameDescriptionRequiredTypeDefault Options
is-hide-pagingNot Show paging information on bottomNoBooleanfalse

page

NameDescriptionRequiredTypeDefault Options
pageIf you want to control the page number yourself, use this to change the page number.NoNumber1

page-size

NameDescriptionRequiredTypeDefault Options
page-sizeDefault display the number of items on one page. In most cases, no set required.NoNumber10

pageOptions

NameDescriptionRequiredTypeDefault Options
pageOptionsOption list for pages dropdownNoArray[ { value: 10, text: 10 }, { value: 25, text: 25 }, { value: 50, text: 50 } ]
More Options

Some more options related to pageOptions.

FieldRequiredType
valueYesNumber
textYesNumber | string

grouping-key

NameDescriptionRequiredTypeDefault Options
grouping-keyIf you want to use a grouping table, set the name of your grouping field.Nostringnull

has-group-toggle

NameDescriptionRequiredTypeDefault Options
has-group-toggleShow group toggle if you're using a grouping table.NoBooleanfalse

grouping-display

NameDescriptionRequiredTypeDefault Options
grouping-displayCustomize grouping title display if you're using a grouping table.NoFunctionnull

start-collapsed

NameDescriptionRequiredTypeDefault Options
start-collapsedGrouping rows will be collapsed after the initialNoBooleanfalse

is-keep-collapsed

NameDescriptionRequiredTypeDefault Options
is-keep-collapsedKeep collapsed status after refreshNoBooleanfalse