Skip to content

Table Static

Classic style Table.

Usage

Simple Usage

Id Name Status
1Tarjonotrue
2Renattafalse
3Jonathan Smithtrue
4Arch Browntrue
preview
vue
<template class="flex-col space-y-2">
  <p-table-static :fields="fields" :items="items" />
</template>

<script setup>
import { defineTable } from '@privyid/persona/core'

const fields = defineTable([
  'id',
  'name',
  'status',
])

const items = ref([
  {
    id    : 1,
    name  : 'Tarjono',
    status: true,
  },
  {
    id    : 2,
    name  : 'Tarjono',
    status: false,
  },
  {
    id    : 3,
    name  : 'Tarjono',
    status: true,
  },
  {
    id    : 4,
    name  : 'Tarjono',
    status: true,
  },
])
</script>

Custom Label + Formatter

PrivyID Name Is Active
1TarjonoActive
2RenattaDeactive
3Jonathan SmithActive
4Arch BrownActive
preview
vue
<template class="flex-col space-y-2">
  <p-table-static :fields="fields" :items="items" />
</template>

<script setup>
import { defineTable } from '@privyid/persona'

const fields = defineTable([
  {
    key    : 'id',
    label  : 'PrivyID',
    width  : '1%',
    tdClass: 'text-center',
  },
  {
    key  : 'name',
    label: 'Name',
  },
  {
    key      : 'status',
    label    : 'Is Active',
    formatter: (value) => value ? 'Active': 'Deactive',
  },
])

const items = ref([
  {
    id    : 1,
    name  : 'Tarjono',
    status: true,
  },
  {
    id    : 2,
    name  : 'Tarjono',
    status: false,
  },
  {
    id    : 3,
    name  : 'Tarjono',
    status: true,
  },
  {
    id    : 4,
    name  : 'Tarjono',
    status: true,
  },
])
</script>

Apperance

There are 2 variants: table and card, default is table

Id Name Status
1Tarjonotrue
2Renattafalse
3Jonathan Smithtrue
4Arch Browntrue
preview
vue
<template>
  <p-table-static :fields="fields" :items="items" apperance="card" />
</template>

Hide Label Header

1Tarjonotrue
2Renattafalse
3Jonathan Smithtrue
4Arch Browntrue
preview
vue
<template>
  <p-table-static :fields="fields" :items="items" no-label />
</template>

Selectable

Add prop selectable to enable checkbox inside table

Id Name Status
1Tarjonotrue
2Renattafalse
3Jonathan Smithtrue
4Arch Browntrue
preview
vue
<template>
  <p-table-static selectable :fields="fields" :items="items" />
</template>

Binding v-model

The result of selected item is bind inside v-model

Id Name Status
1Tarjonotrue
2Renattafalse
3Jonathan Smithtrue
4Arch Browntrue
preview
vue
<template>
  <p-table-static v-model="selected" selectable :fields="fields" :items="items" />
</template>

Selected :

[]

Disabling some item

set _selectable to false in your items to disabled item from selection.

Id Name Status
1Tarjonotrue
2Tarjonofalse
3Tarjonotrue
4Can't be selectedtrue
preview
vue
<template>
  <p-table-static v-model="selectedA" selectable :fields="fields" :items="items" />
</template>

<script setup>
  const items = ref([
    {
      id    : 1,
      name  : 'Tarjono',
      status: true,
    },
    {
      id    : 2,
      name  : 'Tarjono',
      status: false,
    },
    {
      id    : 3,
      name  : 'Tarjono',
      status: true,
    },
    {
      id         : 4,
      name       : 'Can\'t be selected',
      status     : true,
      _selectable: false,
    },
  ])
</script>

Draggable

add prop draggable to enable drag-to-sort.

Id Name Status
1Tarjonotrue
2Renattafalse
3Jonathan Smithtrue
4Arch Browntrue
preview
vue
<template>
  <p-table-static :fields="fields" v-model:items="items" draggable />
</template>

Sortable

to support sortable field, you need to add prop sortable and when define table fields, add sortable with true value on field item

Id Name Gender Age
1Davidmale27
2Evanmale20
3Janefemale30
4Andimale21
5Bellafemale24
preview
vue
<template>
  <p-table-static sortable :fields="fields" v-model:items="items" />
</template>

