@kiwicom/orbit-components
Version:
Orbit-components is a React component library which provides developers with the easiest possible way of building Kiwi.com's products.
47 lines (39 loc) • 3.78 kB
Markdown
# NavigationBar
To implement NavigationBar component into your project you'll need to add the import:
```jsx
import NavigationBar from "@kiwicom/orbit-components/lib/NavigationBar";
import LinkList from "@kiwicom/orbit-components/lib/LinkList";
import TextLink from "@kiwicom/orbit-components/lib/TextLink";
```
After adding import into your project you can use it simply like:
```jsx
<NavigationBar
onMenuOpen={handleDrawerOpen}
menuButtonRef={buttonRef}
menuId="main-navigation-drawer"
menuExpanded={isDrawerOpen}
>
<LinkList direction="row">
<TextLink> Link 1 </TextLink>
<TextLink> Link 2 </TextLink>
<TextLink> Link 3 </TextLink>
</LinkList>
</NavigationBar>
```
## Props
Table below contains all types of the props available in the NavigationBar component.
| Name | Type | Default | Description |
| :----------------- | :----------------------------------- | :----------------------- | :---------------------------------------------------------------------------------------------------------- |
| **children** | `React.Node` | | The content of the NavigationBar. |
| dataTest | `string` | | Optional prop for testing purposes. |
| id | `string` | | Unique identifier for the `NavigationBar`. |
| onMenuOpen | `event => void \| Promise` | | Function for handling onClick event on HamburgerMenu icon. If `null`, the HamburgerMenu won't appear. |
| onHide | `() => void \| Promise` | | Function for handling event when the NavigationBar disappears. |
| onShow | `() => void \| Promise` | | Function for handling event when the NavigationBar appears. |
| hideOnScroll | `boolean` | `true` | Turn on or off hiding navigation bar on scroll |
| openTitle | `string` | `"Open navigation menu"` | Property for passing translation string to open Button. |
| bottomStyle | `"shadow" \| "border"` | `"shadow"` | Property for setting bottom style of NavigationBar. |
| transparentBgAtTop | `boolean` | `false` | Property for setting the background to be transparent when the NavigationBar is at the top of the viewport. |
| menuButtonRef | `React.RefObject<HTMLButtonElement>` | | Reference to access the menu button element for focus management. |
| menuId | `string` | | ID for connecting the button with its controlled drawer via aria-controls. |
| menuExpanded | `boolean` | | Indicates drawer open state for the aria-expanded attribute. |