Theme Scope

BeeThemeScope subtree boundary that applies a scoped theme override to its descendants.

Distribution status

BeeUI 0.86.2-rc.3 is public on npm under the opt-in next dist-tag (observed 2026-09-25T06:25:18.371Z). latest currently resolves to 0.86.2-rc.3 and lags next until the owner moves it for all four packages. See Start for the full install commands. The import shape below works against the published package; the repository-local Registry command remains available as a no-registry-required alternative from a BeeUI checkout. Pin @0.86.2-rc.3 instead of @next for an immutable version in CI.

Identity

• Category: Theming & utilities
• Status: stable public Registry/export-map component family
• Targets: iOS · Android · Web, subject to the compatibility contract
• Prerequisites: @beemvp/beeui-ui installed (or this component’s source copied via the Registry CLI below) and, on Web, the BeeUI Tailwind/Uniwind theme CSS loaded — see Start for full platform setup.
• Source: packages/ui/src/components/theme-scope.tsx

Import

import { BeeThemeScope } from '@beemvp/beeui-ui';

There is no documented deep/private source import. For source ownership from a BeeUI checkout:

pnpm beeui add theme-scope

Registry (used throughout this page) is BeeUI’s source-ownership manifest — registry/registry.json — that the pnpm beeui/@beemvp/beeui-cli CLI reads to copy a component’s real source into your app and rewrite its internal imports; it is not an npm package index. This component’s own Registry entry: registry/registry.json.

Composition and public API

• Primary export: BeeThemeScope
  • Also routed here, outside the Registry family:
    • theme-scope
  • Package export subpath: @beemvp/beeui-ui/theme-scope

Exported types: BeeThemeScopeProps

The generated API inventory is mechanically joined to packages/ui/src/index.ts, Registry metadata, and the component reference contract. Each type’s field table below is parsed directly from that source, not a second hand-maintained copy; for the fuller behavior narrative see the canonical component behavior catalog.

State and behavior contract

Stateless BeeThemeScope subtree boundary; it applies a scoped theme override to descendants with no controlled props of its own — precedence rules are documented in docs/theme-scope.md.

Props

BeeThemeScopeProps

one of the following mutually exclusive variants:

Variant brand + appearance:

