|
|
|
@ -5,11 +5,11 @@ noinstant: true |
|
|
|
title: Message |
|
|
|
--- |
|
|
|
|
|
|
|
Display global messages as feedbacks to user operations. |
|
|
|
Display global messages as feedback in response to user operations. |
|
|
|
|
|
|
|
## When To Use |
|
|
|
|
|
|
|
- To provide feedbacks such as success, warning, error etc. |
|
|
|
- To provide feedback such as success, warning, error etc. |
|
|
|
- A message is displayed at top and center and will be dismissed automatically, as a non-interrupting light-weighted prompt. |
|
|
|
|
|
|
|
## API |
|
|
|
@ -26,8 +26,8 @@ This components provides some static methods, with usage and arguments as follow |
|
|
|
| Argument | Description | Type | Default | |
|
|
|
|------------|------------------------------------|--------------------------|--------------| |
|
|
|
| content | content of the message | string\|ReactNode | - | |
|
|
|
| duration | time before auto-dismiss,in seconds | number | 1.5 | |
|
|
|
| onClose | Specify a function that will be called after the message closed| Function | - | |
|
|
|
| duration | time before auto-dismiss, in seconds | number | 1.5 | |
|
|
|
| onClose | Specify a function that will be called when the message is closed| Function | - | |
|
|
|
|
|
|
|
Methods for global configuration and destruction are also provided: |
|
|
|
|
|
|
|
@ -45,6 +45,6 @@ message.config({ |
|
|
|
|
|
|
|
| Argument | Description | Type | Default | |
|
|
|
|------------|------------------------------------|--------------------------|-------------| |
|
|
|
| top | distance to top | number | 24px | |
|
|
|
| duration | time before auto-dismiss,in seconds | number | 1.5 | |
|
|
|
| getContainer | specify render container | () => HTMLElement | () => document.body | |
|
|
|
| top | distance from top | number | 24px | |
|
|
|
| duration | time before auto-dismiss, in seconds | number | 1.5 | |
|
|
|
| getContainer | Return the mount node for Message | () => HTMLElement | () => document.body | |
|
|
|
|
Khalifa Lame
7 years ago
ddcat1115