Skip to content
On this page

Getting Started ​

Overview ​

VueSheetz is a versatile and feature-rich Vue component that provides a powerful spreadsheet-like interface for displaying and manipulating tabular data in web applications.

You can learn more about the project in the What is VueSheetz section.

Trying VueSheetz Online ​

You can try VueSheetz online on StackBlitz. It runs VueSheetz directly in the browser, and it is almost identical to the local setup but doesn't require installing anything on your machine.

Adding VueSheetz to your Project ​

bash
npm install vuesheetz
bash
yarn add vuesheetz
bash
pnpm add vuesheetz

TIP

VueSheetz requires Vue >=v3.0.0 and Node >=v14.18

Configuring VueSheetz ​

After install VueSheetz locally using your preferred package manager, import VueSheetz's component and CSS into your application.

js
import { VueSheetzComponent } from 'vuesheetz'
import 'vuesheetz/dist/style.css'

Here is a full example using a minimal configuration:

vue
<script setup>
import { VueSheetzComponent } from 'vuesheetz'
import 'vuesheetz/dist/style.css'
</script>

<template>
  <VueSheetzComponent
    :data="[
      [1, 2],
      ['Jhon', 'Doe']
    ]"
    height="400px"
    width="100%"
  />
</template>

Result:

A
B
C
D
E
F
G
H
I
J
K
L
M
N
O
P
Q
R
S
T
U
V
W
X
Y
Z
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
1
2
Jhon
Doe

See the list of config options in the Config Reference

Community ​

If you have questions or need help, reach out to the community at GitHub Discussions.

Released under the MIT License.