@duro-app/ui 5.22.0 → 5.23.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@duro-app/ui",
-  "version": "5.22.0",
+  "version": "5.23.0",
   "type": "module",
   "license": "MIT",
   "repository": {
@@ -92,7 +92,7 @@
   "dependencies": {
     "@tanstack/react-virtual": "^3.14.13",
     "qrcode": "^1.5.4",
-    "@duro-app/tokens": "^5.22.0"
+    "@duro-app/tokens": "^5.23.0"
   },
   "devDependencies": {
     "@babel/preset-typescript": "^7.28.0",

package/src/components/AppShell/AppShell.meta.ts

@@ -2,7 +2,7 @@ import type {ComponentMeta} from '../component-meta'
 
 export const meta: ComponentMeta = {
   description:
-    "An application's frame: a navigation rail (a labelled nav, the brand at its top, an optional footer at its foot) beside the main content (main), with an optional Header. Below collapseBelow (sm default, md or lg), measured on the shell's own width, the rail is hidden and one sticky bar (a banner, appBarH tall) holds a Menu button that opens the same navigation in a left Drawer, the brand, and the Header's content when there is one — a shell without a Header still has its navigation on a phone. Above it the Header is a row that scrolls with the page and the rail stays sticky. CSS makes the switch: the server renders one HTML for every width with the brand in both places, and display: none hides the inactive copy, so nothing moves after hydration. A skip link (the first tab stop) focuses Main; an Aside inside Main sticks below the bar. Labels come from props. Compound component — Root is required. On React Native it is always the narrow shape: the bar below the status bar, Main under it, and the Rail in a left Drawer; there is no skip link.",
+    "An application's frame: a navigation rail (a labelled nav, the brand at its top, an optional footer at its foot) beside the main content (main), with an optional Header. Below collapseBelow (sm default, md or lg), measured on the shell's own width, the rail is hidden and one sticky bar (a banner, appBarH tall) holds a Menu button that opens the same navigation in a left Drawer, the brand, and the Header's content when there is one — a shell without a Header still has its navigation on a phone. Above it the Header is a row that scrolls with the page and the rail stays sticky. CSS makes the switch: the server renders one HTML for every width with the brand in both places, and display: none hides the inactive copy, so nothing moves after hydration. A skip link (the first tab stop) focuses Main; an Aside inside Main sticks below the bar. Labels come from props. Compound component — Root is required. On React Native it is always the narrow shape: the bar below the status bar, Main under it, and the Rail in a left Drawer; there is no skip link. scroll=\"main\" makes it an app frame rather than a page: the shell is the viewport's height and Main scrolls on its own, so a SplitPane or VirtualList inside it fills Main and scrolls its own panes.",
   whenToUse: [
     'The frame of an app with a persistent navigation rail: an admin, a docs site, a dashboard',
     'A layout whose navigation must collapse into a drawer on a phone',

package/src/components/AppShell/AppShell.native.tsx

@@ -18,6 +18,7 @@ import {InLandmarkContext} from '../../shared/InLandmarkContext'
 import {nativeStyles} from './native.css'
 
 export type AppShellCollapse = 'sm' | 'md' | 'lg'
+export type AppShellScroll = 'page' | 'main'
 
 interface AppShellContextValue {
   open: boolean
@@ -47,6 +48,8 @@ interface RootProps {
   brand?: ReactNode
   /** Web only: a phone is below every breakpoint, so native always shows the bar and the drawer. */
   collapseBelow?: AppShellCollapse
+  /** Web only: native Main always fills the screen under the bar and its content scrolls itself. */
+  scroll?: AppShellScroll
   /** `AppShell.Rail`, `AppShell.Main` and an optional `AppShell.Header`, as direct children. */
   children: ReactNode
 }

package/src/components/AppShell/AppShell.stories.tsx

@@ -20,6 +20,8 @@ import {TextLink} from '../TextLink/TextLink'
 import {Aside} from '../Aside/Aside'
 import {Stack} from '../Stack/Stack'
 import {Prose} from '../Prose/Prose'
+import {SplitPane} from '../SplitPane/SplitPane'
+import {VirtualList} from '../VirtualList/VirtualList'
 
 // --- the story's frame -----------------------------------------------------
 
@@ -853,3 +855,69 @@ export const MenuButtonTouchTarget: Story = {
     })
   },
 }
+
+const ROWS = Array.from({length: 500}, (_, i) => ({id: i, text: `Message ${i + 1}`}))
+
+/**
+ * `scroll="main"`: an app, not a document. The shell is the viewport's height and Main scrolls on
+ * its own, so a SplitPane inside it fills Main and each pane scrolls by itself — here a 500-row
+ * VirtualList that mounts only the rows in view.
+ */
+export const ScrollMain: Story = {
+  render: () => (
+    <AppShell.Root
+      menuLabel="Menu"
+      closeLabel="Close navigation"
+      skipLabel="Skip to content"
+      brand={BRAND}
+      scroll="main"
+    >
+      <AppShell.Rail aria-label="Navigation">
+        <SideNav.Root value="/sessions">
+          <SideNav.Item value="/sessions">Sessions</SideNav.Item>
+        </SideNav.Root>
+      </AppShell.Rail>
+      <AppShell.Main>
+        <SplitPane.Root
+          aria-label="Resize the session list"
+          defaultSize="sidebarW"
+          minSize="sidebarW"
+          maxSize="panelLg"
+        >
+          <SplitPane.Pane>
+            <Text>Sessions</Text>
+          </SplitPane.Pane>
+          <SplitPane.Handle />
+          <SplitPane.Pane>
+            <VirtualList
+              aria-label="Transcript"
+              items={ROWS}
+              getKey={(row) => row.id}
+              estimateSize="controlLg"
+              anchor="end"
+              renderItem={(row) => <Text>{row.text}</Text>}
+            />
+          </SplitPane.Pane>
+        </SplitPane.Root>
+      </AppShell.Main>
+    </AppShell.Root>
+  ),
+}
+
+/** ScrollMain's checks: Main stays within the viewport and the list windows its rows. */
+export const ScrollMainBoundsMain: Story = {
+  ...ScrollMain,
+  tags: TEST_ONLY,
+  play: async () => {
+    const main = document.querySelector('main')!
+    const list = await waitFor(() => page().getByRole('list', {name: 'Transcript'}))
+    await waitFor(() =>
+      expect(list.querySelectorAll('[role="listitem"]').length).toBeGreaterThan(0),
+    )
+    await expect(main.getBoundingClientRect().bottom).toBeLessThanOrEqual(window.innerHeight)
+    await expect(list.querySelectorAll('[role="listitem"]').length).toBeLessThan(100)
+    await expect(list.scrollHeight).toBeGreaterThan(list.clientHeight)
+    // The document itself does not scroll: Main does.
+    await expect(document.documentElement.scrollHeight).toBeLessThanOrEqual(window.innerHeight)
+  },
+}

package/src/components/AppShell/AppShell.tsx

@@ -39,6 +39,8 @@ import {styles} from './styles.css'
  * stop) focuses. */
 
 export type AppShellCollapse = 'sm' | 'md' | 'lg'
+/** `page`: the document scrolls (a docs site). `main`: the shell is the viewport, Main scrolls (an app). */
+export type AppShellScroll = 'page' | 'main'
 
 interface AppShellContextValue {
   open: boolean
@@ -46,6 +48,7 @@ interface AppShellContextValue {
   closeLabel: string
   brand: ReactNode
   collapseBelow: AppShellCollapse
+  scroll: AppShellScroll
   mainId: string
   mainRef: RefObject<HTMLElement | null>
 }
@@ -109,6 +112,13 @@ interface RootProps {
    * becomes a Drawer behind the Menu button. Default `sm`.
    */
   collapseBelow?: AppShellCollapse
+  /**
+   * What scrolls. `page` (default): the document, a page that grows with its
+   * content. `main`: the shell is exactly the viewport's height and Main
+   * scrolls on its own, so a SplitPane or VirtualList inside it can fill Main
+   * and scroll its own panes (an app such as a chat or a mail client).
+   */
+  scroll?: AppShellScroll
   /**
    * `AppShell.Rail`, `AppShell.Main` and an optional `AppShell.Header`, as
    * direct children (Root places the Header's content in its bar).
@@ -122,6 +132,7 @@ function Root({
   skipLabel,
   brand,
   collapseBelow = 'sm',
+  scroll = 'page',
   children,
 }: RootProps) {
   const [open, setOpen] = useState(false)
@@ -165,8 +176,8 @@ function Root({
   }, [open])
 
   const value = useMemo(
-    () => ({open, setOpen, closeLabel, brand, collapseBelow, mainId, mainRef}),
-    [open, closeLabel, brand, collapseBelow, mainId],
+    () => ({open, setOpen, closeLabel, brand, collapseBelow, scroll, mainId, mainRef}),
+    [open, closeLabel, brand, collapseBelow, scroll, mainId],
   )
 
   // Focus Main itself (tabIndex -1), not just scroll to it, and leave the
@@ -179,7 +190,7 @@ function Root({
   return (
     <AppShellContext.Provider value={value}>
       <html.div ref={containerRef} style={styles.container}>
-        <html.div style={[styles.grid, variant.grid]}>
+        <html.div style={[styles.grid, variant.grid, scroll === 'main' && styles.gridViewport]}>
           <html.div style={styles.skip}>
             <TextLink href={`#${mainId}`} onNavigate={skip}>
               {skipLabel}
@@ -318,7 +329,7 @@ interface MainProps {
 }
 
 function Main({children, id, ref}: MainProps) {
-  const {mainId, mainRef, collapseBelow} = useAppShell()
+  const {mainId, mainRef, collapseBelow, scroll} = useAppShell()
   const setRef = useCallback(
     (node: HTMLElement | null) => {
       mainRef.current = node
@@ -332,7 +343,7 @@ function Main({children, id, ref}: MainProps) {
       ref={setRef}
       id={id ?? mainId}
       tabIndex={-1}
-      style={[styles.main, variants[collapseBelow].main]}
+      style={[styles.main, variants[collapseBelow].main, scroll === 'main' && styles.mainScrolls]}
     >
       {children}
     </html.main>

package/src/components/AppShell/styles.css.ts

@@ -47,6 +47,10 @@ export const styles = css.create({
     backgroundColor: colors.bg,
     gridTemplateRows: 'auto 1fr',
   },
+  // scroll="main": the shell is the viewport, so Main's row has a definite height.
+  gridViewport: {
+    height: '100dvh',
+  },
   gridSm: {
     gridTemplateColumns: {default: 'minmax(0, 1fr)', [WIDE_SM]: RAIL_COLUMNS},
     gridTemplateAreas: {default: NARROW_AREAS, [WIDE_SM]: WIDE_AREAS},
@@ -204,6 +208,12 @@ export const styles = css.create({
     // Focused by the skip link: no ring on a region that is not a control.
     outlineStyle: 'none',
   },
+  // scroll="main": Main is a bounded region that scrolls by itself, and a
+  // child that fills it (height 100%) gets that bound.
+  mainScrolls: {
+    minHeight: 0,
+    overflowY: 'auto',
+  },
   mainSm: {
     paddingLeft: {default: spacing.md, [WIDE_SM]: spacing.lg},
     paddingRight: {default: spacing.md, [WIDE_SM]: spacing.lg},

package/src/components/VirtualList/VirtualList.meta.ts

@@ -2,7 +2,7 @@ import type {ComponentMeta} from '../component-meta'
 
 export const meta: ComponentMeta = {
   description:
-    'A windowed list on @tanstack/react-virtual: only the rows in view (plus overscan) are mounted, and rows are measured so they may differ in height. role="list" with listitem rows carrying aria-setsize and aria-posinset. anchor="end" opens at the last item and stays pinned to the bottom while new items arrive and the reader is at the bottom (a transcript, a log). It fills its parent, or stops at maxHeight. onStartReached fires once each time the reader scrolls to the start (load older history), and prepending items keeps the first visible row in place. On native it is a FlatList with the same props (role list; rows carry no listitem role, which React Native lacks) (maintainVisibleContentPosition for prepend).',
+    'A windowed list on @tanstack/react-virtual: only the rows in view (plus overscan) are mounted, and rows are measured so they may differ in height. role="list" with listitem rows carrying aria-setsize and aria-posinset. anchor="end" opens at the last item and stays pinned to the bottom while new items arrive and the reader is at the bottom (a transcript, a log). It fills its parent, or stops at maxHeight. onStartReached fires once each time the reader scrolls to the start (load older history), and prepending items keeps the first visible row in place. On native it is a FlatList with the same props (role list; rows carry no listitem role, which React Native lacks) (maintainVisibleContentPosition for prepend). The scroll region is a tab stop with a focus ring, so the keyboard can scroll rows that hold no control.',
   whenToUse: [
     'Hundreds to tens of thousands of rows: sessions, a chat transcript, log lines',
     'A list that grows at the bottom while the reader follows it (anchor="end")',

package/src/components/VirtualList/VirtualList.tsx

@@ -167,6 +167,8 @@ export function VirtualList<T>({
       ref={scrollRef}
       role="list"
       aria-label={ariaLabel}
+      // A scroll region the keyboard reaches even when no row holds a control.
+      tabIndex={0}
       style={[
         styles.scroller,
         maxHeight !== undefined && styles.scrollMax(resolveLength(maxHeight)),

package/src/components/VirtualList/styles.css.ts

@@ -1,4 +1,6 @@
 import {css} from 'react-strict-dom'
+import {colors} from '@duro-app/tokens/tokens/colors.css'
+import {borders} from '@duro-app/tokens/tokens/borders.css'
 
 export const styles = css.create({
   // The scroll container: it fills its parent (a pane, a flex column) by
@@ -10,6 +12,11 @@ export const styles = css.create({
     minHeight: 0,
     overflowY: 'auto',
     overscrollBehavior: 'contain',
+    // Focusable so the keyboard can scroll rows that hold no control (WCAG 2.1.1).
+    outlineWidth: {default: 0, ':focus-visible': borders.focusRing},
+    outlineStyle: {default: 'none', ':focus-visible': 'solid'},
+    outlineColor: {default: 'transparent', ':focus-visible': colors.accent},
+    outlineOffset: {default: 0, ':focus-visible': `calc(-1 * ${borders.focusRing})`},
   },
   scrollMax: (maxHeight: number | string) => ({
     height: 'auto',

package/src/index.native.ts

@@ -73,6 +73,7 @@ export {SplitPane} from './components/SplitPane/SplitPane'
 export {
   AppShell,
   type AppShellCollapse,
+  type AppShellScroll,
   type AppShellRailState,
 } from './components/AppShell/AppShell'
 

package/src/index.ts

@@ -13,6 +13,7 @@ export {Alert, type AlertVariant} from './components/Alert/Alert'
 export {
   AppShell,
   type AppShellCollapse,
+  type AppShellScroll,
   type AppShellRailState,
 } from './components/AppShell/AppShell'
 export {Aside} from './components/Aside/Aside'