components/message/index.en-US.md · OSCHINA-MIRROR/open-hand-choerodon-ui - gitlife.ru

Проекты с открытым исходным кодом > WEB Application Development > Backend Management Frameworks &&

Присоединиться к Gitlife

Откройте для себя и примите участие в публичных проектах с открытым исходным кодом с участием более 10 миллионов разработчиков. Приватные репозитории также полностью бесплатны :)

Присоединиться бесплатно

Клонировать/Скачать

index.en-US.md 1.8 КБ

---
category: Components
type: Feedback
noinstant: true
title: Message
---

Display global messages as feedback in response to user operations.

## When To Use

- 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

This components provides some static methods, with usage and arguments as following:

- `message.success(content, [duration], onClose)`
- `message.error(content, [duration], onClose)`
- `message.info(content, [duration], onClose)`
- `message.warning(content, [duration], onClose)`
- `message.warn(content, [duration], onClose)` // alias of warning
- `message.loading(content, [duration], onClose)`

| 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 when the message is closed | Function | - |
| placement | the position of message, 可选 `top` `left` `right` `bottom` `topLeft` `topRight` `bottomLeft` `bottomRight` `leftTop` `leftBottom` `rightTop` `rightBottom`| string | `top`|

Methods for global configuration and destruction are also provided:

- `message.config(options)`
- `message.destroy()`

### message.config

```js
message.config({
  top: 100,
  duration: 2,
});
```

| Argument | Description | Type | Default |
| -------- | ----------- | ---- | ------- |
| duration | time before auto-dismiss, in seconds | number | 1.5 |
| getContainer | Return the mount node for Message | () => HTMLElement | () => document.body |
| top | the position of the message when it appears on the top | number | 24px |
| bottom | the position of the message when it appears on the bottom | number | 24px |

Копировать Исходные данные Просмотреть построчно История

Отправлено 7 лет назад f03bd7d

category	type	noinstant	title
Components	Feedback	true	Message

Display global messages as feedback in response to user operations.

When To Use

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

This components provides some static methods, with usage and arguments as following:

message.success(content, [duration], onClose)
message.error(content, [duration], onClose)
message.info(content, [duration], onClose)
message.warning(content, [duration], onClose)
message.warn(content, [duration], onClose) // alias of warning
message.loading(content, [duration], onClose)

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 when the message is closed	Function	-
placement	the position of message, 可选 `top` `left` `right` `bottom` `topLeft` `topRight` `bottomLeft` `bottomRight` `leftTop` `leftBottom` `rightTop` `rightBottom`	string	`top`

Methods for global configuration and destruction are also provided:

message.config(options)
message.destroy()

message.config

message.config({
  top: 100,
  duration: 2,
});

Argument	Description	Type	Default
duration	time before auto-dismiss, in seconds	number	1.5
getContainer	Return the mount node for Message	() => HTMLElement	() => document.body
top	the position of the message when it appears on the top	number	24px
bottom	the position of the message when it appears on the bottom	number	24px

Опубликовать ( 0 )

Вы можете оставить комментарий после Вход в систему

1

https://gitlife.ru/oschina-mirror/open-hand-choerodon-ui.git

git@gitlife.ru:oschina-mirror/open-hand-choerodon-ui.git

oschina-mirror

open-hand-choerodon-ui

open-hand-choerodon-ui

release-0.2.2