alepha@docs:~/docs/.content/release/docs/packages/@alepha-ui$
cat shell.md | pretty
1 min read
Last commit:

#@alepha/ui - Shell

#Installation

npm install @alepha/ui

#Overview

Application shells and their chrome.

$pageNav declares a page that appears in a shell's sidebar, for an app that hangs its pages off its OWN layout rather than the admin shell's ($pageAdmin is the same thing already parented to AdminRouter).

AppShell is the sidebar-and-header frame of an application and NavShell the page-tree variant with its Spotlight search. PlateLayout and DetailLayout frame a page, AppActions a toolbar. ButtonDark, ButtonTheme, ButtonLanguage, ButtonInbox and ButtonUser are the header buttons, and ButtonSettings is the account button with language, theme and display mode folded into its menu once signed in. ActionErrorToaster turns a failed action into a toast.

#API Reference

#Primitives

  • $pageNav - $page sugar for shell pages: declares the page's nav metadata and its

#React Hooks

  • useDetailTab - Binds a detail page's selected tab to ?tab=<key>.