Skip to content
ArcadiaDesign
At 960 wide, drawn to fit. The rows choose the page as a product's links would; the title takes focus when it changes.

TSX

One frame for every signed-in surface, so the account, a product's dashboard and a product read as one application. A public page keeps the website's frame. The bar and the sidebar sit on the ground and never scroll; the panel is the one raised surface, a step of surface above them with no line round it, since the step parts them already. The page scrolls inside it under a head that stays, with no rule under the head: the page fades into it. The head holds the page's title, at most one quiet readout, and at most one action.

The bar opens with the Arcadia mark and the product's short name, which link to its home, then the crumbs. It ends with one optional slot, the switcher, the bell (AppBell, on its own page under Notifications) and the person's avatar. Its height and the places of the mark, the name, the switcher and the avatar come from the frame's tokens and from nothing a product passes, so moving between products the bar does not move by a pixel. A bar whose mark leads to Arcadia's home instead, as the account's does, passes arcadiaHome: the mark and the name become two links where the one stood.

The frame answers to its own width. Under --app-sheet-breakpoint the sidebar leaves the ground: the bar's start holds the control that opens it as a Sheet, and choosing a row closes it. A product may hold the sheet itself with sheetOpen, so an empty page's action can open it. The panel then stands inset on both sides, so its head and its page step in from its edge by one step less.

Examples

Without a sidebar

A product of one page leaves the sidebar out and the panel keeps the inset at the window's start too.

This page fills the panel: its stream scrolls on its own and the field under it stays.

Narrow, the sheet open

Under the breakpoint the sheet slides from the start over a scrim, on the dialog's times.

Open
Try it

It keeps focus inside, opens on the row you are on, closes on Escape, on a press outside, on its close button where the toggle stood and on a row chosen, and gives focus back to the toggle.

A page that fills the panel

With fill the panel gives the page its whole body and the page brings its own scroller, here one that scrolls both ways and keeps its bar clear of the panel's corner with --scroll-radius at the panel's --radius-frame.

Its head's bar is a second row under the title's, at the head's inset and 8 above the page: the board's filters, those in force as chips and one Clear before the filter button. Given a function, it is told whether the panel is 640 wide; under that the chips stand in the filter menu's head, and with none in force the bar holds the button alone.

The head holds a readout before its one action: the keys the board listens to.

The column's scroller

Without fill the panel scrolls the page itself and hands its scroller out through viewportRef, as ScrollArea does: here older events come as the page nears its end, and the head's readout counts what is shown.

A readout is quiet and never a control: a key, a count, a legend.

The switcher

The grid at the bar's end opens Arcadia's apps from the kit's own list: Home first, then the products by short name. The one you are in carries a check and is not a link.

Try it

The person's menu

The avatar alone, a picture or initials.

Try it

Its menu starts with a 40px picture, the name in Body emphasis and an optional Caption address. It holds the product's own rows; the Arcadia account, left out on the account itself; the theme; and Sign out, which runs onSignOut, a request the product sends itself and never an address to visit.

Without an address

A product that holds no address leaves address out, and its line is not drawn: the name alone heads the menu.

Try it

Long names

Crumbs never wrap: a parent says itself shorter, then fades, then gives way whole, before the page you are on is cut, and the page fades last.

A sidebar longer than the window scrolls under its head with its edge faded.

Settings page

One column at --app-settings-width, each row's label at its start with at most one quiet line under it and its value or control at its end.

Workspace

Name
Key
WKS
Email updates
Language
Description

Data

Members
4
ExportEvery project, as one file

A text field takes one width in every row, a text area the whole row under its label, a readout is mono, and a row that opens something is pressable whole and ends in a chevron.

Any other page

A page that is not settings (members, a record, a table) takes one column at --app-page-width, wider than the settings measure, so its columns have room; on a narrower panel it is the panel's width.

Measures

Each measure is one token, named for the frame; a product never types its number.

TokenUseValue
The bar: one line, the same in every product.
The sidebar beside the panel, and its sheet on a narrow window.
The panel from the window's end and bottom edges, and its start with no sidebar beside it.
The panel's corner: a surface's frame, 12.
A settings page's one column.
Any other page's column: members, a record, a table. A settings page keeps its own.
Under this width of the frame the sidebar becomes a sheet.

Sheet

The narrow form of a pane: from its edge over a scrim, on the dialog's times on the strong ease-out, back out to its edge on close; under reduced motion it fades where it stands.

--sheet-w
TokenRef<Measure>Default var(--app-sidebar-width)
Width, capped so --drawer-gutter of the page stays in sight beside it.

Its width is the sidebar's, capped so --drawer-gutter of the page stays in sight.

The bar is the banner, the sidebar a navigation named by its aria-label, the crumbs a navigation named Breadcrumb, and the panel sits in main. The first stop is a skip link that moves focus to the panel's title. Tab then reads the frame in order: the toggle on a narrow window, the home link, the crumbs, the bar's slot, the switcher, the bell, the avatar, the sidebar's head and rows, then the page. With arcadiaHome the mark is a stop of its own before the name, named Arcadia. The panel's head reads its title, its readout as plain text, then its action.

The current row and the crumbs' last level carry aria-current="page", and the product you are in is marked the same way in the switcher. The switcher is named Arcadia apps and the avatar by the person's name; both open the kit's menu, which takes the arrow keys and Escape. When viewKey changes the title takes focus, so a reader starts in the new view.

The sheet is a modal dialog named like the sidebar: the page behind goes inert, focus starts on the row you are on and stays inside, Escape and a press on the scrim close it, and focus goes back to the toggle, which reports aria-expanded. Every stop draws the kit's ring.

