@8sheets/data-grid-vue
v1.1.0
Published
Vue 3 component for 8sheets Data Grid: <DataGrid> with options passed through, typed events and template ref.
Maintainers
Readme
8sheets Data Grid for Vue
<DataGrid> puts an 8sheets Data Grid in a Vue 3 app (Vue 3.4 or later), with server rendering. This is version 1.1.0.
Install
npm i @8sheets/data-grid-vue @8sheets/data-gridUse
<script setup>
import { computed, shallowRef } from 'vue';
import { DataGrid, useDataGrid } from '@8sheets/data-grid-vue';
const records = shallowRef([{ Region: 'East', Units: 2, Price: 24 }]);
const options = computed(() => ({ title: 'Orders', data: records.value }));
const { dataGrid, grid } = useDataGrid();
</script>
<template>
<div style="height: 480px">
<DataGrid ref="dataGrid" :options="options" @change="(c) => console.log(c.action)" />
</div>
</template>optionsgoes tomountTableas it is. A changedchromegoes tosetChrome; any other change mounts the grid again.datais compared by identity; keep records in ashallowRef.- Events:
@changefor each data change, the grid's other events by their names (@state-change,@before-edit…),@readywith the grid,@errorfor a failed mount or action. Any other listener@namegoes to the grid as itsonNameoption. - The template ref exposes
grid,whenReady()and every method of the grid exceptdestroy,onandoff.
Vite
Set worker: { format: 'es' }, and before Vite 8 also optimizeDeps: { exclude: ['@8sheets/data-grid', '@8sheets/data-grid-vue'] }.
Documentation
Framework wrappers for this component in detail, and the API reference for every option of the grid.
Licence
8sheets is commercial software, not open source. You may install it and try it for free, to evaluate it. Using it in a product, or deploying it for your users or your own staff, needs a licence from 8sheets.com/pricing: Internal 999 USD or SaaS / OEM 2,999 USD, each paid once per company and covering every developer and every deployment, or Enterprise, quoted. One licence covers both 8sheets products, Spreadsheet and Data Grid. There is no licence key and nothing in the package checks for one. The terms are in LICENSE.md and, once you hold a licence, the 8sheets Source Licence.
