oc · docs
documentation

@orangecheck/design


@orangecheck/design / OcDashboardShellProps

Interface: OcDashboardShellProps

Defined in: chrome/dashboard-shell.tsx:48

Properties

PropertyTypeDescriptionDefined in
<a id="property-active"></a> active?stringWhich tool is currently active — matched against each tool's id. Pass undefined on the dashboard hub itself.chrome/dashboard-shell.tsx:65
<a id="property-children"></a> childrenReactNodeMain column content.chrome/dashboard-shell.tsx:73
<a id="property-classname"></a> className?stringclassName for the outer container.chrome/dashboard-shell.tsx:75
<a id="property-description"></a> description?anyPage description — rendered as a paragraph below the title.chrome/dashboard-shell.tsx:71
<a id="property-eyebrow"></a> eyebrow?anyOptional small mono label above the page title.chrome/dashboard-shell.tsx:67
<a id="property-roothref"></a> rootHref?stringDashboard root path — the rail header links here ("§ dashboard"). Default '/dashboard'.chrome/dashboard-shell.tsx:53
<a id="property-sitelabel"></a> siteLabel?anySite display name shown in the rail header above the tools list (e.g. 'oc·attest').chrome/dashboard-shell.tsx:58
<a id="property-title"></a> title?anyPage title — rendered as h1.chrome/dashboard-shell.tsx:69
<a id="property-tools"></a> toolsreadonly OcDashboardTool[]Tools to surface in the left rail.chrome/dashboard-shell.tsx:60