terra-consumer-nav
Version:
A responsive container that neatly displays logo, quicklinks, navlinks and profile.
7 lines • 935 B
Markdown
| Prop Name | Type | Is Required | Default Value | Description |
|-|-|-|-|-|
| logo| `an object structured like: {"path":{"name":"string","description":"The location where the image to be displayed is stored.","required":false},"altText":{"name":"string","description":"Alternate text used be screen readers.","required":false},"isCard":{"name":"bool","description":"Whether or not the logo should be placed on top of a white card.","required":false}}`| optional| `{}`| An object defining the logo to be displayed|
| navItems| `array`| optional| `[]`| An array of objects to be displayed as nav link options.|
| onRequestClose| `func`| `required`| | Callback function: should be used to close the nav on mobile devices.|
| profile| `an object structured like: {"signinUrl":{"name":"string","required":false},"avatar":{"name":"element","required":false}}`| optional| | Object representing all the profile information|