Using the HotColumn component in Vue 3

Table of contents

• Overview
• Declaring column settings
• Array of objects

Overview

You can configure column-related settings using the HotColumn component's attributes.

Find out which Vue 3 versions are supported →

Declaring column settings

To declare column-specific settings, pass the settings as hot-column properties, either separately or wrapped as a settings property, exactly as you would for hot-table.

import { createApp } from 'vue'; import { HotTable, HotColumn } from '@handsontable/vue3'; import { registerAllModules } from 'handsontable/registry'; import { createSpreadsheetData } from './helpers'; // register Handsontable's modules registerAllModules(); const app = createApp({ data() { return { hotSettings: { data: createSpreadsheetData(10, 10), height: 'auto', licenseKey: 'non-commercial-and-evaluation', }, secondColumnSettings: { title: 'Second column header', }, }; }, components: { HotTable, HotColumn, } }); app.mount('#example1'); <script src="https://cdn.jsdelivr.net/npm/handsontable@11.1/dist/handsontable.full.min.js"></script> <link type="text/css" rel="stylesheet" href="https://cdn.jsdelivr.net/npm/handsontable@11.1/dist/handsontable.full.min.css" /> <script src="https://cdn.jsdelivr.net/npm/vue@3/dist/vue.global.prod.js"></script> <script src="https://cdn.jsdelivr.net/npm/@handsontable/vue3@11.1/dist/vue-handsontable.min.js"></script> <script src="https://handsontable.com/docs/11.1/scripts/fixer.js"></script> <script src="https://handsontable.com/docs/11.1/scripts/helpers.js"></script> <div id="example1"> <hot-table :settings="hotSettings"> <hot-column title="First column header"> </hot-column> <hot-column :settings="secondColumnSettings" read-only="true"> </hot-column> </hot-table> </div>

import { createApp } from 'vue';
import { HotTable, HotColumn } from '@handsontable/vue3';
import { registerAllModules } from 'handsontable/registry';
import { createSpreadsheetData } from './helpers';

// register Handsontable's modules
registerAllModules();

const app = createApp({
  data() {
    return {
      hotSettings: {
        data: createSpreadsheetData(10, 10),
        height: 'auto',
        licenseKey: 'non-commercial-and-evaluation',
      },
      secondColumnSettings: {
        title: 'Second column header',
      },
    };
  },
  components: {
    HotTable,
    HotColumn,
  }
});

app.mount('#example1');

<div id="example1">
  <hot-table :settings="hotSettings">
    <hot-column title="First column header">
    </hot-column>
    <hot-column :settings="secondColumnSettings" read-only="true">
    </hot-column>
  </hot-table>
</div>

Array of objects

To work with an array of objects for the hot-column component, you need to provide precise information about the data structure for the columns. To do this, refer to the data for a column in properties as data.

import { createApp } from 'vue'; import { HotTable, HotColumn } from '@handsontable/vue3'; const app = createApp({ data() { return { hotData: [ { id: 1, name: 'Table tennis racket', payment: { price: 13, currency: 'PLN' } }, { id: 2, name: 'Outdoor game ball', payment: { price: 14, currency: 'USD' } }, { id: 3, name: 'Mountain bike', payment: { price: 300, currency: 'USD' } } ], secondColumnSettings: { title: 'Second column header' }, settings: { height: 'auto', licenseKey: 'non-commercial-and-evaluation' }, }; }, components: { HotTable, HotColumn, } }); app.mount('#example2'); <script src="https://cdn.jsdelivr.net/npm/handsontable@11.1/dist/handsontable.full.min.js"></script> <link type="text/css" rel="stylesheet" href="https://cdn.jsdelivr.net/npm/handsontable@11.1/dist/handsontable.full.min.css" /> <script src="https://cdn.jsdelivr.net/npm/vue@3/dist/vue.global.prod.js"></script> <script src="https://cdn.jsdelivr.net/npm/@handsontable/vue3@11.1/dist/vue-handsontable.min.js"></script> <script src="https://handsontable.com/docs/11.1/scripts/fixer.js"></script> <script src="https://handsontable.com/docs/11.1/scripts/helpers.js"></script> <div id="example2"> <hot-table :data="hotData" :settings="settings"> <hot-column title="ID" data="id"> </hot-column> <hot-column :settings="secondColumnSettings" read-only="true" data="name"> </hot-column> <hot-column title="Price" data="payment.price"> </hot-column> <hot-column title="Currency" data="payment.currency"> </hot-column> </hot-table> </div>

import { createApp } from 'vue';
import { HotTable, HotColumn } from '@handsontable/vue3';

const app = createApp({
  data() {
    return {
      hotData: [
        { id: 1, name: 'Table tennis racket', payment: { price: 13, currency: 'PLN' } },
        { id: 2, name: 'Outdoor game ball', payment: { price: 14, currency: 'USD' } },
        { id: 3, name: 'Mountain bike', payment: { price: 300, currency: 'USD' } }
      ],
      secondColumnSettings: {
        title: 'Second column header'
      },
      settings: {
        height: 'auto',
        licenseKey: 'non-commercial-and-evaluation'
      },
    };
  },
  components: {
    HotTable,
    HotColumn,
  }
});

app.mount('#example2');

<div id="example2">
  <hot-table :data="hotData" :settings="settings">
    <hot-column title="ID" data="id">
    </hot-column>
    <hot-column :settings="secondColumnSettings" read-only="true" data="name">
    </hot-column>
    <hot-column title="Price" data="payment.price">
    </hot-column>
    <hot-column title="Currency" data="payment.currency">
    </hot-column>
  </hot-table>
</div>