AppFrame

barrequired
ReactNode
The bar: an AppBar.
sidebar
ReactNode
The sidebar: an AppSidebar. Leave it out for a product of one page.
sheetOpen
boolean
The sidebar's sheet on a narrow window, held by the product (an empty page's action can open it).
onSheetOpenChange
(open: boolean) => void
Called when the sheet opens or closes: its toggle, Escape, a press outside, a row chosen.
rootStyle
RootStyle
Typed StyleX override: its size where it is not the whole window (a picture of it).
children
ReactNode
The page: an AppPanel.

productrequired
string
The product's short name beside the mark ("Crew").
homerequired
string
The product's home: the mark and the name link there.
arcadiaHome
string
Arcadia's home, for a bar whose mark leads there rather than to home (the account's): the mark and the name are then two links, standing where the one stood.
crumbs
ReactNode
Where you are inside the product: an AppCrumbs.
end
ReactNode
One control before the switcher, for a product that needs one in the bar.
switcher
ReactNode
The app switcher: an AppSwitcher. Its place is held whether it is there or not.
bell
ReactNode
The bell: an AppBell, between the switcher and the person, in every product.
session
ReactNode
The person's menu: a SessionMenu (a Skeleton circle while the session loads). Its place is held too.

itemsrequired
readonly AppCrumb[]
From the product's first level down to the page.
aria-label
stringDefault "Breadcrumb"
The landmark's name.

products
readonly AppProduct[]Default ARCADIA_APPS
The apps to offer, in order. Left out, Arcadia's own list, ARCADIA_APPS, which is what a product wants; a list is passed only where the addresses differ, as on a developer's machine. Home and the products: never the docs, never the account.
current
string
The name of the app you are in: marked, and not a link.
open
boolean
Controlled open state.
defaultOpen
booleanDefault false
Initial open state when uncontrolled.
onOpenChange
MenuProps["onOpenChange"]
Called when the menu opens or closes.
modal
booleanDefault true
Holds the page's scroll and pointer while open.

namerequired
string
The person's name: the trigger's accessible name, the menu's head and the avatar's initials.
address
string
Their address, under the name; without it the line is not drawn.
picture
string
Their picture's address; without it, the initials of name.
account
string
The Arcadia account's address. Leave it out on the account itself.
themerequired
"system" | "dark" | "light"
The theme chosen now.
onThemeChangerequired
(theme: ThemePreference) => void
Called with the theme picked.
onSignOutrequired
() => void
Signs out: a request, never an address (K48).
busy
booleanDefault false
Signing out is under way: a spinner holds the avatar's place and presses wait.
open
boolean
Controlled open state.
defaultOpen
booleanDefault false
Initial open state when uncontrolled.
onOpenChange
MenuProps["onOpenChange"]
Called when the menu opens or closes.
modal
booleanDefault true
Holds the page's scroll and pointer while open.
children
ReactNode
The product's own rows, before the account (MenuItem, MenuLinkItem: "Admin").

aria-labelrequired
string
The landmark's name ("Team", "Account").
id
string
The landmark's id, for what finds it from outside (a deploy's check of the page, a link to it).
head
ReactNode
What the rows belong to, above them, staying while they scroll (a team picker).
groupsrequired
readonly AppSidebarGroup[]
busy
boolean
The rows are loading (aria-busy).

title
ReactNode
The page's title: text, or a node that renders its own h1 (a title edited in place, which takes tabIndex={-1}).
readout
ReactNode
One quiet thing before the action, never a control: a key, a count, a legend. Text reads as a readout.
action
ReactNode
At most one action, at the head's end (the page's menu).
bar
ReactNode | ((room: boolean) => ReactNode)
The head's second row (O46); a function is told if the panel has room for chips.
fill
booleanDefault false
The page fills the panel and scrolls on its own (a board, a chat with its foot). Without it the page scrolls in the panel as one column, on the head's inset.
viewportRef
Ref<HTMLDivElement>
The column's scrolling element, as ScrollArea hands it: to read or set its scroll, or for useScrollKeys and useStickToBottom. A page with fill brings its own scroller.
viewKey
string
Changes when the view changes (its address): the title then takes focus, so a keyboard and a reader start in the new view.
children
ReactNode
The page.

rootStyle
RootStyle
Typed StyleX override: where the column sits.
childrenrequired
ReactNode
Its SettingsGroups, in order.

aria-labelrequired
string
Its accessible name ("Navigation").
modal
booleanDefault true
true: focus kept inside, the page behind inert and its scroll held. false: none of that, for a sheet drawn open on a page that keeps working (a picture of one).
instant
boolean
Opens in one frame, for an open a key started; its exit still slides.
initialFocus
FocusTarget
Where focus goes on open. Default: the link or button marked current (aria-current="page"), else the first control.
finalFocus
FocusTarget
Where focus goes on close. Default: wherever it was before it opened.
container
PortalContainerDefault document.body
Portal container.
rootStyle
SheetStyle
Typed StyleX override: layout and --sheet-w.
open
boolean
Controlled open state.
defaultOpen
booleanDefault false
Initial open state when uncontrolled.
onOpenChange
(open: boolean, details: OpenChangeDetails) => void
Called when the popup opens or closes, with why (details.reason) and the event.
onOpenChangeComplete
(open: boolean) => void
Called once the open or close transition has finished.
id
string
The dialog's id, for the control that opens it (aria-controls).

Rest props go to <div> props.