Comments

Add a comment (a note) to a cell, using the context menu, just like in Excel. Edit and delete comments. Make comments read-only.

The Comments plugin lets users attach text notes to individual cells. Use it when reviewers need to annotate data without changing cell values.

Enable the plugin

Set the comments configuration option to true to enable the feature and add all the needed context menu items. For example:

1
const hotSettings = {
2
  data: [
3
    ['Update API docs', 'Ana García', 'In progress'],
4
    ['Deploy hotfix', 'James Okafor', 'Blocked'],
5
  ],
6
  comments: true,
7
  autoWrapRow: true,
8
  autoWrapCol: true,
9
  licenseKey: 'non-commercial-and-evaluation',
10
};

After you’ve enabled the plugin, the Context Menu gains a few new items:

Add/Edit comment
Delete comment
Read-only comment

Set up pre-set comments

You can also pre-define comments for your table. Comments are stored in the table’s/column’s/cell’s metadata object and you can declare as any value of the respective type. For example:

1
const hotSettings = {
2
  cell: [
3
    { row: 1, col: 1, comment: { value: 'Hello world!' } },
4
  ],
5
};

In this example, the comment “Hello world!” is added to the cell at (1,1).

Basic example

1
<script setup lang="ts">
2
import { ref } from 'vue';
3
import { HotTable } from '@handsontable/vue3';
4
import { registerAllModules } from 'handsontable/registry';
5
import type { GridSettings } from 'handsontable/settings';
6

7
registerAllModules();
8

9
const hotSettings = ref<GridSettings>({
10
  data: [
11
    ['', 'Tesla', 'Nissan', 'Toyota', 'Honda', 'Mazda', 'Ford'],
12
    ['2017', 10, 11, 12, 13, 15, 16],
13
    ['2018', 10, 11, 12, 13, 15, 16],
14
    ['2019', 10, 11, 12, 13, 15, 16],
15
    ['2020', 10, 11, 12, 13, 15, 16],
16
    ['2021', 10, 11, 12, 13, 15, 16],
17
  ],
18
  rowHeaders: true,
19
  colHeaders: true,
20
  contextMenu: true,
21
  comments: true,
22
  cell: [
23
    { row: 1, col: 1, comment: { value: 'Some comment' } },
24
    { row: 2, col: 2, comment: { value: 'More comments' } },
25
  ],
26
  height: 'auto',
27
  autoWrapRow: true,
28
  autoWrapCol: true,
29
  licenseKey: 'non-commercial-and-evaluation',
30
});
31
</script>
32

33
<template>
34
  <div id="example1">
35
    <HotTable :settings="hotSettings" />
36
  </div>
37
</template>

Make a comment read-only

By default, all comments are editable. To change this, set the readOnly configuration option to true when adding a comment. This example makes the “Tesla” comment attached to a cell read-only, whereas the “Honda” comment attached to another cell is editable.

1
<script setup lang="ts">
2
import { ref } from 'vue';
3
import { HotTable } from '@handsontable/vue3';
4
import { registerAllModules } from 'handsontable/registry';
5
import type { GridSettings } from 'handsontable/settings';
6

7
registerAllModules();
8

9
const hotSettings = ref<GridSettings>({
10
  data: [
11
    ['', 'Tesla', 'Toyota', 'Honda', 'Ford'],
12
    ['2018', 10, 11, 12, 13, 15, 16],
13
    ['2019', 10, 11, 12, 13, 15, 16],
14
    ['2020', 10, 11, 12, 13, 15, 16],
15
  ],
16
  rowHeaders: true,
17
  colHeaders: true,
18
  contextMenu: true,
19
  comments: true,
20
  cell: [
21
    {
22
      row: 0,
23
      col: 1,
24
      comment: { value: 'A read-only comment.', readOnly: true },
25
    },
26
    { row: 0, col: 3, comment: { value: 'You can edit this comment' } },
27
  ],
28
  height: 'auto',
29
  autoWrapRow: true,
30
  autoWrapCol: true,
31
  licenseKey: 'non-commercial-and-evaluation',
32
});
33
</script>
34

35
<template>
36
  <div id="example2">
37
    <HotTable :settings="hotSettings" />
38
  </div>
39
</template>

Set a comment box’s size

To set the width and height of a comment box, use the style parameter.

