Custom renderer in Vue 3

Table of contents

• Overview
• Example - Declaring a renderer as a function

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 →

Example - Declaring 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 { createApp } from 'vue'; import { HotTable } from '@handsontable/vue3'; import { textRenderer } from 'handsontable/renderers/textRenderer'; import { registerAllModules } from 'handsontable/registry'; // register Handsontable's modules registerAllModules(); const app = createApp({ data() { return { hotSettings: { data: [ ['A1', 'https://handsontable.com/docs/11.1/img/examples/professional-javascript-developers-nicholas-zakas.jpg'], ['A2', 'https://handsontable.com/docs/11.1/img/examples/javascript-the-good-parts.jpg']], columns: [ {}, { renderer(instance, td, row, col, prop, value, cellProperties) { const escaped = `${value}`; if (escaped.indexOf('http') === 0) { const img = document.createElement('IMG'); img.src = value; img.addEventListener('mousedown', event => { event.preventDefault(); }); td.innerText = ''; td.appendChild(img); } else { textRenderer.apply(this, arguments); } return td; } } ], colHeaders: true, rowHeights: 55, height: 'auto', licenseKey: 'non-commercial-and-evaluation' } } }, components: { HotTable, } }); 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-table> </div>

import { createApp } from 'vue';
import { HotTable } from '@handsontable/vue3';
import { textRenderer } from 'handsontable/renderers/textRenderer';
import { registerAllModules } from 'handsontable/registry';

// register Handsontable's modules
registerAllModules();

const app = createApp({
  data() {
    return {
      hotSettings: {
        data:
          [
            ['A1', 'https://handsontable.com/docs/11.1/img/examples/professional-javascript-developers-nicholas-zakas.jpg'],
            ['A2', 'https://handsontable.com/docs/11.1/img/examples/javascript-the-good-parts.jpg']],
        columns: [
          {},
          {
            renderer(instance, td, row, col, prop, value, cellProperties) {
              const escaped = `${value}`;

              if (escaped.indexOf('http') === 0) {
                const img = document.createElement('IMG');
                img.src = value;

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

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

              } else {
                textRenderer.apply(this, arguments);
              }

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

app.mount('#example1');

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