<script setup>
  const fields = defineTable([
    { key: 'id' },
    {
      key     : 'name',
      sortable: true,
    },
    {
      key     : 'gender',
      sortable: true,
    },
    {
      key     : 'age',
      sortable: true,
    },
  ])

  const items = ref([
    {
      id    : 1,
      name  : 'David',
      gender: 'male',
      age   : 27,
    },
    {
      id    : 2,
      name  : 'Evan',
      gender: 'male',
      age   : 20,
    },
    {
      id    : 3,
      name  : 'Jane',
      gender: 'female',
      age   : 30,
    },
    {
      id    : 4,
      name  : 'Andi',
      gender: 'male',
      age   : 21,
    },
    {
      id    : 5,
      name  : 'Bella',
      gender: 'female',
      age   : 24,
    },
  ])
</script>

Customization Slot

Custom Cell

Id Name Status
1
Avatar Image
Tarjono
active
2
Avatar Image
Renatta
inactive
3
Avatar Image
Jonathan Smith
active
4
Avatar Image
Arch Brown
active
preview
vue
<template>
  <p-table-static :fields="fields" :items="items">
    <template #cell(name)="{ item }">
      <div class="flex items-center space-x-2">
        <p-avatar size="sm" :name="item.name" />
        <span>{{ item.name }}</span>
      </div>
    </template>
    <template #cell(status)="{ item }">
      <p-label
        variant="light" :color="item.status ? 'success' : 'default'"
        size="sm">
        {{ item.status ? 'active' : 'inactive' }}
      </p-label>
    </template>
  </p-table-static>
</template>

Custom Head

Id Name Status
new
1Tarjonotrue
2Renattafalse
3Jonathan Smithtrue
4Arch Browntrue
preview
vue
<template>
  <p-table-static :fields="fields" :items="items">
    <template #head(status)="{ label }">
      {{ label }}<p-label size="xs" class="ml-1">new</p-label>
    </template>
  </p-table-static>
</template>

Custom Empty

Table has default empty state, but it's be able to customize by own via slot empty.

Id Name Status
Uh oh, no data
We're empty-handed!
preview
vue
<template>
  <p-table-static :fields="fields" :items="items">
    <template #empty>
      <div class="flex flex-col items-center justify-center">
        <img src="/assets/images/img-table-empty-records.svg">
        <p-heading element="h6" class="mt-12">Uh oh, no data</p-heading>
        <p-text variant="body2" class="py-4 text-subtle dark:text-dark-subtle">
          We're empty-handed!
        </p-text>
      </div>
    </template>
  </p-table-static>
</template>

Variables

Table use local CSS variables for enhanced real-time customization.

sass
--p-table-bg: theme(backgroundColor.default.DEFAULT);
--p-table-bg-dark: theme(backgroundColor.dark.default.DEFAULT);
--p-table-header-bg: var(--p-table-bg);
--p-table-header-bg-dark: var(--p-table-bg-dark);
--p-table-border: theme(borderColor.default.DEFAULT);
--p-table-border-dark: theme(borderColor.dark.default.DEFAULT);

Example

Id Name Status
1Tarjonotrue
2Renattafalse
3Jonathan Smithtrue
4Arch Browntrue
preview
vue
<template>
  <p-table-static
    :fields="fields"
    :items="items"
    style="
      --p-table-header-bg: #F3F3F3;
      --p-table-header-bg-dark: #0D1117;
    " />
</template>

API

Props

PropsTypeDefaultDescription
apperanceStringtableTable apperance variant, valid value is table, card
itemsArray-Table items
fieldsArray-Table fields
selectableBooleanfalseEnable checkbox
draggableBooleanfalseEnable draggable
v-modelArray-v-model for selected value
empty-labelStringThere are no records to showTable empty state label
no-labelBooleanfalseHide headerlabel
table-classString-Add class to table element
tr-classString-Add class to table row element
scrollableBooleantrueEnable scroll when table overflow
sortableBooleanfalseEnable sort items by field name

In props fields contain

PropsTypeDescription
keyStringField's key
label?StringField's Label
width?NumberField's width in percent
formatter?FunctionField's formatter, it receives value and item params and returning string value
thClass?HTMLAttributesHTMLAttributes of class to use in table column cell
tdClass?HTMLAttributesHTMLAttributes of class to use in table head cell
sortable?BooleanEnable field sorting. Eventhough table have sortable prop, but the field not set sortable, sort function not able to use

Slots

NameDescription
cell(:key)Content for checked label
head(:key)Content for unchecked label
emptyContent for empty state
rowCustom render for row

Events

NameArgumentsDescription
There no props here

See Also

Released under the MIT License.