1
<script setup lang="ts">
2
import { ref } from 'vue';
3
import { HotTable } from '@handsontable/vue3';
4
import { registerAllModules } from 'handsontable/registry';
5
import type { GridSettings } from 'handsontable/settings';
6

7
registerAllModules();
8

9
const hotSettings = ref<GridSettings>({
10
  data: [
11
    ['', 'Tesla', 'Nissan', 'Toyota', 'Honda', 'Mazda', 'Ford'],
12
    ['2017', 10, 11, 12, 13, 15, 16],
13
    ['2018', 10, 11, 12, 13, 15, 16],
14
    ['2019', 10, 11, 12, 13, 15, 16],
15
  ],
16
  rowHeaders: true,
17
  colHeaders: true,
18
  contextMenu: true,
19
  comments: true,
20
  cell: [
21
    { row: 1, col: 1, comment: { value: 'Some comment' } },
22
    {
23
      row: 2,
24
      col: 2,
25
      comment: {
26
        value: 'Comment 200x50 px',
27
        style: { width: 200, height: 50 },
28
      },
29
    },
30
  ],
31
  height: 'auto',
32
  autoWrapRow: true,
33
  autoWrapCol: true,
34
  licenseKey: 'non-commercial-and-evaluation',
35
});
36
</script>
37

38
<template>
39
  <div id="example3">
40
    <HotTable :settings="hotSettings" />
41
  </div>
42
</template>

Set a delay for displaying comments

To display comments after a pre-configured time delay, use the displayDelay parameter.

1
<script setup lang="ts">
2
import { ref } from 'vue';
3
import { HotTable } from '@handsontable/vue3';
4
import { registerAllModules } from 'handsontable/registry';
5
import type { GridSettings } from 'handsontable/settings';
6

7
registerAllModules();
8

9
const hotSettings = ref<GridSettings>({
10
  data: [
11
    ['', 'Tesla', 'Toyota', 'Honda', 'Ford'],
12
    ['2018', 10, 11, 12, 13, 15, 16],
13
    ['2019', 10, 11, 12, 13, 15, 16],
14
    ['2020', 10, 11, 12, 13, 15, 16],
15
  ],
16
  rowHeaders: true,
17
  colHeaders: true,
18
  contextMenu: true,
19
  comments: {
20
    displayDelay: 2000,
21
  },
22
  cell: [{ row: 1, col: 1, comment: { value: 'Some comment' } }],
23
  height: 'auto',
24
  autoWrapRow: true,
25
  autoWrapCol: true,
26
  licenseKey: 'non-commercial-and-evaluation',
27
});
28
</script>
29

30
<template>
31
  <div id="example4">
32
    <HotTable :settings="hotSettings" />
33
  </div>
34
</template>

Flag invalid cells with a comment

Combine comments with validation to explain data-entry errors. This example adds a comment to a cell when it fails validation and removes the comment once the value is valid. The afterValidate hook drives the change, and setCommentAtCell() writes the message. The grid validates on load, so the Mechanical keyboard row starts with an invalid stock value and shows its comment right away. Edit any Stock cell and enter a negative number or text to flag it, or enter a valid whole number to clear the flag.

1
<script setup lang="ts">
2
import Handsontable from 'handsontable/base';
3
import { ref } from 'vue';
4
import { HotTable } from '@handsontable/vue3';
5
import { registerAllModules } from 'handsontable/registry';
6
import type { GridSettings } from 'handsontable/settings';
7

8
registerAllModules();
9

10
const hotSettings = ref<GridSettings>({
11
  data: [
12
    ['Wireless mouse', 142],
13
    ['USB-C cable', 67],
14
    ['Mechanical keyboard', -5],
15
    ['Laptop stand', 38],
16
    ['HDMI adapter', 210],
17
  ],
18
  colHeaders: ['Product', 'Stock'],
19
  rowHeaders: true,
20
  comments: true,
21
  columns: [
22
    {},
23
    {
24
      type: 'numeric',
25
      validator(value: any, callback: (valid: boolean) => void) {
26
        callback(Number.isInteger(value) && value >= 0);
27
      },
28
    },
29
  ],
30
  // Attach a comment when a cell fails validation, and remove it once the cell is valid.
31
  afterValidate(this: Handsontable, isValid: boolean, value: any, row: number, prop: string | number) {
32
    const column = this.propToCol(prop);
33
    const comments = this.getPlugin('comments');
34

35
    if (!isValid) {
36
      comments.setCommentAtCell(row, column, `"${value}" is not valid. Enter a whole number of 0 or more.`);
37
    } else {
38
      comments.removeCommentAtCell(row, column);
39
    }
40
  },
41
  // Validate every cell on load so the pre-existing invalid value is flagged right away.
42
  afterInit(this: Handsontable) {
43
    this.validateCells();
44
  },
45
  height: 'auto',
46
  autoWrapRow: true,
47
  autoWrapCol: true,
48
  licenseKey: 'non-commercial-and-evaluation',
49
});
50
</script>
51

