Ant Design Blazor
Message全局提示
全局展示操作反馈信息。
何时使用
- 可提供成功、警告和错误等反馈信息。
- 顶部居中显示并自动消失，是一种不打断用户操作的轻量级提示方式。
Examples
信息提醒反馈。
自定义时长 10s，默认时长为 3s。
可以通过 Task 接口在关闭后运行 callback 。以上用例将在每个 message 将要结束时通过 ContinueWith 显示新的 message 。
在异步操作执行期间显示加载提示，操作完成后自动关闭提示。使用 LoadingWhen 扩展方法可以简化这一过程。
Message API#
| 属性 | 描述 | 类型 | 默认值 |
|---|---|---|---|
| Id | 属性组件 HTML 的 ID | String | Uniquely Generated ID |
| Class | 属性为 DOM 元素指定一个或多个类名。 | String | -- |
| Style | 属性指定 DOM 元素的内联样式。 | String | -- |
| RefBack | 属性一个 ForwardRef 实例。您可以使用 AntDesign.ForwardRef.Current 获取对内部 DOM 的引用。 |
ForwardRef | -- |
IMessageService API#
| 方法签名 | 返回类型 | 描述 |
|---|---|---|
| Config(MessageGlobalConfig config) | void | 配置全局消息选项 |
| Destroy() | void | |
| Error(OneOf<String, RenderFragment, MessageConfig> content, Double? duration, Action onClose) | void | 显示错误信息 |
| ErrorAsync(OneOf<String, RenderFragment, MessageConfig> content, Double? duration, Action onClose) | Task | Show error message asynchronously |
| Info(OneOf<String, RenderFragment, MessageConfig> content, Double? duration, Action onClose) | void | 显示信息消息 |
| InfoAsync(OneOf<String, RenderFragment, MessageConfig> content, Double? duration, Action onClose) | Task | Show info message asynchronously |
| Loading(OneOf<String, RenderFragment, MessageConfig> content, Double? duration, Action onClose) | void | 显示加载消息 |
| LoadingAsync(OneOf<String, RenderFragment, MessageConfig> content, Double? duration, Action onClose) | Task | Show loading message asynchronously |
| Open(MessageConfig config) | void | 使用提供的配置打开消息 |
| OpenAsync(MessageConfig config) | Task | Open message with provided configuration asynchronously |
| Success(OneOf<String, RenderFragment, MessageConfig> content, Double? duration, Action onClose) | void | 显示成功信息 |
| SuccessAsync(OneOf<String, RenderFragment, MessageConfig> content, Double? duration, Action onClose) | Task | Show success message asynchronously |
| Warning(OneOf<String, RenderFragment, MessageConfig> content, Double? duration, Action onClose) | void | 显示警告信息 |
| WarningAsync(OneOf<String, RenderFragment, MessageConfig> content, Double? duration, Action onClose) | Task | Show warning message asynchronously |
MessageConfig API#
| 属性 | 描述 | 类型 | 默认值 |
|---|---|---|---|
| Content | 留言内容 | OneOf<String, RenderFragment> | -- |
| Duration | 自动关闭前的时间，以秒为单位 | Double? | -- |
| Icon | 消息图标 | RenderFragment | -- |
| Key | 组件的唯一标识符 | String | -- |
| Type | 留言风格 | MessageType | -- |
| WaitForAnimation | Whether to wait for animation completion when awaited externally | Boolean | -- |
| OnClose | 在消息关闭时执行的回调 | -- |