@brighthr/component-breadcrumb
v1.1.5
Published
To install, type the following into the command line at the root of your project:
Downloads
1,288
Readme
Breadcrumb
To install, type the following into the command line at the root of your project:
npm i @brighthr/component-breadcrumb
To implement the Breadcrumb component into your project you’ll need to add the import:
import Breadcrumb from '@brighthr/component-breadcrumb';
After adding import into your project you can use it simply like:
<Breadcrumb />
Props
| Name | Type | Default | Description |
|-------------|---------------------------------------------------------|----------|------------------------------------------------------------------------------|
| currentPage | string
| | Sets the text to display what the current page is. |
| onClick | event => void
| | Function for handling onClick event. |
| routes | [{ name: string, href: string, iconName?: string }]
| | An array of objects, each object has a page name
, href
and iconName
. |
| size | 'sm'
'base'
'lg'
'xl'
| 'base'
| Sets the size of the breadcrumb. |