ui/docs/content/4.data/1.table.md

github, description

github	description
true	Display data in a table.

Usage

Use the rows prop to set the data to display in the table. By default, the table will display all the fields of the rows.

::component-example

padding: false overflowClass: 'overflow-x-auto'

#default :table-example-basic{class="flex-1"}

#code

<script setup>
const people = [{
  id: 1,
  name: 'Lindsay Walton',
  title: 'Front-end Developer',
  email: 'lindsay.walton@example.com',
  role: 'Member'
}, {
  id: 2,
  name: 'Courtney Henry',
  title: 'Designer',
  email: 'courtney.henry@example.com',
  role: 'Admin'
}, {
  id: 3,
  name: 'Tom Cook',
  title: 'Director of Product',
  email: 'tom.cook@example.com',
  role: 'Member'
}, {
  id: 4,
  name: 'Whitney Francis',
  title: 'Copywriter',
  email: 'whitney.francis@example.com',
  role: 'Admin'
}, {
  id: 5,
  name: 'Leonard Krasner',
  title: 'Senior Designer',
  email: 'leonard.krasner@example.com',
  role: 'Owner'
}, {
  id: 6,
  name: 'Floyd Miles',
  title: 'Principal Designer',
  email: 'floyd.miles@example.com',
  role: 'Member'
}]
</script>

<template>
  <UTable :rows="people" />
</template>

::

Columns

Use the columns prop to configure which columns to display. It's an array of objects with the following properties:

• label - The label to display in the table header. Can be changed through the column-attribute prop.
• key - The field to display from the row data.
• sortable - Whether the column is sortable. Defaults to false.
• direction - The sort direction to use on first click. Defaults to asc.

::component-example

padding: false overflowClass: 'overflow-x-auto'

#default :table-example-columns{class="flex-1"}

#code

<script setup>
const columns = [{
  key: 'id',
  label: 'ID'
}, {
  key: 'name',
  label: 'User name'
}, {
  key: 'title',
  label: 'Job position'
}, {
  key: 'email',
  label: 'Email'
}, {
  key: 'role'
}]

const people = [...]
</script>

<template>
  <UTable :columns="columns" :rows="people" />
</template>

::

You can easily use the SelectMenu component to change the columns to display.

::component-example

padding: false overflowClass: 'overflow-x-auto'

#default :table-example-columns-selectable{class="flex-1"}

#code

<script setup>
const columns = [{
  key: 'id',
  label: 'ID'
}, {
  key: 'name',
  label: 'Name'
}, {
  key: 'title',
  label: 'Title'
}, {
  key: 'email',
  label: 'Email'
}, {
  key: 'role',
  label: 'Role'
}]

const selectedColumns = ref([...columns])

const people = [...]
</script>

<template>
  <div>
    <USelectMenu v-model="selectedColumns" :options="columns" multiple placeholder="Columns" />

    <UTable :columns="selectedColumns" :rows="people" />
  </div>
</template>

::

Sortable

You can make the columns sortable by setting the sortable property to true in the column configuration.

::component-example

padding: false overflowClass: 'overflow-x-auto'

#default :table-example-columns-sortable{class="flex-1"}

#code

<script setup>
const columns = [{
  key: 'id',
  label: 'ID'
}, {
  key: 'name',
  label: 'Name',
  sortable: true
}, {
  key: 'title',
  label: 'Title',
  sortable: true
}, {
  key: 'email',
  label: 'Email',
  sortable: true,
  direction: 'desc'
}, {
  key: 'role',
  label: 'Role'
}]

const people = [...]
</script>

<template>
  <UTable :columns="columns" :rows="people" :sort="{ column: 'title' }" />
</template>

::

You can specify the default direction of each column through the direction property. It can be either asc or desc and defaults to asc.

You can specify a default sort for the table through the sort prop. It's an object with the following properties:

• column - The column to sort by.
• direction - The sort direction. Can be either asc or desc and defaults to asc.

::alert{icon="i-heroicons-light-bulb"} This will set the default sort and will work even if no column is set as sortable. ::

Use the sort-button prop to customize the sort button in the header. You can pass all the props of the Button component to customize it through this prop or globally through ui.table.default.sortButton. Its icon defaults to i-heroicons-arrows-up-down-20-solid.

::component-card

