@lupinum/board-core 1.0.0-beta.4 → 1.0.0-beta.6

package/dist/agent/pages/docs/build-features/theming.md

@@ -15,8 +15,291 @@ source: "ginko-content"
 
 Theme the board with CSS variables. Keep semantic state, such as node color presets, in engine state.
 
-> Component omitted: `theme-playground`.
-> This page contains an interactive or site-specific block that has no agent markdown serializer yet.
+## Live example source
+
+Use the installation guide to register @lupinum/nuxt-board. These are the actual documentation demo files. Keep their paths under app/. The module auto-imports Board components; install the optional packages named in imports. For the local content components, use components: [{ path: "~/components/content", pathPrefix: false }, "~/components"] in nuxt.config.ts, as this site does, or import them explicitly. createDemoDocument is a local helper, not a package export. DocsLab and the inspector components provide presentation only.
+
+### app/components/demos/ThemePlayground.vue
+
+````vue
+<script setup lang="ts">
+import { computed, onMounted, reactive } from 'vue'
+import { createBoardEngine } from '@lupinum/board-core'
+import { createDemoDocument } from '../../utils/demoDocument'
+
+const engine = createBoardEngine({
+  grid: { size: 20, majorEvery: 5, snap: true, pattern: 'dot' },
+})
+
+const colors = reactive({
+  bg: '#f8fafc',
+  fg: '#0f172a',
+  nodeBg: '#ffffff',
+  nodeBorder: '#cbd5e1',
+  accent: '#0ea5e9',
+})
+
+const boardStyle = computed(() => ({
+  '--board-bg': colors.bg,
+  '--board-fg': colors.fg,
+  '--board-node-bg': colors.nodeBg,
+  '--board-node-border': colors.nodeBorder,
+  '--board-node-stripe': `${colors.fg}14`,
+  '--board-accent': colors.accent,
+  '--board-handle-shadow': `${colors.fg}33`,
+}))
+
+function seed() {
+  engine.loadDocument(
+    createDemoDocument({
+      camera: { x: 0, y: 0, z: 1 },
+      grid: engine.getGridSettings(),
+      nodes: [
+        {
+          id: 'theme-1',
+          type: 'text',
+          x: 70,
+          y: 70,
+          width: 240,
+          height: 100,
+          text: 'Node',
+          zIndex: 1,
+          locked: false,
+          visible: true,
+        },
+        {
+          id: 'theme-2',
+          type: 'text',
+          x: 370,
+          y: 190,
+          width: 240,
+          height: 100,
+          text: 'Node',
+          zIndex: 2,
+          locked: false,
+          visible: true,
+        },
+      ],
+      selection: [],
+      nextZIndex: 3,
+    }),
+    { mode: 'replace' },
+  )
+}
+
+function resetColors() {
+  colors.bg = '#f8fafc'
+  colors.fg = '#0f172a'
+  colors.nodeBg = '#ffffff'
+  colors.nodeBorder = '#cbd5e1'
+  colors.accent = '#0ea5e9'
+}
+
+async function reset() {
+  seed()
+  resetColors()
+  await engine.zoomToFit(60, false)
+}
+
+onMounted(reset)
+</script>
+
+<template>
+  <div class="demo-frame">
+    <div class="demo-toolbar">
+      <button class="demo-danger" @click="reset">Reset theme</button>
+      <span class="demo-toolbar-note"
+        >Change the CSS custom properties and the board updates
+        immediately.</span
+      >
+    </div>
+
+    <div class="grid gap-0 lg:grid-cols-[320px_minmax(0,1fr)]">
+      <div
+        class="border-b border-default bg-elevated p-4 lg:border-r lg:border-b-0"
+      >
+        <div class="space-y-4">
+          <label class="demo-color-field">
+            <div>
+              <span>Board background</span
+              ><code class="demo-color-var">--board-bg</code>
+            </div>
+            <input v-model="colors.bg" type="color" />
+          </label>
+          <label class="demo-color-field">
+            <div>
+              <span>Board foreground</span
+              ><code class="demo-color-var">--board-fg</code>
+            </div>
+            <input v-model="colors.fg" type="color" />
+          </label>
+          <label class="demo-color-field">
+            <div>
+              <span>Node background</span
+              ><code class="demo-color-var">--board-node-bg</code>
+            </div>
+            <input v-model="colors.nodeBg" type="color" />
+          </label>
+          <label class="demo-color-field">
+            <div>
+              <span>Node border</span
+              ><code class="demo-color-var">--board-node-border</code>
+            </div>
+            <input v-model="colors.nodeBorder" type="color" />
+          </label>
+          <label class="demo-color-field">
+            <div>
+              <span>Accent</span
+              ><code class="demo-color-var">--board-accent</code>
+            </div>
+            <input v-model="colors.accent" type="color" />
+          </label>
+        </div>
+      </div>
+
+      <div class="p-4">
+        <div
+          class="overflow-hidden rounded-md border border-default"
+          :style="boardStyle"
+        >
+          <BoardRoot
+            :engine="engine"
+            :grid="{ minorOpacity: 0.12, majorOpacity: 0.18, fadeEdges: true }"
+            style="height: 360px"
+          />
+        </div>
+      </div>
+    </div>
+  </div>
+</template>
+````
+
+### app/utils/demoDocument.ts
+
+````ts
+import type {
+  BoardNode,
+  BoardNodeMetadata,
+  Camera,
+  GridSettings,
+  JsonCanvasDocument,
+  JsonCanvasNode,
+  NodeId,
+} from '@lupinum/board-core'
+
+type DemoNode = Omit<
+  Pick<
+    BoardNode,
+    | 'id'
+    | 'type'
+    | 'x'
+    | 'y'
+    | 'width'
+    | 'height'
+    | 'color'
+    | 'text'
+    | 'file'
+    | 'subpath'
+    | 'url'
+    | 'label'
+    | 'background'
+    | 'backgroundStyle'
+    | 'zIndex'
+    | 'locked'
+    | 'visible'
+    | 'parentId'
+  >,
+  'id' | 'parentId'
+> & {
+  id: NodeId | string
+  parentId?: NodeId | string
+}
+
+export interface DemoDocumentInput {
+  nodes: readonly DemoNode[]
+  camera?: Camera
+  grid?: GridSettings
+  selection?: readonly (NodeId | string)[]
+  nextZIndex?: number
+}
+
+function toJsonCanvasNode(node: DemoNode): JsonCanvasNode {
+  const base = {
+    id: node.id as NodeId,
+    type: node.type,
+    x: node.x,
+    y: node.y,
+    width: node.width,
+    height: node.height,
+    ...(node.color ? { color: node.color } : {}),
+  }
+
+  switch (node.type) {
+    case 'file':
+      return {
+        ...base,
+        type: 'file',
+        file: node.file ?? '',
+        ...(node.subpath ? { subpath: node.subpath } : {}),
+      }
+    case 'link':
+      return {
+        ...base,
+        type: 'link',
+        url: node.url ?? '',
+      }
+    case 'group':
+      return {
+        ...base,
+        type: 'group',
+        ...((node.label ?? node.text)
+          ? { label: node.label ?? node.text }
+          : {}),
+        ...(node.background ? { background: node.background } : {}),
+        ...(node.backgroundStyle
+          ? { backgroundStyle: node.backgroundStyle }
+          : {}),
+      }
+    case 'text':
+    default:
+      return {
+        ...base,
+        type: 'text',
+        text: node.text ?? '',
+      }
+  }
+}
+
+function toNodeMetadata(node: DemoNode): BoardNodeMetadata {
+  return {
+    zIndex: node.zIndex,
+    locked: node.locked,
+    visible: node.visible,
+    ...(node.parentId ? { parentId: node.parentId as NodeId } : {}),
+  }
+}
+
+export function createDemoDocument(
+  input: DemoDocumentInput,
+): JsonCanvasDocument {
+  return {
+    nodes: input.nodes.map(toJsonCanvasNode),
+    'x-lupinum-board': {
+      ...(input.camera ? { camera: input.camera } : {}),
+      ...(input.grid ? { grid: input.grid } : {}),
+      ...(input.selection
+        ? { selection: input.selection.map((id) => id as NodeId) }
+        : {}),
+      nextZIndex:
+        input.nextZIndex ??
+        input.nodes.reduce((max, node) => Math.max(max, node.zIndex), 0) + 1,
+      nodes: Object.fromEntries(
+        input.nodes.map((node) => [node.id, toNodeMetadata(node)]),
+      ),
+    },
+  }
+}
+````
 
 ## Core tokens