@front10/landing-page-book

Version:
A react library for landing page
22 lines (20 loc) • 1.29 kB
Markdown
# Navbar
  [![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)
  

  ## Properties
  | </br>Name | </br>Type | </br>Summary | </br>Default | 
| ---- | ---- | ---- | ---- |
| bgColor | `string` | Background color of navar. | `'dark'` |
| brandLink | `string` | Link to go when brand name or logo has clicked. | `''` |
| brandLogo | `string` | Image logo url. | `''` |
| brandName | `string` | Brand name of component. | `''` |
| brandTextColor | `string` | Text color of brand. | `'light'` |
| children | `union` | Elements show into the Navbar | `null` |
| className | `string` | Class to apply. | `''` |
| expand | `string` | Resolution to expand Navbar. | `''` |
| fixed | `bool` | Define if component is fixed. | `false` |
| leftItems | `arrayOf` | Array of items to show in nav-bar left side. | `[]` |
| linkTextColor | `string` | Color of navar link. | `'light'` |
| onItemClick | `func` | Called when item has clecked. See example section | `() => {}` |
| rightItems | `arrayOf` | Array of items to show in nav-bar right side. | `[]` |
| style | `objectOf` | Customs styles to tramsform your Hero | `null` |
| transparent | `bool` | Define if component is transparent. | `false` |