@sheetwrite/react 0.5.0 → 0.5.1

package/dist/index.d.ts

@@ -32,7 +32,21 @@ export interface SheetwriteGridProps<Id extends RowBridgeId = RowBridgeId> exten
     /** Fills the parent's available width and height, taking precedence over `height`. */
     fill?: true;
 }
-/** Advanced framework component with inferred row-bridge identity. */
+/**
+ * Advanced framework component with inferred row-bridge identity.
+ *
+ * @example
+ * ```tsx
+ * import { SheetwriteGrid } from "@sheetwrite/react";
+ * import type { Workbook } from "@sheetwrite/core";
+ *
+ * export function WorkbookView({ workbook }: { workbook: Workbook }) {
+ *   return <SheetwriteGrid workbook={workbook} height={400} />;
+ * }
+ * ```
+ * @see Sheetwrite
+ * @see /docs/frameworks/react/
+ */
 export declare const SheetwriteGrid: <Id extends RowBridgeId = RowBridgeId>(props: SheetwriteGridProps<Id> & {
     ref?: ForwardedRef<Grid>;
 }) => ReactElement;
@@ -54,6 +68,21 @@ export type SheetwriteProps<Row extends Record<string, CellScalar>, Id extends R
  * `columns`, `defaultRows`, and `sheetName`, initializes Sheetwrite, and owns the `Grid`
  * through prop-driven resets and unmount cleanup. Pass a `ref` to access the live `Grid`;
  * use `SheetwriteGrid` when the host already owns a workbook or datasource.
+ *
+ * @example
+ * ```tsx
+ * import { Sheetwrite } from "@sheetwrite/react";
+ *
+ * export function Sales() {
+ *   return <Sheetwrite
+ *     columns={[{ key: "amount", title: "Amount", type: "number" }]}
+ *     defaultRows={[{ amount: 12 }, { amount: 18 }]}
+ *     height={400}
+ *   />;
+ * }
+ * ```
+ * @see SheetwriteGrid
+ * @see /docs/frameworks/react/
  */
 export declare const Sheetwrite: <Row extends Record<string, CellScalar>, Id extends RowBridgeId = RowBridgeId>(props: SheetwriteProps<Row, Id> & {
     /** Receives the live Grid after readiness and `null` on reset or unmount. */

package/dist/index.js

@@ -125,7 +125,21 @@ const SheetwriteGridComponent = forwardRef(function SheetwriteGrid(props, ref) {
     const hostStyle = { ...style, ...sizing };
     return (_jsx("div", { ...hostAttributes, ref: hostRef, className: hostClassName, style: hostStyle, children: initializationState === "ready" ? null : fallback }));
 });
-/** Advanced framework component with inferred row-bridge identity. */
+/**
+ * Advanced framework component with inferred row-bridge identity.
+ *
+ * @example
+ * ```tsx
+ * import { SheetwriteGrid } from "@sheetwrite/react";
+ * import type { Workbook } from "@sheetwrite/core";
+ *
+ * export function WorkbookView({ workbook }: { workbook: Workbook }) {
+ *   return <SheetwriteGrid workbook={workbook} height={400} />;
+ * }
+ * ```
+ * @see Sheetwrite
+ * @see /docs/frameworks/react/
+ */
 export const SheetwriteGrid = SheetwriteGridComponent;
 const SheetwriteComponent = forwardRef(function Sheetwrite({ columns, defaultRows, sheetName, getRowId, createRowId, ...props }, ref) {
     const input = useMemo(() => createSimpleGridInput({ columns, defaultRows, sheetName }), [columns, defaultRows, sheetName]);
@@ -142,6 +156,21 @@ const SheetwriteComponent = forwardRef(function Sheetwrite({ columns, defaultRow
  * `columns`, `defaultRows`, and `sheetName`, initializes Sheetwrite, and owns the `Grid`
  * through prop-driven resets and unmount cleanup. Pass a `ref` to access the live `Grid`;
  * use `SheetwriteGrid` when the host already owns a workbook or datasource.
+ *
+ * @example
+ * ```tsx
+ * import { Sheetwrite } from "@sheetwrite/react";
+ *
+ * export function Sales() {
+ *   return <Sheetwrite
+ *     columns={[{ key: "amount", title: "Amount", type: "number" }]}
+ *     defaultRows={[{ amount: 12 }, { amount: 18 }]}
+ *     height={400}
+ *   />;
+ * }
+ * ```
+ * @see SheetwriteGrid
+ * @see /docs/frameworks/react/
  */
 export const Sheetwrite = SheetwriteComponent;
 //# sourceMappingURL=index.js.map

package/package.json

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