@sqlrooms/layout-config 0.27.0 → 0.28.0

package/README.md

@@ -1,59 +1,58 @@
-A central configuration and type definitions package that maintains base layout configuration schemas and Zod schema definitions for SQLRooms. It provides TypeScript types and interfaces along with essential constants and utilities used for managing layouts.
-
-## Features
-
-- 📝 **Layout Configuration**: Define and manage room layout configuration schemas for Mosaic layouts
-- 🔍 **Type Safety**: Strong TypeScript typing for layout configuration objects
-- ✅ **Validation**: Zod schemas for runtime validation of layout configurations
+Zod schemas and types for SQLRooms layout configuration (Mosaic layout).
 
 ## Installation
 
 ```bash
 npm install @sqlrooms/layout-config
-# or
-yarn add @sqlrooms/layout-config
 ```
 
-## Basic Usage
+## Main exports
+
+- `MAIN_VIEW`
+- `LayoutTypes`
+- `MosaicLayoutConfig`, `LayoutConfig`
+- `MosaicLayoutNode`, `MosaicLayoutParent`, `isMosaicLayoutParent`
+- `createDefaultMosaicLayout()`, `DEFAULT_MOSAIC_LAYOUT`
 
-### Working with Mosaic Layout Configuration
+## Basic usage
 
-```tsx
+```ts
 import {
-  MosaicLayoutConfig,
   LayoutConfig,
   MAIN_VIEW,
+  MosaicLayoutConfig,
+  createDefaultMosaicLayout,
 } from '@sqlrooms/layout-config';
 
-// Create a new room configuration
-const layoutConfig: MosaicLayoutConfig = {
+const minimalLayout = createDefaultMosaicLayout();
+
+const twoPaneLayout: MosaicLayoutConfig = {
   type: 'mosaic',
   nodes: {
     direction: 'row',
-    first: MAIN_VIEW,
-    second: {
-      direction: 'column',
-      first: 'files',
-      second: 'tables',
-    },
+    first: 'data',
+    second: MAIN_VIEW,
+    splitPercentage: 30,
   },
 };
 
-// This can be part of a bigger room configuration
-interface RoomConfig {
-  // ... other properties
-  layout: LayoutConfig;
-}
+const validatedMinimal: LayoutConfig = LayoutConfig.parse(minimalLayout);
+const validated: LayoutConfig = LayoutConfig.parse(twoPaneLayout);
 ```
 
-## Advanced Features
-
-- **Schema Extensions**: Extend base schemas for custom room types
-- **Configuration Validation**: Validate configurations at runtime
-- **Serialization**: Convert configurations to/from JSON for storage
-
-For more information, visit the SQLRooms documentation.
+## Typical integration
 
-```
+```ts
+import {createRoomShellSlice} from '@sqlrooms/room-shell';
+// `DataPanel` and `MainPanel` are app-level React components in your project.
 
+createRoomShellSlice({
+  layout: {
+    config: twoPaneLayout,
+    panels: {
+      data: {title: 'Data', component: DataPanel, placement: 'sidebar'},
+      main: {title: 'Main', component: MainPanel, placement: 'main'},
+    },
+  },
+});
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sqlrooms/layout-config",
-  "version": "0.27.0",
+  "version": "0.28.0",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "module": "dist/index.js",
@@ -28,5 +28,5 @@
     "typecheck": "tsc --noEmit",
     "typedoc": "typedoc"
   },
-  "gitHead": "f215995ab4adeac4c58171739261a15cbba9e82b"
+  "gitHead": "dcac54f8adf77240e293c93d224a0ce9fd8142a9"
 }