@open-grid/vue-ui 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Open Grid contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,57 @@
+# @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.
+
+## Install
+
+```bash
+npm install @open-grid/vue-ui @open-grid/theme vue
+```
+
+## Usage
+
+```ts
+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](https://goatshave.github.io/open-grid/vue-ui) for controlled state, virtualization, editing, grouping, accessibility, and server-owned workflows.