@sheetwrite/vue 0.5.0 → 0.5.1

package/dist/index.d.ts

@@ -109,9 +109,44 @@ export type SheetwriteComponentConstructor<Props, Emits, Expose = object> = new
         [EventName in keyof Emits & string as `on${Capitalize<EventName>}`]?: (payload: Emits[EventName]) => void;
     };
 };
-/** Advanced framework component for workbook data or datasource input. */
+/**
+ * Advanced framework component for workbook data or datasource input.
+ *
+ * @example
+ * ```ts
+ * import { createApp, h } from "vue";
+ * import { SheetwriteGrid } from "@sheetwrite/vue";
+ * import type { Workbook } from "@sheetwrite/core";
+ *
+ * function mountWorkbook(host: HTMLElement, workbook: Workbook) {
+ *   const app = createApp({ render: () => h(SheetwriteGrid, { workbook, height: 400 }) });
+ *   app.mount(host);
+ *   return () => app.unmount();
+ * }
+ * ```
+ * @see Sheetwrite
+ * @see /docs/frameworks/vue/
+ */
 export declare const SheetwriteGrid: SheetwriteComponentConstructor<SheetwriteGridProps, SheetwriteGridEmits, SheetwriteGridExpose>;
-/** Convenience component for local object rows with live option updates. */
+/**
+ * Convenience component for local object rows with live option updates.
+ *
+ * @example
+ * ```ts
+ * import { createApp, h } from "vue";
+ * import { Sheetwrite } from "@sheetwrite/vue";
+ *
+ * const app = createApp({ render: () => h(Sheetwrite, {
+ *   columns: [{ key: "amount", title: "Amount", type: "number" }],
+ *   defaultRows: [{ amount: 12 }, { amount: 18 }],
+ *   height: 400,
+ * }) });
+ * app.mount(document.body);
+ * // Call app.unmount() before removing the host view.
+ * ```
+ * @see SheetwriteGrid
+ * @see /docs/frameworks/vue/
+ */
 export declare const Sheetwrite: SheetwriteComponentConstructor<SheetwriteProps, SheetwriteGridEmits>;
 export type { CellEditor, CellEditorContext, CellEditorInstance, CellEditorNavigation, CellScalar, Grid, GridCommandName, GridCommandState, } from "@sheetwrite/core";
 export type { GridReadyEvent, RowBridge, RowBridgeDelta, RowBridgeHandler, RowBridgeId, RowBridgeProjection, SimpleColumn, } from "@sheetwrite/core/adapter";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sheetwrite/vue",
-  "version": "0.5.0",
+  "version": "0.5.1",
   "type": "module",
   "description": "Vue adapter for Sheetwrite.",
   "license": "MIT",
@@ -49,6 +49,6 @@
     "vue": ">=3.4"
   },
   "dependencies": {
-    "@sheetwrite/core": "0.5.0"
+    "@sheetwrite/core": "0.5.1"
   }
 }