Alert 3.0.0
警告提示组件,居中展现需要关注的信息,基于Confirm组件实现。
- 类似浏览器原生API调用方式。
- 自定义组件显隐过程动画。
- 返回一个Promise实例对象,可通过then方法绑定确定按钮回调。
使用说明
引用方式
import { Alert } from '$yo-component';
// 如果你的项目中未使用最新的 ykit-config-yo 插件,可能无法使用上面这个语法糖
// 你仍然可以通过下面这种方式来引用
import Alert from 'yo3/component/alert';
基本用法
最简单的用法,传入需要显示的内容参数。适用于简单的警告提示。
Alert('the alert text');
含有标题
通过第二个参数传入组件显示的标题,默认不显示标题。
Alert('the alert text', 'Alert');
自定义按钮文本
Alert 可以接受一个配置对象 option 为参数,你可以在里面指定 title 和 content 的值。 option 的 btnText 属性指定了 Alert 按钮的文本,例如:
// opt对象调用模式
Alert({
title:'title',
content:'content',
btnText:'ok!'
})
绑定回调函数
通过返回的 Promise
实例对象的 then
方法绑定确定按钮的回调函数,点击确定的回调函数参数值是 true
。
Alert('return Promise Object').then(
res => console.log(`resolve ${res}`)
);
设置动画
通过 opt 对象的 animation
参数和 CSS3 动画可以设置组件显隐过程的动态效果,配置动画对象中的 animation
属性是一个数组,分别对应组件显、隐过程执行的动画效果,duration
属性设置动画执行时间。
也可以传入组件内部支持的动画名字符串 fade
、fade-in-up
、fade-in-down
、zoom
。
const animation = {animation: ['actionsheet-up', 'actionsheet-down'], duration: 200};
Alert({
title:'Alert',
content:'the alert text',
animation
}).then(res => console.log('resolve'))
.actionsheet-up {
-webkit-animation-name: actionsheet-up;
animation-name: actionsheet-up;
}
.actionsheet-down {
-webkit-animation-name: actionsheet-down;
animation-name: actionsheet-down;
}
@keyframes actionsheet-up {
from {
transform: translate3d(0, 100%, 0);
}
to {
transform: translate3d(0, 0, 0);
}
}
@keyframes actionsheet-down {
from {
transform: translate3d(0, 0, 0);
}
to {
transform: translate3d(0, 100%, 0);
}
}
方法
Alert #
Alert API,调用以后在屏幕正中弹出一个Alert,可以按照option对象参数调用,也可以使用简易
调用方式如 Alert(content, title, btnText, animation, extraClass)
方法参数:
参数名 | 类型 | 描述 | 必选 | 支持版本 |
---|---|---|---|---|
option | Object | 配置对象,里面可以接受如下属性: | ||
option.content | String | Function | 组件显示的内容,支持字符串和 jsx(返回 jsx 的回调函数,`() => jsx`) | ||
option.title | String | 组件显示的标题 | ||
option.btnText | String | 组件按钮的文本 | 3.0.1 | |
option.animation | String | Object | 组件显隐执行的动画,格式同Dialog组件 | ||
option.extraClass | String | 附加给组件根节点的额外className。 | 3.0.15 |