| | |
|---|
| | | |
|---|
| | | ## 代码演示 |
|---|
| | | |
|---|
| | | <a href="https://developers.weixin.qq.com/s/F1cSo7mm75SS" title="在开发者工具中预览效果" target="_blank" rel="noopener noreferrer"> 在开发者工具中预览效果 </a> |
|---|
| | | |
|---|
| | | <blockquote style="background-color: #d9e1ff; font-size: 15px; line-height: 26px;margin: 16px 0 0;padding: 16px; border-radius: 6px; color: #0052d9" > |
|---|
| | | <p>Tips: 请确保开发者工具为打开状态。导入开发者工具后，依次执行：npm i > 构建npm包 > 勾选 "将JS编译成ES5"</p> |
|---|
| | | </blockquote> |
|---|
| | | |
|---|
| | | |
|---|
| | | ### 01 组件类型 |
|---|
| | | |
|---|
| | | 基础按钮 |
|---|
| | | #### 基础按钮 |
|---|
| | | |
|---|
| | | {{ base }} |
|---|
| | | |
|---|
| | | 图标按钮 |
|---|
| | | #### 图标按钮 |
|---|
| | | |
|---|
| | | {{ icon-btn }} |
|---|
| | | |
|---|
| | | 幽灵按钮 |
|---|
| | | #### 幽灵按钮 |
|---|
| | | |
|---|
| | | {{ ghost-btn }} |
|---|
| | | |
|---|
| | | 组合按钮 |
|---|
| | | #### 组合按钮 |
|---|
| | | |
|---|
| | | {{ group-btn }} |
|---|
| | | |
|---|
| | | 通栏按钮 |
|---|
| | | #### 通栏按钮 |
|---|
| | | |
|---|
| | | {{ block-btn }} |
|---|
| | | |
|---|
| | | ### 02 组件状态 |
|---|
| | | |
|---|
| | | 按钮禁用态 |
|---|
| | | #### 按钮禁用态 |
|---|
| | | |
|---|
| | | {{ disabled }} |
|---|
| | | |
|---|
| | | ### 03 组件样式 |
|---|
| | | |
|---|
| | | 按钮尺寸 |
|---|
| | | #### 按钮尺寸 |
|---|
| | | |
|---|
| | | {{ size }} |
|---|
| | | |
|---|
| | | 按钮形状 |
|---|
| | | #### 按钮形状 |
|---|
| | | |
|---|
| | | {{ shape }} |
|---|
| | | |
|---|
| | | 按钮主题 |
|---|
| | | #### 按钮主题 |
|---|
| | | |
|---|
| | | {{ theme }} |
|---|
| | | |
|---|
| | |
|---|
| | | |
|---|
| | | 名称 | 类型 | 默认值 | 说明 | 必传 |
|---|
| | | -- | -- | -- | -- | -- |
|---|
| | | t-id | String | - | 按钮标签id | N |
|---|
| | | block | Boolean | false | 是否为块级元素 | N |
|---|
| | | content | String / Slot | - | 按钮内容 | N |
|---|
| | | custom-dataset | Object | - | 自定义 dataset，可通过 event.currentTarget.dataset.custom 获取。TS 类型：`any` | N |
|---|
| | | disabled | Boolean | false | 禁用状态 | N |
|---|
| | | external-classes | Array | - | 组件类名。`['t-class', 't-class-icon', 't-class-loading']` | N |
|---|
| | | ghost | Boolean | false | 是否为幽灵按钮（镂空按钮） | N |
|---|
| | | icon | String / Object | - | 图标名称。值为字符串表示图标名称，值为 `Object` 类型，表示透传至 `icon`。 | N |
|---|
| | | loading | Boolean | false | 是否显示为加载状态 | N |
|---|
| | | loading | Boolean | false | 是否显示为加载状态，skyline模式下暂不支持该属性 | N |
|---|
| | | loading-props | Object | - | 透传至 Loading 组件。TS 类型：`LoadingProps`，[Loading API Documents](./loading?tab=api)。[详细类型定义](https://github.com/Tencent/tdesign-miniprogram/tree/develop/src/button/type.ts) | N |
|---|
| | | shape | String | rectangle | 按钮形状，有 4 种：长方形、正方形、圆角长方形、圆形。可选项：rectangle/square/round/circle | N |
|---|
| | | size | String | medium | 组件尺寸。可选项：extra-small/small/medium/large。TS 类型：`SizeEnum` | N |
|---|
| | |
|---|
| | | theme | String | default | 组件风格，依次为品牌色、危险色。可选项：default/primary/danger/light | N |
|---|
| | | type | String | - | 同小程序的 formType。可选项：submit/reset | N |
|---|
| | | variant | String | base | 按钮形式，基础、线框、文字。可选项：base/outline/dashed/text | N |
|---|
| | | open-type | String | - | 微信开放能力。<br />具体释义：<br />`contact` 打开客服会话，如果用户在会话中点击消息卡片后返回小程序，可以从 bindcontact 回调中获得具体信息，<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/customer-message/customer-message.html">具体说明</a> （*小程序插件中不能使用*）；<br />`share` 触发用户转发，使用前建议先阅读<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/share.html#使用指引">使用指引</a>；<br />`getPhoneNumber` 获取用户手机号，可以从 bindgetphonenumber 回调中获取到用户信息，<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/getPhoneNumber.html">具体说明</a> （*小程序插件中不能使用*）；<br />`getUserInfo` 获取用户信息，可以从 bindgetuserinfo 回调中获取到用户信息 （*小程序插件中不能使用*）；<br />`launchApp` 打开APP，可以通过 app-parameter 属性设定向 APP 传的参数<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchApp.html">具体说明</a>；<br />`openSetting` 打开授权设置页；<br />`feedback` 打开“意见反馈”页面，用户可提交反馈内容并上传<a href="https://developers.weixin.qq.com/miniprogram/dev/api/base/debug/wx.getLogManager.html">日志</a>，开发者可以登录<a href="https://mp.weixin.qq.com/">小程序管理后台</a>后进入左侧菜单“客服反馈”页面获取到反馈内容；<br />`chooseAvatar` 获取用户头像，可以从 bindchooseavatar 回调中获取到头像信息。<br />[小程序官方文档](https://developers.weixin.qq.com/miniprogram/dev/component/button.html)。可选项：contact/share/getPhoneNumber/getUserInfo/launchApp/openSetting/feedback/chooseAvatar | N |
|---|
| | | open-type | String | - | 微信开放能力。<br />具体释义：<br />`contact` 打开客服会话，如果用户在会话中点击消息卡片后返回小程序，可以从 bindcontact 回调中获得具体信息，<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/customer-message/customer-message.html">具体说明</a> （*小程序插件中不能使用*）；<br />`share` 触发用户转发，使用前建议先阅读<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/share.html#使用指引">使用指引</a>；<br />`getPhoneNumber` 获取用户手机号，可以从 bindgetphonenumber 回调中获取到用户信息，<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/getPhoneNumber.html">具体说明</a> （*小程序插件中不能使用*）；<br />`getUserInfo` 获取用户信息，可以从 bindgetuserinfo 回调中获取到用户信息 （*小程序插件中不能使用*）；<br />`launchApp` 打开APP，可以通过 app-parameter 属性设定向 APP 传的参数<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchApp.html">具体说明</a>；<br />`openSetting` 打开授权设置页；<br />`feedback` 打开“意见反馈”页面，用户可提交反馈内容并上传<a href="https://developers.weixin.qq.com/miniprogram/dev/api/base/debug/wx.getLogManager.html">日志</a>，开发者可以登录<a href="https://mp.weixin.qq.com/">小程序管理后台</a>后进入左侧菜单“客服反馈”页面获取到反馈内容；<br />`chooseAvatar` 获取用户头像，可以从 bindchooseavatar 回调中获取到头像信息；<br />`agreePrivacyAuthorization`用户同意隐私协议按钮。用户点击一次此按钮后，所有隐私接口可以正常调用。可通过`bindagreeprivacyauthorization`监听用户同意隐私协议事件。隐私合规开发指南详情可见《<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/user-privacy/PrivacyAuthorize.html">小程序隐私协议开发指南</a>》。<br />[小程序官方文档](https://developers.weixin.qq.com/miniprogram/dev/component/button.html)。可选项：contact/share/getPhoneNumber/getUserInfo/launchApp/openSetting/feedback/chooseAvatar/agreePrivacyAuthorization | N |
|---|
| | | hover-class | String | '' | 指定按钮按下去的样式类，按钮不为加载或禁用状态时有效。当 `hover-class="none"` 时，没有点击态效果 | N |
|---|
| | | hover-stop-propagation | Boolean | false | 指定是否阻止本节点的祖先节点出现点击态 | N |
|---|
| | | hover-start-time | Number | 20 | 按住后多久出现点击态，单位毫秒 | N |
|---|
| | |
|---|
| | | bindopensetting | Eventhandle | - | 在打开授权设置页后回调，open-type=openSetting时有效 | N |
|---|
| | | bindlaunchapp | Eventhandle | - | 打开 APP 成功的回调，open-type=launchApp时有效 | N |
|---|
| | | bindchooseavatar | Eventhandle | - | 获取用户头像回调，open-type=chooseAvatar时有效 | N |
|---|
| | | bindagreeprivacyauthorization | Eventhandle | - | 用户同意隐私协议事件回调，open-type=agreePrivacyAuthorization时有效 | N |
|---|
| | | |
|---|
| | | ### Button Events |
|---|
| | | |
|---|
| | | 名称 | 参数 | 描述 |
|---|
| | | -- | -- | -- |
|---|
| | | tap | `event` | 点击按钮，当按钮不为加载或禁用状态时触发 |
|---|
| | | |
|---|
| | | ### Button 外部样式类 |
|---|
| | | 类名 | 说明 |
|---|
| | | -- | -- |
|---|
| | | t-class | 根节点样式类 |
|---|
| | | t-class-icon | 图标样式类 |
|---|
| | | t-class-loading | 加载样式类 |
|---|
| | | |
|---|
| | | ### CSS 变量 |
|---|
| | | 组件提供了下列 CSS 变量，可用于自定义样式。 |
|---|
| | | 名称 | 默认值 | 描述 |
|---|
| | | -- | -- | -- |
|---|
| | | --td-button-border-radius | @radius-default | - |
|---|
| | | --td-button-border-width | 4rpx | - |
|---|
| | | --td-button-danger-active-bg-color | @error-color-7 | - |
|---|
| | | --td-button-danger-active-border-color | @error-color-7 | - |
|---|
| | | --td-button-danger-bg-color | @error-color | - |
|---|
| | | --td-button-danger-border-color | @error-color | - |
|---|
| | | --td-button-danger-color | @font-white-1 | - |
|---|
| | | --td-button-danger-dashed-border-color | @button-danger-dashed-color | - |
|---|
| | | --td-button-danger-dashed-color | @error-color | - |
|---|
| | | --td-button-danger-dashed-disabled-color | @button-danger-disabled-color | - |
|---|
| | | --td-button-danger-disabled-bg | @error-color-3 | - |
|---|
| | | --td-button-danger-disabled-border-color | @error-color-3 | - |
|---|
| | | --td-button-danger-disabled-color | @font-white-1 | - |
|---|
| | | --td-button-danger-outline-active-bg-color | @bg-color-container-active | - |
|---|
| | | --td-button-danger-outline-active-border-color | @error-color-7 | - |
|---|
| | | --td-button-danger-outline-border-color | @button-danger-outline-color | - |
|---|
| | | --td-button-danger-outline-color | @error-color | - |
|---|
| | | --td-button-danger-outline-disabled-color | @error-color-3 | - |
|---|
| | | --td-button-danger-text-active-bg-color | @bg-color-container-active | - |
|---|
| | | --td-button-danger-text-color | @error-color | - |
|---|
| | | --td-button-danger-text-disabled-color | @button-danger-disabled-color | - |
|---|
| | | --td-button-default-active-bg-color | @bg-color-component-active | - |
|---|
| | | --td-button-default-active-border-color | @bg-color-component-active | - |
|---|
| | | --td-button-default-bg-color | @bg-color-component | - |
|---|
| | | --td-button-default-border-color | @bg-color-component | - |
|---|
| | | --td-button-default-color | @font-gray-1 | - |
|---|
| | | --td-button-default-disabled-bg | @bg-color-component-disabled | - |
|---|
| | | --td-button-default-disabled-border-color | @bg-color-component-disabled | - |
|---|
| | | --td-button-default-disabled-color | @font-gray-4 | - |
|---|
| | | --td-button-default-outline-active-bg-color | @bg-color-container-active | - |
|---|
| | | --td-button-default-outline-active-border-color | @component-border | - |
|---|
| | | --td-button-default-outline-border-color | @component-border | - |
|---|
| | | --td-button-default-outline-color | @font-gray-1 | - |
|---|
| | | --td-button-default-outline-disabled-color | @component-border | - |
|---|
| | | --td-button-default-text-active-bg-color | @bg-color-container-active | - |
|---|
| | | --td-button-extra-small-font-size | @font-size-base | - |
|---|
| | | --td-button-extra-small-height | 56rpx | - |
|---|
| | | --td-button-extra-small-icon-font-size | 36rpx | - |
|---|
| | | --td-button-extra-small-padding-horizontal | 16rpx | - |
|---|
| | | --td-button-font-weight | 600 | - |
|---|
| | | --td-button-ghost-border-color | @button-ghost-color | - |
|---|
| | | --td-button-ghost-color | @bg-color-container | - |
|---|
| | | --td-button-ghost-danger-border-color | @error-color | - |
|---|
| | | --td-button-ghost-danger-color | @error-color | - |
|---|
| | | --td-button-ghost-disabled-color | rgba(255, 255, 255, 0.35) | - |
|---|
| | | --td-button-ghost-primary-border-color | @brand-color | - |
|---|
| | | --td-button-ghost-primary-color | @brand-color | - |
|---|
| | | --td-button-icon-border-radius | 8rpx | - |
|---|
| | | --td-button-icon-spacer | @spacer | - |
|---|
| | | --td-button-large-font-size | @font-size-m | - |
|---|
| | | --td-button-large-height | 96rpx | - |
|---|
| | | --td-button-large-icon-font-size | 48rpx | - |
|---|
| | | --td-button-large-padding-horizontal | 40rpx | - |
|---|
| | | --td-button-light-active-bg-color | @brand-color-light-active | - |
|---|
| | | --td-button-light-active-border-color | @brand-color-light-active | - |
|---|
| | | --td-button-light-bg-color | @brand-color-light | - |
|---|
| | | --td-button-light-border-color | @brand-color-light | - |
|---|
| | | --td-button-light-color | @brand-color | - |
|---|
| | | --td-button-light-disabled-bg | @brand-color-light | - |
|---|
| | | --td-button-light-disabled-border-color | @brand-color-light | - |
|---|
| | | --td-button-light-disabled-color | @brand-color-disabled | - |
|---|
| | | --td-button-light-outline-active-bg-color | @brand-color-light-active | - |
|---|
| | | --td-button-light-outline-active-border-color | @brand-color-active | - |
|---|
| | | --td-button-light-outline-bg-color | @brand-color-light | - |
|---|
| | | --td-button-light-outline-border-color | @button-light-outline-color | - |
|---|
| | | --td-button-light-outline-color | @brand-color | - |
|---|
| | | --td-button-light-outline-disabled-color | @brand-color-disabled | - |
|---|
| | | --td-button-light-text-active-bg-color | @bg-color-container-active | - |
|---|
| | | --td-button-light-text-color | @brand-color | - |
|---|
| | | --td-button-medium-font-size | @font-size-m | - |
|---|
| | | --td-button-medium-height | 80rpx | - |
|---|
| | | --td-button-medium-icon-font-size | 40rpx | - |
|---|
| | | --td-button-medium-padding-horizontal | 32rpx | - |
|---|
| | | --td-button-primary-active-bg-color | @brand-color-active | - |
|---|
| | | --td-button-primary-active-border-color | @brand-color-active | - |
|---|
| | | --td-button-primary-bg-color | @brand-color | - |
|---|
| | | --td-button-primary-border-color | @brand-color | - |
|---|
| | | --td-button-primary-color | @font-white-1 | - |
|---|
| | | --td-button-primary-dashed-border-color | @button-primary-dashed-color | - |
|---|
| | | --td-button-primary-dashed-color | @brand-color | - |
|---|
| | | --td-button-primary-dashed-disabled-color | @brand-color-disabled | - |
|---|
| | | --td-button-primary-disabled-bg | @brand-color-disabled | - |
|---|
| | | --td-button-primary-disabled-border-color | @brand-color-disabled | - |
|---|
| | | --td-button-primary-disabled-color | @font-white-1 | - |
|---|
| | | --td-button-primary-outline-active-bg-color | @bg-color-container-active | - |
|---|
| | | --td-button-primary-outline-active-border-color | @brand-color-active | - |
|---|
| | | --td-button-primary-outline-border-color | @button-primary-outline-color | - |
|---|
| | | --td-button-primary-outline-color | @brand-color | - |
|---|
| | | --td-button-primary-outline-disabled-color | @brand-color-disabled | - |
|---|
| | | --td-button-primary-text-active-bg-color | @bg-color-container-active | - |
|---|
| | | --td-button-primary-text-color | @brand-color | - |
|---|
| | | --td-button-primary-text-disabled-color | @brand-color-disabled | - |
|---|
| | | --td-button-small-font-size | @font-size-base | - |
|---|
| | | --td-button-small-height | 64rpx | - |
|---|
| | | --td-button-small-icon-font-size | 36rpx | - |
|---|
| | | --td-button-small-padding-horizontal | 24rpx | - |
|---|
