live · mainnetoc · docs
specs · api · guides
docs / documentation

@orangecheck/ui


@orangecheck/ui / OcDashboardShellProps

Interface: OcDashboardShellProps

Defined in: dashboard-shell.tsx:49

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.dashboard-shell.tsx:66
<a id="property-children"></a> childrenReactNodeMain column content.dashboard-shell.tsx:74
<a id="property-classname"></a> className?stringclassName for the outer container.dashboard-shell.tsx:76
<a id="property-description"></a> description?anyPage description — rendered as a paragraph below the title.dashboard-shell.tsx:72
<a id="property-eyebrow"></a> eyebrow?anyOptional small mono label above the page title.dashboard-shell.tsx:68
<a id="property-roothref"></a> rootHref?stringDashboard root path — the rail header links here ("§ dashboard"). Default '/dashboard'.dashboard-shell.tsx:54
<a id="property-sitelabel"></a> siteLabel?anySite display name shown in the rail header above the tools list (e.g. 'oc·attest').dashboard-shell.tsx:59
<a id="property-title"></a> title?anyPage title — rendered as h1.dashboard-shell.tsx:70
<a id="property-tools"></a> toolsreadonly OcDashboardTool[]Tools to surface in the left rail.dashboard-shell.tsx:61