52
<template>
53
  <div id="example5">
54
    <HotTable :settings="hotSettings" />
55
  </div>
56
</template>

Read all comments programmatically

To collect every comment in the grid, loop through the rows and read each cell’s metadata with getCellMetaAtRow(). Each returned cell-meta object stores its comment under the comment key. Click List all comments to print all comments below the grid.

1
<script setup lang="ts">
2
import { ref, useTemplateRef } from 'vue';
3
import { HotTable } from '@handsontable/vue3';
4
import { registerAllModules } from 'handsontable/registry';
5
import type { GridSettings } from 'handsontable/settings';
6

7
registerAllModules();
8

9
const hotTableRef = useTemplateRef<InstanceType<typeof HotTable>>('hotTableRef');
10
const output = ref('');
11

12
const hotSettings = ref<GridSettings>({
13
  data: [
14
    ['Update API docs', 'Ana García', 'In progress'],
15
    ['Deploy hotfix', 'James Okafor', 'Blocked'],
16
    ['Review pull requests', 'Li Wei', 'Done'],
17
    ['Plan Q3 roadmap', 'Maria Santos', 'In progress'],
18
    ['Refactor auth module', 'David Kim', 'In review'],
19
  ],
20
  colHeaders: ['Task', 'Assignee', 'Status'],
21
  rowHeaders: true,
22
  comments: true,
23
  cell: [
24
    { row: 1, col: 2, comment: { value: 'Waiting on infrastructure approval.' } },
25
    { row: 3, col: 1, comment: { value: 'Reassign if capacity is tight.' } },
26
    { row: 4, col: 0, comment: { value: 'Blocked on the security review.' } },
27
  ],
28
  height: 'auto',
29
  autoWrapRow: true,
30
  autoWrapCol: true,
31
  licenseKey: 'non-commercial-and-evaluation',
32
});
33

34
const listComments = () => {
35
  const hot = hotTableRef.value?.hotInstance;
36

37
  if (!hot) {
38
    return;
39
  }
40

41
  const found: string[] = [];
42

43
  // `getCellMetaAtRow()` takes a physical row index (equal to the visual index here, with no sorting or trimming).
44
  for (let row = 0; row < hot.countRows(); row += 1) {
45
    hot.getCellMetaAtRow(row).forEach((cellMeta, col) => {
46
      const comment = cellMeta.comment as { value?: string } | undefined;
47

48
      if (comment?.value !== undefined) {
49
        found.push(`Row ${row + 1}, "${hot.getColHeader(col)}": ${comment.value}`);
50
      }
51
    });
52
  }
53

54
  output.value = found.length > 0 ? found.join('\n') : 'No comments found.';
55
};
56
</script>
57

58
<template>
59
  <div id="example6">
60
    <div class="example-controls-container">
61
      <div class="controls">
62
        <button id="list-comments" type="button" @click="listComments">List all comments</button>
63
      </div>
64
    </div>
65
    <HotTable ref="hotTableRef" :settings="hotSettings" />
66
    <output class="comments-output" style="white-space: pre-wrap">{{ output }}</output>
67
  </div>
68
</template>

Result

Cells with comments display a small indicator in the corner. Users can view, edit, or delete comments through the context menu, and pre-configured comments appear when the table loads.

Windows	macOS	Action	Excel	Sheets
`Ctrl`+`Alt`+`M`	`⌃`+`⌥`+`M`	Add or edit a comment	✗	✓
`Ctrl`+`Enter`	`⌘`+`Enter`	Save and exit the current comment	✗	✓
`Escape`	`Escape`	Exit the current comment without saving	✗	✗