created:7/7/2021
updated:7/7/2021
loc
181
comments
2%
failed
24
coverage
92%
Notification
grommet-controls
3.0.2A Box to display notification messages.
Name | Description | Default | Controls | |
|---|---|---|---|---|
INotificationProps(13 properties) | ||||
| a11yTitle | Custom title to be used by screen readers string | - | ||
| status | Status color okinfowarningerrorunknowndisabled | info | ||
| size | The font size of the notification message smallmediumlarge | medium | ||
| state | State label string | - | ||
| strong | Heading bold state boolean | - | ||
| message | Message to be displayed string | Notification... | ||
| icon | Notification icon ReactNode | true | ||
| closer | Closer icon ReactNode | undefined | ||
| onClose | Function that will be called when the user closes the notification (event: MouseEvent<HTMLButtonElement, MouseEvent>) => void | - | ||
| percentComplete | Percent complete Meter for task notifications number | - | 030 / 100 | |
| timestamp | Timestamp for the notification (Date) DateFormat | - | ||
| locale | The locale to use for timestamp, if provided string | en-us | ||
| reverse | If true, reverse the order of the Notification elements boolean | - | ||
BoxProps(27 properties) | ||||
package | imports | peer |
|---|---|---|
grommet ^2.15.0 | TextMeterHeadingButtonBoxPropsBox | * |
grommet-icons/icons/Close ^2.15.0 | Close | * |
StatusCritical | * | |
StatusDisabled | * | |
StatusGood | * | |
StatusInfo | * | |
StatusUnknown | * | |
StatusWarning | * | |
react ^17.0.1 | React | * |
file | imports |
|---|---|
| "../../utils/moment" | longDate |
| "./NotificationProps" | INotificationProps |