padding: false overflowClass: 'overflow-x-auto' baseProps: class: 'w-full' columns: - key: 'id' label: 'ID' - key: 'name' label: 'Name' sortable: true - key: 'title' label: 'Title' sortable: true - key: 'email' label: 'Email' sortable: true - key: 'role' label: 'Role' rows: - id: 1 name: 'Lindsay Walton' title: 'Front-end Developer' email: 'lindsay.walton@example.com' role: 'Member' - id: 2 name: 'Courtney Henry' title: 'Designer' email: 'courtney.henry@example.com' role: 'Admin' - id: 3 name: 'Tom Cook' title: 'Director of Product' email: 'tom.cook@example.com' role: 'Member' - id: 4 name: 'Whitney Francis' title: 'Copywriter' email: 'whitney.francis@example.com' role: 'Admin' - id: 5 name: 'Leonard Krasner' title: 'Senior Designer' email: 'leonard.krasner@example.com' role: 'Owner' - id: 6 name: 'Floyd Miles' title: 'Principal Designer' email: 'floyd.miles@example.com' role: 'Member' props: sortAscIcon: 'i-heroicons-arrow-up-20-solid' sortDescIcon: 'i-heroicons-arrow-down-20-solid' sortButton: icon: 'i-heroicons-sparkles-20-solid' color: 'primary' variant: 'outline' size: '2xs' ui: rounded: 'rounded-full' excludedProps:

• sortButton
• sortAscIcon
• sortDescIcon

---

::

Use the sort-asc-icon prop to set a different icon or change it globally in ui.table.default.sortAscIcon. Defaults to i-heroicons-bars-arrow-up-20-solid.

Use the sort-desc-icon prop to set a different icon or change it globally in ui.table.default.sortDescIcon. Defaults to i-heroicons-bars-arrow-down-20-solid.

::alert{icon="i-heroicons-light-bulb"} You can also customize the entire header cell, read more in the Slots section. ::

Selectable

Use a v-model to make the table selectable. The v-model will be an array of the selected rows.

::component-example

padding: false overflowClass: 'overflow-x-auto'

#default :table-example-selectable{class="flex-1"}

#code

<script setup>
const people = [...]

const selected = ref([people[1]])
</script>

<template>
  <UTable v-model="selected" :rows="people" />
</template>

::

::alert{icon="i-heroicons-light-bulb"} You can use the by prop to compare objects by a field instead of comparing object instances. We've replicated the behavior of Headless UI Combobox. ::

Searchable

You can easily use the Input component to filter the rows.

::component-example

padding: false overflowClass: 'overflow-x-auto'

#default :table-example-searchable{class="flex-1"}

#code

<script setup>
const people = [...]

const q = ref('')

const filteredRows = computed(() => {
  if (!q.value) {
    return people
  }

  return people.filter((person) => {
    return Object.values(person).some((value) => {
      return String(value).toLowerCase().includes(q.value.toLowerCase())
    })
  })
})
</script>

<template>
  <div>
    <UInput v-model="q" placeholder="Filter people..." />

    <UTable :rows="filteredRows" />
  </div>
</template>

::

Slots

You can use slots to customize the header and data cells of the table.

Header

Use the #<column>-header slot to customize the header cell of a column. You will have access to the column, sort and on-sort properties in the slot scope.

The sort property is an object with the following properties:

• field - The field to sort by.
• direction - The direction to sort by. Can be asc or desc.

The on-sort property is a function that you can call to sort the table and accepts the column as parameter.

::alert{icon="i-heroicons-light-bulb"} Even though you can customize the sort button as mentioned in the Sortable section, you can use this slot to completely override its behavior, with a custom dropdown for example. ::

Data

Use the #<column>-data slot to customize the data cell of a column. You will have access to the row and column properties in the slot scope.

Example

You can for example create an extra column for actions with a Dropdown component inside or change the color of the rows based on a selection.

::component-example

padding: false overflowClass: 'overflow-x-auto'

#default :table-example-slots{class="flex-1"}

#code

<script setup>
const columns = [..., {
  key: 'actions'
}]

const people = [...]

const items = (row) => [
  [{
    label: 'Edit',
    icon: 'i-heroicons-pencil-square-20-solid',
    click: () => console.log('Edit', row.id)
  }, {
    label: 'Duplicate',
    icon: 'i-heroicons-document-duplicate-20-solid'
  }], [{
    label: 'Archive',
    icon: 'i-heroicons-archive-box-20-solid'
  }, {
    label: 'Move',
    icon: 'i-heroicons-arrow-right-circle-20-solid'
  }], [{
    label: 'Delete',
    icon: 'i-heroicons-trash-20-solid'
  }]
]

const selected = ref([people[1]])
</script>

<template>
  <UTable v-model="selected" :rows="people" :columns="columns">
    <template #name-data="{ row }">
      <span :class="[selected.find(person => person.id === row.id) && 'text-primary-500 dark:text-primary-400']">{{ row.name }}</span>
    </template>

    <template #actions-data="{ row }">
      <UDropdown :items="items(row)">
        <UButton color="gray" variant="ghost" icon="i-heroicons-ellipsis-horizontal-20-solid" />
      </UDropdown>
    </template>
  </UTable>
</template>

::

Props

:component-props

Preset

:component-preset