Skip to content

App Header

Title/description/leading/trailing screen-header composition; owns no navigation library.

  • Category: Navigation & disclosure
  • 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/app-header.tsx
import { AppHeader } from '@beemvp/beeui-ui';

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

Terminal window
pnpm beeui add app-header

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.

  • Primary export: AppHeader
    • Also routed here, outside the Registry family:
      • app-header
    • Package export subpath: @beemvp/beeui-ui/app-header

Exported types: AppHeaderProps

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.

Stateless title/description/leading/trailing composition with no controlled props or callbacks; a primitive title receives header accessibility semantics automatically, while a complex title node owns its own semantics.

Prop Type Default Description
bordered boolean true Renders a bottom border separating the header from the content below. Defaults to true.
className string — Extra utility classes, merged after the component’s own via cn(...), so they win on conflict. An escape hatch for source-owned and application work, not a cross-engine portability guarantee.
description React.ReactNode — Secondary supporting text rendered beneath the primary label or title.
descriptionClassName string — Applied to the description Text when description is a plain string or number; ignored if description is a custom element.
leading React.ReactNode — Rendered before the title/description column, shrink-to-content (e.g. a back button or logo).
title (required) React.ReactNode — The primary heading text for this surface.
titleClassName string — Applied to the title Text when title is a plain string or number; ignored if title is a custom element.
trailing React.ReactNode — Content rendered at the end of the row, after the primary content — actions, badges or status.

Also carries every prop of Omit<ViewProps, 'children'> — that upstream contract is not reproduced here.

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

  • No additional provider is required by this family. BeeUIProvider remains the recommended application root.
  • Peer/native dependencies visible to this Registry item: react, react-native
  • Registry dependency closure: box, core-cn, text, theme
  • 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.

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.

  • Roles this family assigns: header — set in app-header.tsx by the components themselves, not by the caller.
  • Accessibility states and properties it sets: none set in app-header.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.

  • Style axes: none of its own — its appearance comes from tokens and your own classes; it also carries Omit<ViewProps, 'children'>.
  • Class-name surfaces: className, descriptionClassName, titleClassName.

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.

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.

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.

  • Family root / primary export: AppHeader
    • Exported type surface:
      • AppHeaderProps

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.

These are the parts of the typechecked runtime Showcase fixture behind this live preview — apps/showcase/component-gallery/component-gallery.tsx, 1103 lines — where App Header is actually used: 20 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 { AppHeader, Avatar, Button, HStack, Switch } from '@beemvp/beeui-ui';
import * as React from 'react';
import { Uniwind, useUniwind } from 'uniwind';

Fixture state this block reads (same file, lines 121-137, 458):

function ThemeToggle() {
const { hasAdaptiveThemes, theme } = useUniwind();
const activeTheme = hasAdaptiveThemes ? 'system' : theme;
const nextTheme = activeTheme === 'system' ? 'light' : activeTheme === 'light' ? 'dark' : 'system';
return (
<Button
accessibilityLabel={`Theme ${activeTheme}. Switch to ${nextTheme}`}
onPress={() => Uniwind.setTheme(nextTheme)}
size="sm"
testID="component-gallery-theme-toggle"
variant="outline"
>
{`Theme: ${activeTheme}`}
</Button>
);
}
const { theme } = useUniwind();

Placeholder for a prop this fixture receives (not fixture source — substitute your own handler):

const onBack: () => void = () => {};

lines 477–496:

<AppHeader
description="Interactive React Native component playground built entirely from the public BeeUI API."
testID="component-gallery-header"
leading={
<HStack gap="sm">
<Button
accessibilityLabel="Back to Showcase home"
testID="component-gallery-back"
onPress={onBack}
size="sm"
variant="ghost"
>
Back
</Button>
<Avatar accessibilityLabel="BeeUI" fallback="BU" />
</HStack>
}
title="Component Gallery"
trailing={<ThemeToggle />}
/>

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.

title is required, and titleClassName/descriptionClassName reach the rendered text only when the corresponding prop is a plain string or number; pass an element and the class name is dropped along with the automatic header semantics.