Skip to content
On this page

Checkboxs

Checkboxs allow you to select rows in the table.

TIP

By default, checkboxs option is disabled.

Version 0.0.6 and below

Since version 0.0.7, the key field isn't mandatory anymore.

For version 0.0.6 and below, to make use of checkboxs, each row must have a key field with a unique value. You can use uuid for that, or any other library that can generate random unique values.

Enabling / disabling checkboxs

To enable / disable checkboxs, simply set the enableCheckbox option to either true or false (default):

vue
<template>
  <ModernTable
    :columns="[
      { label: 'Country', field: 'country' },
      { label: 'Capital', field: 'capital' }
    ]"
    :rows="[
      { country: 'Ukraine', capital: 'Kiev' },
      { country: 'France', capital: 'Paris' },
      { country: 'Germany', capital: 'Berlin' }
    ]"
    :options="{ enableCheckbox: true }" 
  />
</template>
Country
Capital
Ukraine
Kiev
France
Paris
Germany
Berlin
1 - 3 / 3

Accessing selected rows

You can access selected rows using the checked-row-keys model value:

vue
<script setup>
import { ref } from 'vue'

const checkedRowKeys = ref([]) 
</script>

<template>
  <ModernTable
    :columns="[
      { label: 'Country', field: 'country' },
      { label: 'Capital', field: 'capital' }
    ]"
    :rows="[
      { country: 'Ukraine', capital: 'Kiev' },
      { country: 'France', capital: 'Paris' },
      { country: 'Germany', capital: 'Berlin' }
    ]"
    :options="{ enableCheckbox: true }"
    v-model:checked-row-keys="checkedRowKeys" 
  />
</template>
Country
Capital
Ukraine
Kiev
France
Paris
Germany
Berlin
1 - 3 / 3
Selected row keys:
[]

TIP

The array will contain keys of each selected rows, so it's up to you to match them with the original row.