rat-message

0.1.28 • Public • Published

rat-message

  • category: Components
  • chinese: 信息提示
  • type: 展示

开发指南

API

Message

参数 说明 类型 默认值
size 反馈大小

可选值:
'medium', 'large'
Enum 'medium'
type 反馈类型

可选值:
'success', 'warning', 'error', 'notice', 'help', 'loading'
Enum 'success'
shape 反馈外观

可选值:
'inline', 'addon', 'toast'
Enum 'inline'
title 标题 ReactNode -
children 内容 ReactNode -
defaultVisible 默认是否显示 Boolean true
visible 当前是否显示 Boolean -
iconType 显示的图标类型,会覆盖内部设置的IconType String -
closeable 显示关闭按钮 Boolean false
onClose 关闭按钮的回调

签名:
Function() => void
Function () => {}
afterClose 关闭之后调用的函数

签名:
Function() => void
Function () => {}

Message.show

Message.show(props) 提供一个单例的调用方式,配置参数如下(继承 Overlay 的配置):

参数 说明 类型 默认值
type 反馈类型 String 'success'
title 反馈标题 ReactNode -
content 反馈内容 ReactNode -
duration 显示持续时间,0表示一直存在,以毫秒为单位 Number 3000
align 对齐方式,参考Overlay String 'tc tc'
offset 对齐之后的偏移位置 Array [0, 0]
hasMask 是否带有遮罩 Boolean false
closeable 显示关闭按钮 Boolean false
afterClose 关闭事件的回调函数 Function -
overlayProps 透传到弹层的属性对象 Object -

示例:

Message.show({
    type: 'error',
    title: '错误',
    content: '请联系相关人员反馈!',
    hasMask: true
});

Message.hide

Message.hide() 提供关闭反馈弹层的快捷方法。

Message.[success|error|notice|help|loading]

Message.show({type: type, title: 'xxx'}); 的便捷调用方法。

示例:

Message.success('反馈内容');
 
// 或者
Message.success({
    title: '反馈内容',
    duration: 1000
});

Readme

Keywords

Package Sidebar

Install

npm i rat-message

Weekly Downloads

0

Version

0.1.28

License

BSD-3-Clause

Unpacked Size

115 kB

Total Files

16

Last publish

Collaborators

  • 55555azhe