DocsPageHeader
The opening of every docs page in one order.
@sdxc/result
Return failures as values, so every caller sees the error it has to handle.
Works in Workers, Bun and Node.
Last updated
View code
<DocsPageHeader
crumbsLabel="Breadcrumb"
crumbs={[{ label: "Docs", href: "/docs" }, { label: "Packages" }, { label: "@sdxc/result" }]}
title="@sdxc/result"
mono
description="Return failures as values, so every caller sees the error it has to handle."
notice={<PlanNotice>Available on every plan</PlanNotice>}
updated={{ label: "Last updated", date: "2026-10-12", text: "Oct 12, 2026" }}
actions={<PageActions markdownHref="/docs/result.md" labels={labels} links={links} />}
/>Demo docs sites
Whole pages built only from @sdxc/ui, each for an invented product with its own palette and type. They open in a new tab.
- Content docsDriftwood DocsGuides for Driftwood, a command line that deploys static sites: a tutorial, how-to guides and concept pages./demo/docs/driftwood
- Component docsLattice DocsDocs for Lattice UI, a component library: an index of components, each with live previews, props and accessibility notes./demo/docs/lattice
- API referenceParcelo DocsThe HTTP API reference for Parcelo, a shipping-label API: resources, endpoints with request and response fields, and examples in three languages./demo/docs/parcelo
- Utilities docsTempo DocsReference for Tempo, an invented library of CSS utilities: every spacing, colour, layout, type and effect utility drawn beside its call and the CSS it emits./demo/docs/tempo
Every demo, landings and docs sites alike, is listed in the demo gallery.
Installation
An ordinary dependency: install it, import the theme once, and import the component where it is used.
npm add @sdxc/ui remiximport "@sdxc/ui/theme.css";Usage
import { DocsPageHeader } from "@sdxc/ui/docs";Renders the header. Long names in the title or lead break inside the column, the trail wraps whole steps, and under 30rem of header width the page's own crumb hides since the title names it.
Props
Read from the component's own types, so every prop, every default and every allowed value is listed.
| Prop | Type | Required | Description |
|---|---|---|---|
crumbs | Crumb[] | No | The trail from the docs root to this page; the last crumb is the page itself. |
crumbsLabel | string | No | Name of the breadcrumb landmark, such as "Breadcrumb". |
title | RemixNode | Yes | |
mono | boolean | No | Sets the title in the monospace face, for a title that is a name a reader types. |
description | RemixNode | No | The lead under the title. |
updated | Updated | No | |
actions | RemixNode | No | Page actions for the meta row, such as <PageActions>. |
notice | RemixNode | No | A plan or role notice drawn under the lead. |
Also accepts everything in Omit<TagProps<"header">, "children" | "title">.