0.1.2 • Published 1 year ago
@brighthr/component-notes v0.1.2
Notes
Installation
To install, type the following into the command line at the root of your project:
npm i @brighthr/component-notesImport
Import into your file:
import Notes from '@brighthr/component-notes';Props
| Name | Type | Default | Description |
|---|---|---|---|
| userName | string | | User name for the Avatar | |
| description | string | | Description for adding the notes | |
| placeholder | string | | Placeholder text for the text area | |
| value | string | | Value of the text area | |
| onChange | (event: React.ChangeEvent<HTMLTextAreaElement>) => void | | Function to handle the text area change | |
| onNoteDismiss | () => void | Function to handle the note dismiss | |
| onNoteSave | () => void | | Function to handle the note save | |
| maxLength | number | Maximum length of the note | |
| isSaveButtonDisabled | boolean | Disables the save button | |
| donutEnabled | boolean | false | Enables the percentage donut for character count |
| charCountEnabled | boolean | false | Enables the character count |
| avatarHref | string | Avatar image path |