To install, type the following into the command line at the root of your project:
npm i @brighthr/component-input
To implement the Input component into your project you’ll need to add the import:
import Input from '@brighthr/component-input';After adding import into your project you can use it simply like:
<Input />| Name | Type | Default | Description |
|---|---|---|---|
| buttonAriaLabel | string |
Sets the aria-label for the button if hasOverlay and hasButton are true. |
|
| disabled | boolean |
If true, disables the input. |
|
| error | boolean |
false |
If true, shows a red error theme. |
| inputSize |
'base' 'xl'
|
'base' |
Sets the size of the input. |
| label | string |
Sets the label text. | |
| leftIconName | IconName |
Sets the icon to display on the left (See Icon component). | |
| onClickButton | () => void |
Function to handle onclick. | |
| required | boolean |
false |
If true, sets the html input as required and adds the red required text. |
| rightIconName | IconName |
Sets the icon to display on the right (See Icon component). | |
| unit |
'days' 'hrs' 'mins'
|
Sets the unit to display. |