@tplc/wot
Version:
170 lines (169 loc) • 3.76 kB
TypeScript
import type { ExtractPropTypes, PropType } from 'vue'
export type ButtonType =
| 'primary'
| 'success'
| 'info'
| 'warning'
| 'error'
| 'default'
| 'text'
| 'icon'
export type ButtonSize = 'small' | 'medium' | 'large'
export type ButtonLang = 'zh_CN' | 'zh_TW' | 'en'
export type ButtonOpenType =
| 'feedback'
| 'share'
| 'getUserInfo'
| 'contact'
| 'getPhoneNumber'
| 'getRealtimePhoneNumber'
| 'launchApp'
| 'openSetting'
| 'chooseAvatar'
| 'getAuthorize'
| 'lifestyle'
| 'contactShare'
| 'openGroupProfile'
| 'openGuildProfile'
| 'openPublicProfile'
| 'shareMessageToFriend'
| 'addFriend'
| 'addColorSign'
| 'addGroupApp'
| 'addToFavorites'
| 'chooseAddress'
| 'chooseInvoiceTitle'
| 'login'
| 'subscribe'
| 'favorite'
| 'watchLater'
| 'openProfile'
| 'agreePrivacyAuthorization'
export type ButtonScope = 'phoneNumber' | 'userInfo'
export declare const buttonProps: {
/**
* 幽灵按钮
*/
plain: {
type: BooleanConstructor
default: boolean
}
/**
* 圆角按钮
*/
round: {
type: BooleanConstructor
default: boolean
}
/**
* 禁用按钮
*/
disabled: {
type: BooleanConstructor
default: boolean
}
/**
* 是否细边框
*/
hairline: {
type: BooleanConstructor
default: boolean
}
/**
* 块状按钮
*/
block: {
type: BooleanConstructor
default: boolean
}
/**
* 按钮类型,可选值:primary / success / info / warning / error / text / icon
*/
type: {
type: PropType<ButtonType>
default: ButtonType
}
/**
* 按钮尺寸,可选值:small / medium / large
*/
size: {
type: PropType<ButtonSize>
default: ButtonSize
}
/**
* 图标类名
*/
icon: StringConstructor
/**
* 类名前缀,用于使用自定义图标,用法参考Icon组件
*/
classPrefix: {
type: PropType<string>
default: string
}
/**
* 加载中按钮
*/
loading: {
type: BooleanConstructor
default: boolean
}
/**
* 加载图标颜色
*/
loadingColor: StringConstructor
/**
* 开放能力
*/
openType: PropType<ButtonOpenType>
/**
* 指定是否阻止本节点的祖先节点出现点击态
*/
hoverStopPropagation: BooleanConstructor
/**
* 指定返回用户信息的语言,zh_CN 简体中文,zh_TW 繁体中文,en 英文
*/
lang: PropType<ButtonLang>
/**
* 会话来源,open-type="contact"时有效
*/
sessionFrom: StringConstructor
/**
* 会话内消息卡片标题,open-type="contact"时有效
*/
sendMessageTitle: StringConstructor
/**
* 会话内消息卡片点击跳转小程序路径,open-type="contact"时有效
*/
sendMessagePath: StringConstructor
/**
* 会话内消息卡片图片,open-type="contact"时有效
*/
sendMessageImg: StringConstructor
/**
* 打开 APP 时,向 APP 传递的参数,open-type=launchApp时有效
*/
appParameter: StringConstructor
/**
* 是否显示会话内消息卡片,设置此参数为 true,用户进入客服会话会在右下角显示"可能要发送的小程序"提示,用户点击后可以快速发送小程序消息,open-type="contact"时有效
*/
showMessageCard: BooleanConstructor
/**
* 按钮的唯一标识,可用于设置隐私同意授权按钮的id
*/
buttonId: StringConstructor
/**
* 支付宝小程序,当 open-type 为 getAuthorize 时有效。
* 可选值:'phoneNumber' | 'userInfo'
*/
scope: PropType<ButtonScope>
customStyle: {
type: PropType<string>
default: string
}
customClass: {
type: PropType<string>
default: string
}
}
export type ButtonProps = ExtractPropTypes<typeof buttonProps>