Vue 3 Data Grid Custom renderer in Vue 3

Create a custom cell renderer, and use it in your Vue 3 data grid by declaring it as a function.

In this article

• Overview
• Declare a renderer as a function
• Related articles
  • Related guides
  • Related API reference

Overview

You can declare a custom renderer for the HotTable component by declaring it as a function in the Handsontable options or creating a rendering component.

Find out which Vue 3 versions are supported

Declare a renderer as a function

The following example is an implementation of @handsontable/vue3 with a custom renderer added. It takes an image URL as the input and renders the image in the edited cell.

import { defineComponent } from 'vue'; import { HotTable } from '@handsontable/vue3'; import { registerAllModules } from 'handsontable/registry'; import 'handsontable/dist/handsontable.full.css'; // register Handsontable's modules registerAllModules(); const ExampleComponent = defineComponent({ data() { return { hotSettings: { data: [ ['A1', 'https://handsontable.com/docs/13.0/img/examples/professional-javascript-developers-nicholas-zakas.jpg'], ['A2', 'https://handsontable.com/docs/13.0/img/examples/javascript-the-good-parts.jpg'] ], columns: [ {}, { renderer(instance, td, row, col, prop, value) { const img = document.createElement('img'); img.src = value; img.addEventListener('mousedown', event => { event.preventDefault(); }); td.innerText = ''; td.appendChild(img); return td; } } ], colHeaders: true, rowHeights: 55, height: 'auto', licenseKey: 'non-commercial-and-evaluation' } } }, components: { HotTable, } }); export default ExampleComponent; import { createApp } from 'vue'; const app = createApp(ExampleComponent); app.mount('#example1'); <script src="https://cdn.jsdelivr.net/npm/handsontable@13.0/dist/handsontable.full.min.js"></script> <link type="text/css" rel="stylesheet" href="https://cdn.jsdelivr.net/npm/handsontable@13.0/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@13.0/dist/vue-handsontable.min.js"></script> <script src="https://handsontable.com/docs/13.0/scripts/fixer.js"></script> <div id="example1"> <hot-table :settings="hotSettings"></hot-table> </div>

import { defineComponent } from 'vue';
import { HotTable } from '@handsontable/vue3';
import { registerAllModules } from 'handsontable/registry';
import 'handsontable/dist/handsontable.full.css';

// register Handsontable's modules
registerAllModules();

const ExampleComponent = defineComponent({
  data() {
    return {
      hotSettings: {
        data:
          [
            ['A1', 'https://handsontable.com/docs/13.0/img/examples/professional-javascript-developers-nicholas-zakas.jpg'],
            ['A2', 'https://handsontable.com/docs/13.0/img/examples/javascript-the-good-parts.jpg']
          ],
        columns: [
          {},
          {
            renderer(instance, td, row, col, prop, value) {
              const img = document.createElement('img');

              img.src = value;

              img.addEventListener('mousedown', event => {
                event.preventDefault();
              });

              td.innerText = '';
              td.appendChild(img);

              return td;
            }
          }
        ],
        colHeaders: true,
        rowHeights: 55,
        height: 'auto',
        licenseKey: 'non-commercial-and-evaluation'
      }
    }
  },
  components: {
    HotTable,
  }
});

export default ExampleComponent;

<div id="example1">
  <hot-table :settings="hotSettings"></hot-table>
</div>

Related articles

Related guides

• Cell renderer

Related API reference

• APIs:
  • BasePlugin
• Configuration options:
  • renderer
• Core methods:
  • getCellMeta()
  • getCellMetaAtRow()
  • getCellsMeta()
  • getCellRenderer()
  • setCellMeta()
  • setCellMetaObject()
  • removeCellMeta()
• Hooks:
  • afterGetCellMeta
  • afterGetColumnHeaderRenderers
  • afterGetRowHeaderRenderers
  • afterRenderer
  • beforeGetCellMeta
  • beforeRenderer