fix(json-render-ui): restore shadow-root theming and scrollbars

Author: dvcolomban

design/build-shadow-css.ts

@@ -30,12 +30,12 @@ export interface BuildShadowCssOptions {
    */
   primaryRampPath: string
   /**
-   * Absolute path to a hand-authored stylesheet run through the generator's
-   * configured transformers (directives, variant groups) and merged in
-   * right after the CSS reset. Omit for a package with no hand-written
-   * styles.
+   * One or more absolute paths to hand-authored stylesheets run through the
+   * generator's configured transformers (directives, variant groups) and
+   * merged in order right after the CSS reset. Omit for a package with no
+   * hand-written styles.
    */
-  userStylePath?: string
+  userStylePath?: string | readonly string[]
   /**
    * Prefix Wind's `--un-*` custom properties are renamed to (see
    * `namespaceShadowCssVars`) — unique per shadow-root surface so two
@@ -93,16 +93,16 @@ export async function buildShadowCss(options: BuildShadowCssOptions): Promise<Bu
     await generator.applyExtractors(content, file, tokens)
   }
 
-  // The hand-written stylesheet (if any) may use `--at-apply` — run it
-  // through the configured transformers (directives, variant groups) before
-  // merging.
-  const userStyle = userStylePath
-    ? new MagicString(await fs.readFile(userStylePath, 'utf-8').catch(() => ''))
-    : undefined
-  if (userStyle) {
+  // Hand-written stylesheets may use `--at-apply`. Run each through the
+  // configured transformers before merging them in the caller's order.
+  const userStylePaths = typeof userStylePath === 'string' ? [userStylePath] : (userStylePath ?? [])
+  const userStyles: string[] = []
+  for (const userStylePath of userStylePaths) {
+    const userStyle = new MagicString(await fs.readFile(userStylePath, 'utf-8').catch(() => ''))
     for (const transformer of generator.config.transformers ?? []) {
-      await transformer.transform(userStyle, userStylePath!, { uno: generator } as any)
+      await transformer.transform(userStyle, userStylePath, { uno: generator } as any)
     }
+    userStyles.push(userStyle.toString())
   }
 
   const primaryRamp = await fs.readFile(primaryRampPath, 'utf-8')
@@ -126,7 +126,7 @@ export async function buildShadowCss(options: BuildShadowCssOptions): Promise<Bu
   // `namespaceShadowCssVars`).
   let css = [
     reset,
-    userStyle?.toString(),
+    ...userStyles,
     unoCss,
     surfacesCss,
     primaryRamp,

packages/json-render-ui/scripts/build-css.ts

@@ -1,3 +1,4 @@
+import { createRequire } from 'node:module'
 import { join } from 'node:path'
 import { fileURLToPath } from 'node:url'
 import { colors as c } from 'devframe/utils/colors'
@@ -12,12 +13,17 @@ import config from '../uno.config'
 // host page. See `design/build-shadow-css.ts` for the shared pipeline
 // (mirrored by `@devframes/hub-ui`'s `scripts/build-css.ts`).
 const SRC_DIR = join(fileURLToPath(new URL('..', import.meta.url)), 'src')
+const moduleRequire = createRequire(import.meta.url)
 
 const { sourceCount, css } = await buildShadowCss({
   srcDir: SRC_DIR,
   globs: ['components/**/*.ts', 'renderer.ts', 'dock-renderer.ts', 'renderer-module/**/*.ts'],
   config,
   primaryRampPath: join(SRC_DIR, 'renderer-module/primary-ramp.css'),
+  userStylePath: [
+    moduleRequire.resolve('@antfu/design/styles/scrollbar.css'),
+    join(SRC_DIR, 'renderer-module/style.css'),
+  ],
   varPrefix: '--un-jr-',
 })
 console.log(`${c.green('✓')} CSS built (${sourceCount} sources, ${(css.length / 1024).toFixed(1)} kB)`)

packages/json-render-ui/src/JsonRender.stories.ts

@@ -1,8 +1,9 @@
 import type { Spec } from '@devframes/json-render'
 import type { Meta, StoryObj } from '@storybook/vue3-vite'
-import { h } from 'vue'
+import { h, onMounted, onUnmounted, useTemplateRef } from 'vue'
 import { baseRegistry } from './registry'
 import { JsonRenderView } from './renderer'