Prop	Type	Default	Description
registry	ThemeRegistry<Def>	—	The registry used to resolve brand/appearance (or validate theme). Defaults to beeThemeRegistry (Bee + Violet, from #67). Pass a registry built with defineThemeRegistry to scope by a consumer-defined brand.
children	React.ReactNode	—	Content rendered inside this element. The family’s composition section states which children it expects.
brand (required)	RegistryBrand<Def>	—	Semantic brand, resolved through registry.
appearance (required)	RegistryAppearance<Def>	—	Semantic appearance, resolved through registry.

Variant theme:

Prop	Type	Default	Description
registry	ThemeRegistry<Def>	—	The registry used to resolve brand/appearance (or validate theme). Defaults to beeThemeRegistry (Bee + Violet, from #67). Pass a registry built with defineThemeRegistry to scope by a consumer-defined brand.
children	React.ReactNode	—	Content rendered inside this element. The family’s composition section states which children it expects.
theme (required)	RegistryRuntimeTheme<Def>	—	An already-resolved Uniwind runtime-theme name, validated against registry.

The executable fixtures below are the source-grounded usage examples; consumers should not infer state ownership from DOM structure or another UI library.

Provider and dependencies

• No additional provider is required by this family. BeeUIProvider remains the recommended application root.
• Peer/native dependencies visible to this Registry item: react, uniwind
• Registry dependency closure: theme, theme-scope-bridge
• Safe-area ownership remains explicit: shell surfaces touching system edges opt into SafeArea; components do not silently invent app-shell insets.
• Web consumers load the BeeUI semantic theme CSS as documented in Web onboarding.

Platform behavior

This family ships no platform-specific file, and its own source takes no Platform branch.

The same public family is exposed across the supported target matrix; meaningful platform differences remain governed by the compatibility contract.

Evidence classes are not equal and this page does not blur them: Web behavior is exercised in a real browser, while iOS and Android carry package/export and native-compile evidence, which is not device-runtime proof. The compatibility contract records which class each claim rests on.

Accessibility

• Roles this family assigns: none set in theme-scope.tsx.
• Accessibility states and properties it sets: none set in theme-scope.tsx.

Keyboard/focus behavior, announcements, Dynamic Type/Web zoom, RTL and reduced-motion expectations are not derived here — see Accessibility overview, Keyboard & focus, RTL/localization and Large text & zoom. BeeUI does not claim universal accessibility certification from automated tests.

Styling and theming

• Style axes: none; this family has no variant or size prop, so its appearance comes from tokens and your own classes.
• Class-name surfaces: none; this family accepts no className of its own.

Colors, spacing and typography come from semantic tokens rather than from values written here — see Theming and Density. A className is an escape hatch for source-owned and application work, not a cross-engine portability guarantee.

Executable examples

• Primary executable fixture: apps/showcase/__tests__/issue-68-theme-scope.test.tsx
• Additional fixture: apps/showcase/__tests__/issue-72-token-reader.test.tsx
• Additional fixture: apps/showcase/__tests__/perf-theme-runtime.test.tsx
• Additional fixture: apps/showcase/__tests__/theme-tokens-v3-chart.test.tsx

Addressable examples

Each link below opens the Showcase at that exact example, not at the top of the gallery:

• basic — smallest meaningful complete usage

The Showcase links demonstrate Web behavior; use the native-preview guide for real simulator/emulator/device paths.

Live Web preview

This frame loads the real BeeUI Web Showcase on demand; it is not a second docs-only implementation. It proves browser behavior only. Use native preview for iOS/Android simulator, emulator or device paths.

Composition anatomy

• Family root / primary export: BeeThemeScope
  • Exported type surface:
    • BeeThemeScopeProps

The tree above is ordinary document structure so it remains readable with keyboard and assistive technology; it is derived from the real public export family rather than a canvas-only diagram.

Verified example source

These are the parts of the typechecked runtime Showcase fixture behind this live preview — apps/showcase/component-gallery/component-gallery.tsx, 1103 lines — where Theme Scope is actually used: 40 lines in 1 place. Each block is copied verbatim from the line range named above it, so it is the same executable source, not a retelling of it. The rest of that file exercises other families and is not reproduced here.

Imports the examples below need (a filtered subset of the fixture’s own top-level imports):

import { BeeThemeScope, Dialog, DialogClose, DialogContent, DialogTitle, DialogTrigger, DropdownMenu, DropdownMenuContent, DropdownMenuLabel, DropdownMenuTrigger, Popover, PopoverContent, PopoverTitle, PopoverTrigger, Text, VStack } from '@beemvp/beeui-ui';
import { useUniwind } from 'uniwind';

Fixture state this block reads (same file, line 321-324):

function ThemeScopeValue({ testID }: { testID: string }) {
  const { theme } = useUniwind();
  return <Text testID={testID}>{`theme: ${theme}`}</Text>;
}

lines 329–368:

      <BeeThemeScope appearance="dark" brand="violet">
        <VStack gap="sm">
          <ThemeScopeValue testID="theme-scope-root-value" />

          <Popover>
            <PopoverTrigger testID="theme-scope-popover-trigger" variant="outline">
              Popover in scope
            </PopoverTrigger>
            <PopoverContent placement="bottom">
              <PopoverTitle>Popover in a BeeThemeScope</PopoverTitle>
              <ThemeScopeValue testID="theme-scope-popover-value" />
            </PopoverContent>
          </Popover>

          <DropdownMenu>
            <DropdownMenuTrigger testID="theme-scope-menu-trigger" variant="outline">
              Menu in scope
            </DropdownMenuTrigger>
            <DropdownMenuContent>
              <DropdownMenuLabel>Menu in a BeeThemeScope</DropdownMenuLabel>
              <ThemeScopeValue testID="theme-scope-menu-value" />
            </DropdownMenuContent>
          </DropdownMenu>

          <Dialog>
            <DialogTrigger testID="theme-scope-dialog-trigger">Dialog in scope</DialogTrigger>
            <DialogContent>
              <DialogTitle>Dialog inside a BeeThemeScope</DialogTitle>
              <ThemeScopeValue testID="theme-scope-dialog-value" />
              <DialogClose size="sm" variant="ghost">
                Close
              </DialogClose>
            </DialogContent>
          </Dialog>

          <BeeThemeScope appearance="light" brand="bee">
            <ThemeScopeValue testID="theme-scope-nested-value" />
          </BeeThemeScope>
        </VStack>
      </BeeThemeScope>

Open the fixture itself for the full surrounding component. For a smaller app-specific example, start from the imports and fixture-state blocks above and keep only the state your screen owns.

Limitations

On the legacy overlay-transport path — JS-only test environments, and any native runtime without the New Architecture or a registered teleport host — portaled overlay content is re-rendered under the host mounted at the provider, outside this scope, so the scoped theme does not reach it. An unrecognized theme name throws during render instead of falling back.

Implementation note: See docs/theme-scope.md for the scoping and precedence rules.

Related

• All components
• Production patterns
• Showcase
• CLI & source ownership
• Source