/**
* 该文件为脚本自动生成文件,请勿随意修改。如需修改请联系 PMC
* */
import { LoadingProps } from '../loading/index';
export interface TdButtonProps {
/**
* 卡片id。 `open-type` 的值设置为 `liveActivity` ,设置 `activity-type` 参数为 [notify_type](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/subscribe-message-2.html)。当用户点击 `button` 后,可以通过 `bindcreateliveactivity` 事件回调获取到 `code`
*/
activityType?: {
type: NumberConstructor;
value?: number;
};
/**
* 打开 APP 时,向 APP 传递的参数,open-type=launchApp时有效
* @default ''
*/
appParameter?: {
type: StringConstructor;
value?: string;
};
/**
* 是否为块级元素
* @default false
*/
block?: {
type: BooleanConstructor;
value?: boolean;
};
/**
* 按钮内容
*/
content?: {
type: StringConstructor;
value?: string;
};
/**
* 自定义 dataset,可通过 event.currentTarget.dataset.custom 获取
*/
customDataset?: {
type: null;
value?: null;
};
/**
* 禁用状态。优先级:Button.disabled > Form.disabled
*/
disabled?: {
type: BooleanConstructor;
value?: boolean;
};
/**
* 从消息小程序入口打开小程序的路径,默认为聊天工具启动路径
* @default ''
*/
entrancePath?: {
type: StringConstructor;
value?: string;
};
/**
* 是否为幽灵按钮(镂空按钮)
* @default false
*/
ghost?: {
type: BooleanConstructor;
value?: boolean;
};
/**
* 指定按钮按下去的样式类,按钮不为加载或禁用状态时有效。当 `hover-class="none"` 时,没有点击态效果
* @default ''
*/
hoverClass?: {
type: StringConstructor;
value?: string;
};
/**
* 按住后多久出现点击态,单位毫秒
* @default 20
*/
hoverStartTime?: {
type: NumberConstructor;
value?: number;
};
/**
* 手指松开后点击态保留时间,单位毫秒
* @default 70
*/
hoverStayTime?: {
type: NumberConstructor;
value?: number;
};
/**
* 指定是否阻止本节点的祖先节点出现点击态
* @default false
*/
hoverStopPropagation?: {
type: BooleanConstructor;
value?: boolean;
};
/**
* 图标名称。值为字符串表示图标名称,值为 `Object` 类型,表示透传至 `icon`
*/
icon?: {
type: null;
value?: string | object;
};
/**
* 指定返回用户信息的语言,zh_CN 简体中文,zh_TW 繁体中文,en 英文。
具体释义:
`en` 英文;
`zh_CN` 简体中文;
`zh_TW` 繁体中文。
[小程序官方文档](https://developers.weixin.qq.com/miniprogram/dev/component/button.html)
*/
lang?: {
type: StringConstructor;
value?: 'en' | 'zh_CN' | 'zh_TW';
};
/**
* 是否显示为加载状态
* @default false
*/
loading?: {
type: BooleanConstructor;
value?: boolean;
};
/**
* 透传 Loading 组件全部属性
*/
loadingProps?: {
type: ObjectConstructor;
value?: LoadingProps;
};
/**
* 转发的文本消息是否要带小程序入口
* @default true
*/
needShowEntrance?: {
type: BooleanConstructor;
value?: boolean;
};
/**
* 微信开放能力。
具体释义:
`contact` 打开客服会话,如果用户在会话中点击消息卡片后返回小程序,可以从 bindcontact 回调中获得具体信息,具体说明 (*鸿蒙 OS 暂不支持*);
`liveActivity` 通过前端获取新的一次性订阅消息下发机制使用的 code;
`share` 触发用户转发,使用前建议先阅读使用指引;
`getPhoneNumber` 手机号快速验证,向用户申请,并在用户同意后,快速填写和验证手机,具体说明 (*小程序插件中不能使用*);
`getRealtimePhoneNumber` 手机号实时验证,向用户申请,并在用户同意后,快速填写和实时验证手机号。具体说明 (*小程序插件中不能使用*);
`getUserInfo` 获取用户信息,可以从 bindgetuserinfo 回调中获取到用户信息 (*小程序插件中不能使用*);
`launchApp` 打开APP,可以通过 app-parameter 属性设定向 APP 传的参数具体说明;
`openSetting` 打开授权设置页;
`feedback` 打开“意见反馈”页面,用户可提交反馈内容并上传日志,开发者可以登录小程序管理后台后进入左侧菜单“客服反馈”页面获取到反馈内容;
`chooseAvatar` 获取用户头像,可以从 bindchooseavatar 回调中获取到头像信息;
`agreePrivacyAuthorization`用户同意隐私协议按钮。用户点击一次此按钮后,所有隐私接口可以正常调用。可通过`bindagreeprivacyauthorization`监听用户同意隐私协议事件。隐私合规开发指南详情可见《小程序隐私协议开发指南》。
`phoneOneClickLogin` 发起本机号码一键登录流程,具体说明
[小程序官方文档](https://developers.weixin.qq.com/miniprogram/dev/component/button.html)
*/
openType?: {
type: StringConstructor;
value?: 'contact' | 'liveActivity' | 'share' | 'getPhoneNumber' | 'getRealtimePhoneNumber' | 'getUserInfo' | 'launchApp' | 'openSetting' | 'feedback' | 'chooseAvatar' | 'agreePrivacyAuthorization' | 'phoneOneClickLogin';
};
/**
* 原生按钮属性,当手机号快速验证或手机号实时验证额度用尽时,是否对用户展示“申请获取你的手机号,但该功能使用次数已达当前小程序上限,暂时无法使用”的提示,默认展示,open-type="getPhoneNumber" 或 open-type="getRealtimePhoneNumber" 时有效
* @default true
*/
phoneNumberNoQuotaToast?: {
type: BooleanConstructor;
value?: boolean;
};
/**
* 会话内消息卡片图片,open-type="contact"时有效
* @default 截图
*/
sendMessageImg?: {
type: StringConstructor;
value?: string;
};
/**
* 会话内消息卡片点击跳转小程序路径,open-type="contact"时有效
* @default 当前分享路径
*/
sendMessagePath?: {
type: StringConstructor;
value?: string;
};
/**
* 会话内消息卡片标题,open-type="contact"时有效
* @default 当前标题
*/
sendMessageTitle?: {
type: StringConstructor;
value?: string;
};
/**
* 会话来源,open-type="contact"时有效,长度不超过 1024 个字符
* @default ''
*/
sessionFrom?: {
type: StringConstructor;
value?: string;
};
/**
* 按钮形状,有 4 种:长方形、正方形、圆角长方形、圆形
* @default rectangle
*/
shape?: {
type: StringConstructor;
value?: 'rectangle' | 'square' | 'round' | 'circle';
};
/**
* 是否显示会话内消息卡片,设置此参数为 true,用户进入客服会话会在右下角显示"可能要发送的小程序"提示,用户点击后可以快速发送小程序消息,open-type="contact"时有效
* @default false
*/
showMessageCard?: {
type: BooleanConstructor;
value?: boolean;
};
/**
* 组件尺寸
* @default medium
*/
size?: {
type: StringConstructor;
value?: 'extra-small' | 'small' | 'medium' | 'large';
};
/**
* 按钮标签id
* @default ''
*/
tId?: {
type: StringConstructor;
value?: string;
};
/**
* 组件风格,依次为品牌色、危险色
* @default default
*/
theme?: {
type: StringConstructor;
value?: 'default' | 'primary' | 'danger' | 'light';
};
/**
* 同小程序的 formType
*/
type?: {
type: StringConstructor;
value?: 'submit' | 'reset';
};
/**
* 按钮形式,基础、线框、虚线、文字
* @default base
*/
variant?: {
type: StringConstructor;
value?: 'base' | 'outline' | 'dashed' | 'text';
};
}