+import jsonRenderDockRenderer from './renderer-module'
 
 // A no-op RPC — stories don't dispatch real actions.
 const rpc = { call: async () => undefined }
@@ -20,7 +21,7 @@ const meta: Meta = {
 }
 export default meta
 
-export const Gallery = story({
+const gallerySpec: Spec = {
   root: 'root',
   elements: {
     root: { type: 'Stack', props: { gap: 12 }, children: ['title', 'row', 'card', 'progress', 'table', 'tree'] },
@@ -35,7 +36,9 @@ export const Gallery = story({
     table: { type: 'DataTable', props: { rows: [{ id: 1, name: 'a' }, { id: 2, name: 'b' }] }, children: [] },
     tree: { type: 'Tree', props: { data: { a: 1, b: [true, 'x'] } }, children: [] },
   },
-})
+}
+
+export const Gallery = story(gallerySpec)
 
 export const Controls = story({
   root: 'root',
@@ -103,3 +106,42 @@ export const SubsetRegistry: StoryObj = story(
   },
   { registry: subsetRegistry },
 )
+
+const dockRendererContext = {
+  rpc: { call: rpc.call, connectionMeta: undefined },
+} as unknown as Parameters<typeof jsonRenderDockRenderer>[0]['context']
+
+/** Mounts the shipped dock renderer so the story exercises its shadow root and adopted stylesheet. */
+export const InShadowRoot: StoryObj = {
+  render: () => ({
+    setup() {
+      const host = useTemplateRef<HTMLDivElement>('host')
+      let dispose: (() => void) | undefined
+      let mountToken = 0
+      onMounted(async () => {
+        const token = ++mountToken
+        const instance = await jsonRenderDockRenderer({
+          entry: {
+            id: 'story',
+            title: 'Story',
+            icon: 'ph:cube-duotone',
+            type: 'json-render',
+            view: { spec: gallerySpec },
+          },
+          container: host.value!,
+          context: dockRendererContext,
+        })
+        if (token !== mountToken) {
+          instance.dispose?.()
+          return
+        }
+        dispose = instance.dispose
+      })
+      onUnmounted(() => {
+        mountToken++
+        dispose?.()
+      })
+      return () => h('div', { ref: 'host', class: 'w-full h-80 rounded-lg bg-grid' })
+    },
+  }),
+}

packages/json-render-ui/src/renderer-module/index.ts

@@ -46,29 +46,32 @@ const jsonRenderDockRenderer: JsonRenderDockRenderer = async ({ entry, container
     shadow.append(style)
   }
 
-  // Carries the `.dark`/`.light` class that class-based utilities resolve
-  // against (kept in sync with the viewer's container class), and the native
-  // `color-scheme` for scrollbars and form controls.
+  // Keep the scheme class on an ancestor. Wind3 emits descendant selectors
+  // such as `.dark .bg-base`, which do not match an element carrying both
+  // classes itself.
+  const colorSchemeRoot = document.createElement('div')
+  colorSchemeRoot.style.display = 'contents'
   const root = document.createElement('div')
-  root.className = 'w-full h-full of-auto p4 bg-base color-base font-sans text-sm'
+  root.className = 'devframes-json-render-scroll-root w-full h-full of-auto p4 color-base font-sans text-sm'
   const syncScheme = (): void => {
     const dark = isDarkFor(container)
-    root.classList.toggle('dark', dark)
-    root.classList.toggle('light', !dark)
-    root.style.colorScheme = dark ? 'dark' : 'light'
+    colorSchemeRoot.classList.toggle('dark', dark)
+    colorSchemeRoot.classList.toggle('light', !dark)
+    colorSchemeRoot.style.colorScheme = dark ? 'dark' : 'light'
   }
   syncScheme()
   const observer = new MutationObserver(syncScheme)
   observer.observe(container, { attributes: true, attributeFilter: ['class'] })
   observer.observe(document.documentElement, { attributes: true, attributeFilter: ['class'] })
-  shadow.append(root)
+  colorSchemeRoot.append(root)
+  shadow.append(colorSchemeRoot)
 
   const instance = await inner({ entry, container: root, context })
   return {
     dispose() {
       observer.disconnect()
       instance.dispose?.()
-      root.remove()
+      colorSchemeRoot.remove()
     },
   }
 }

packages/json-render-ui/src/renderer-module/style.css

@@ -0,0 +1,3 @@
+.devframes-json-render-scroll-root {
+  scrollbar-gutter: stable;
+}