@open-grid/vue-ui

@open-grid/vue-ui

Optional styled Vue data grid for Open Grid.

Use this package for the reference Vue grid UI, including sorting, filtering, selection, editing, grouping, tree data, virtualization, and export helpers.

DataGrid accepts ariaLabel for a product-specific accessible name and defaults to "Data grid".

Use Vue's class attribute, getRowClassName(row), getHeaderClassName(context), and getCellClassName(context) to attach product-owned root, row, header, and cell classes for status, risk, or workflow styling without replacing the renderer. Header contexts include the grid, column, and header; cell contexts also include the row and current value.

Use renderHeader and renderCell for framework-native VNodes, renderToolbar for product commands, and the state render callbacks for component-based loading, error, and empty content. See the custom rendering and composition guides.

Install

npm install @open-grid/vue-ui @open-grid/theme vue

Usage

import "@open-grid/theme/css";
import "@open-grid/vue-ui/css";
import { defineComponent, h } from "vue";
import { createColumnHelper, createDataGrid } from "@open-grid/vue-ui";

const column = createColumnHelper<{ id: string; name: string }>();
const DataGrid = createDataGrid<{ id: string; name: string }>();

export default defineComponent({
  setup: () => () => h(DataGrid, {
    ariaLabel: "People",
    options: {
      data: [{ id: "1", name: "Mina" }],
      columns: [column.accessor("name", { header: "Name" })],
      getRowId: (row) => row.id,
    },
  }),
});

Override semantic --og-* variables on [data-open-grid] to match a product design system. Set data-og-theme="dark" on the grid or an ancestor for the bundled dark defaults; application toolbars and surrounding panels remain product-owned.

Set options.editHistoryLimit to a positive number to opt into bounded edit history. Outside an active editor, Ctrl/Meta+Z undoes and Ctrl/Meta+Shift+Z or Ctrl+Y redoes direct edits, pastes, and fills through the same preventable onCellEdit contract.

Use onGridReady: (grid) => ... to connect product-owned toolbar commands, diagnostics, or subscriptions to the styled grid's live core API. The handler runs after mount and may return a cleanup function; return the unsubscribe function from grid.subscribeSelector(...) when product UI mirrors one derived API value without reacting to unrelated grid notifications.

The package re-exports fitColumnsToWidth(grid, width, { columnIds? }) for proportional visible-column fitting with core-owned min/max redistribution. Products decide the available width and command placement; the renderer does not read layout implicitly.

See the Vue UI guide for controlled state, virtualization, editing, grouping, accessibility, and server-owned workflows.