terra-consumer-layout
Version:
A re-usable layout component that puts together our navigation
9 lines • 783 B
Markdown
## Layout Props Table
| Prop Name | Type | Is Required | Default Value | Description |
|-|-|-|-|-|
| children| `node`| `required`| | |
| helpItems| `array`| optional| | Array of links to show for the content of the help button|
| intl| `custom`| optional| | Injected react-intl formatting api|
| logo| `an object structured like: {"mobileLogo":{"name":"shape","value":{"url":{"name":"string","required":true},"altText":{"name":"string","required":true}},"description":"A center justified logo in header for mobile.","required":false},"navLogo":{"name":"object","required":false}}`| optional| | A center justified logo in header for mobile.|
| nav| `object`| `required`| | Object of configuration for the side navigation and profile.|
| siteAlert| `element`| optional| | Alert banner|