App Shell
The App Shell defines the main structure of your app.
Props#
The AppShell component and all sub components accept all Box properties.
| Prop | Type | Default | Description |
|---|---|---|---|
| aside | type ONLY_FOR_FORMAT =
| string
| number
| boolean
| ReactElement<any, string | JSXElementConstructor<any>>
| Iterable<ReactNode>
| ReactPortal
| PromiseLikeOfReactNode | Secondary sidebar, positioned on the right | |
| children | type ONLY_FOR_FORMAT =
| string
| number
| boolean
| ReactElement<any, string | JSXElementConstructor<any>>
| Iterable<ReactNode>
| ReactPortal
| PromiseLikeOfReactNode | The main content | |
| colorScheme | "whiteAlpha" | "blackAlpha" | "gray" | "red" | "orange" | "yellow" | "green" | "teal" | "blue" | "cyan" | "purple" | "pink" | "linkedin" | "facebook" | "messenger" | "whatsapp" | "twitter" | "telegram" | "primary" | "secondary" | "indigo" | The visual color appearance of the component | |
| footer | type ONLY_FOR_FORMAT =
| string
| number
| boolean
| ReactElement<any, string | JSXElementConstructor<any>>
| Iterable<ReactNode>
| ReactPortal
| PromiseLikeOfReactNode | The footer | |
| mainRef | RefObject<HTMLDivElement> | ||
| navbar | type ONLY_FOR_FORMAT =
| string
| number
| boolean
| ReactElement<any, string | JSXElementConstructor<any>>
| Iterable<ReactNode>
| ReactPortal
| PromiseLikeOfReactNode | The top header navigation | |
| sidebar | ReactElement<any, string | JSXElementConstructor<any>> | Main sidebar, positioned on the left | |
| size | string | The size of the AppShell | |
| variant | "static" | "fullscreen" | fullscreen | The variant of the AppShell |
Was this helpful?