Button

Button 按钮

代码示例

import { BfButton } from '@bud-fe/react-taro-ui';
import { View } from '@tarojs/components';
import React from 'react';
export default () => {
return (
<>
<View className="group-title">基础用法</View>
<BfButton>default</BfButton>
<BfButton type="primary">primary</BfButton>
<BfButton loading>default loading</BfButton>
<View className="group-title">size="mini"</View>
<BfButton size="mini">default mini</BfButton>
<BfButton type="primary" size="mini">
primary mini
</BfButton>
<BfButton loading type="primary" size="mini">
primary mini loading
</BfButton>
<BfButton size="mini" plain>
default mini
</BfButton>
<BfButton type="primary" size="mini" plain>
primary mini plain
</BfButton>
<BfButton loading type="primary" size="mini" plain>
primary mini plain loading
</BfButton>
<View className="group-title">size="mini" disabled</View>
<BfButton size="mini" disabled>
default mini disabled
</BfButton>
<BfButton type="primary" size="mini" disabled>
primary mini disabled
</BfButton>
<BfButton size="mini" plain disabled>
default mini plain disabled
</BfButton>
<BfButton type="primary" size="mini" plain disabled>
primary mini plain disabled
</BfButton>
</>
);
};

API

NameDescriptionTypeDefault
type按钮类型"default" | "primary"default
children按钮包含的内容ReactNode--
debounceTime点击事件的防抖时间(单位 ms)。默认不防抖number--
size按钮的大小 @supported weapp, alipay, swan, tt, qq, jd, h5, rnkeyof Sizedefault
plain按钮是否镂空,背景色透明 @supported weapp, alipay, swan, qq, jd, h5, rnbooleanfalse
disabled是否禁用 @supported weapp, alipay, swan, tt, qq, jd, h5, rnbooleanfalse
loading名称前是否带 loading 图标 @supported weapp, alipay, swan, tt, qq, jd, h5, rnbooleanfalse
formType用于 `<form/>` 组件,点击分别会触发 `<form/>` 组件的 submit/reset 事件 @supported weapp, alipay, swan, tt, qq, jdkeyof FormType--
openType微信开放能力 @supported weapp, alipay, swan, tt, qq, jdOpenType--
hoverClass指定按下去的样式类。当 `hover-class="none"` 时,没有点击态效果 @supported weapp, alipay, swan, tt, qq, jd, h5, rn @rn 支持 hoverStyle 属性,但框架未支持 hoverClassstringbutton-hover
hoverStyle由于 RN 不支持 hoverClass,故 RN 端的 Button 组件实现了 `hoverStyle`属性,写法和 style 类似,只不过 `hoverStyle` 的样式是指定按下去的样式。 @supported rnStyleProp<ViewStyle>none
hoverStopPropagation指定是否阻止本节点的祖先节点出现点击态 @supported weapp, alipay, swan, tt, qq, jdbooleanfalse
hoverStartTime按住后多久出现点击态,单位毫秒 @supported weapp, alipay, swan, tt, qq, jd, h5, rnnumber20
hoverStayTime手指松开后点击态保留时间,单位毫秒 @supported weapp, alipay, swan, tt, qq, jd, h5, rnnumber70
lang指定返回用户信息的语言,zh_CN 简体中文,zh_TW 繁体中文,en 英文。 生效时机: `open-type="getUserInfo"` @supported weapp, qq, jdkeyof Lang--
sessionFrom会话来源 生效时机:`open-type="contact"` @supported weappstring--
sendMessageTitle会话内消息卡片标题 生效时机:`open-type="contact"` @supported weappstring当前标题
sendMessagePath会话内消息卡片点击跳转小程序路径 生效时机:`open-type="contact"` @supported weappstring当前标题
sendMessageImg会话内消息卡片图片 生效时机:`open-type="contact"` @supported weappstring截图
appParameter打开 APP 时,向 APP 传递的参数 生效时机:`open-type="launchApp"` @supported weapp, qq, jdstring--
scope支付宝小程序 scope 生效时机:`open-type="getAuthorize"` @supported alipay"userInfo" | "phoneNumber"--
showMessageCard显示会话内消息卡片 生效时机:`open-type="contact"`booleanfalse
publicId生活号 id,必须是当前小程序同主体且已关联的生活号,open-type="lifestyle" 时有效。 @supported alipay, qqstring--
templateId发送订阅类模板消息所用的模板库标题 ID ,可通过 getTemplateLibraryList 获取 当参数类型为 Array 时,可传递 1~3 个模板库标题 ID @supported swanstring | string[]--
subscribeId发送订阅类模板消息时所使用的唯一标识符,内容由开发者自定义,用来标识订阅场景 注意:同一用户在同一 subscribe-id 下的多次授权不累积下发权限,只能下发一条。若要订阅多条,需要不同 subscribe-id @supported swanstring--
groupId打开群资料卡时,传递的群号 @supported qqstring--
guildId打开频道页面时,传递的频道号 @supported qqstring--
shareType分享类型集合,请参考下面share-type有效值说明。share-type后续将不再维护,请更新为share-mode @supported qqstring27
shareMode分享类型集合,请参考下面share-mode有效值说明 @supported qqstring['qq', 'qzone']
ariaLabel无障碍访问,(属性)元素的额外描述 @supported qqstring--
openId添加好友时,对方的 openid @supported qqstring--
shareMessageFriendInfo发送对象的 FriendInfo @supported qqstring--
shareMessageTitle转发标题,不传则默认使用当前小程序的昵称。 FriendInfo @supported qqstring--
shareMessageImg转发显示图片的链接,可以是网络图片路径(仅 QQ CDN 域名路径)或本地图片文件路径或相对代码包根目录的图片文件路径。显示图片长宽比是 5:4FriendInfo @supported qqstring--
onGetUserInfo用户点击该按钮时,会返回获取到的用户信息,回调的detail数据与 Taro.getUserInfo 返回的一致 生效时机: `open-type="getUserInfo"` @supported weapp, alipay, swan, qq, jdCommonEventFunction<onGetUserInfoEventDetail>--
onGetAuthorize支付宝获取会员基础信息授权回调 生效时机:`open-type="getAuthorize"` @supported alipayCommonEventFunction<any>--
onContact客服消息回调 生效时机:`open-type="contact"` @supported weapp, swan, qqCommonEventFunction<onContactEventDetail>--
onGetPhoneNumber获取用户手机号回调 生效时机:`open-type="getphonenumber"` @supported weapp, alipay, swan, tt, jdCommonEventFunction<onGetPhoneNumberEventDetail>--
onError当使用开放能力时,发生错误的回调 生效时机:`open-type="launchApp"` @supported weapp, alipay, qq, jdCommonEventFunction<any>--
onOpenSetting在打开授权设置页后回调 生效时机:`open-type="openSetting"` @supported weapp, swan, qq, jdCommonEventFunction<onOpenSettingEventDetail>--
onLaunchApp打开 APP 成功的回调 生效时机:`open-type="launchApp"` @supported weapp, qqCommonEventFunction<any>--
onChooseAvatar获取用户头像回调 生效时机:`open-type="chooseAvatar"` @supported weappCommonEventFunction<any>--
onTap点击。 说明: 每点击一次会触发一次事件,建议自行使用代码防止重复点击,可以使用 js 防抖和节流实现。 @supported alipayCommonEventFunction<any>--
onFollowLifestyle当 open-type 为 lifestyle 时有效。 当点击按钮时触发。 event.detail = { followStatus },followStatus 合法值有 1、2、3,其中 1 表示已关注。2 表示用户不允许关注。3 表示发生未知错误; 已知问题:基础库 1.0,当用户在点击按钮前已关注生活号,event.detail.followStatus 的值为 true。 @supported alipayCommonEventFunction<{ followStatus: true | 1 | 2 | 3; }>--
onChooseAddress用户点击该按钮时,调起用户编辑收货地址原生界面,并在编辑完成后返回用户选择的地址,从返回参数的 detail 中获取,和 swan.chooseAddress 一样的。和 open-type 搭配使用,使用时机:open-type="chooseAddress" @supported swanCommonEventFunction<any>--
onChooseInvoiceTitle用户点击该按钮时,选择用户的发票抬头,和 swan.chooseInvoiceTitle 一样的。和 open-type 搭配使用,使用时机:open-type="chooseInvoiceTitle" @supported swanCommonEventFunction<any>--
onLogin登录回调,和 open-type 搭配使用,使用时机:open-type="login"。可以通过返回参数的 detail 判断是否登录成功,当 errMsg 为'login:ok'时即为成功。如想获取登录凭证请使用 swan.getLoginCode @supported swanCommonEventFunction<any>--
onSubscribe订阅消息授权回调,和 open-type 搭配使用,使用时机:open-type="subscribe" @supported swanCommonEventFunction<any>--
onAddFriend添加好友的回调 @supported qqCommonEventFunction<any>--
onAddGroupApp添加群应用的回调。errCode 错误码:41004(当前用户非管理员或群主,无权操作),41005(超过可添加群应用的群数量) @supported qqCommonEventFunction<any>--
id组件的唯一标示, 保持整个页面唯一string--
className同 `class`,在 React/Nerv 里一般使用 `className` 作为 `class` 的代称string--
style组件的内联样式, 可以动态设置的内联样式string | CSSProperties--
key如果列表中项目的位置会动态改变或者有新的项目添加到列表中, 需要使用 `wx:key` 来指定列表中项目的唯一的标识符。string | number--
hidden组件是否显示, 所有组件默认显示boolean--
animation动画属性any--
ref引用LegacyRef<any>--
dangerouslySetInnerHTML渲染 HTML @see /docs/html{ __html: string; }--
onTouchStart手指触摸动作开始(event: ITouchEvent) => void--
onTouchMove手指触摸后移动(event: ITouchEvent) => void--
onTouchCancel手指触摸动作被打断,如来电提醒,弹窗(event: ITouchEvent) => void--
onTouchEnd手指触摸动作结束(event: ITouchEvent) => void--
onClick手指触摸后马上离开(event: ITouchEvent) => void--
onLongPress手指触摸后,超过350ms再离开,如果指定了事件回调函数并触发了这个事件,tap事件将不被触发(event: CommonEvent<any>) => void--
onLongClick手指触摸后,超过350ms再离开(推荐使用 longpress 事件代替)(event: CommonEvent<any>) => void--
onTransitionEnd会在 WXSS transition 或 Taro.createAnimation 动画结束后触发(event: CommonEvent<any>) => void--
onAnimationStart会在一个 WXSS animation 动画开始时触发(event: CommonEvent<any>) => void--
onAnimationIteration会在一个 WXSS animation 一次迭代结束时触发(event: CommonEvent<any>) => void--
onAnimationEnd会在一个 WXSS animation 动画完成时触发(event: CommonEvent<any>) => void--
onTouchForceChange在支持 3D Touch 的 iPhone 设备,重按时会触发(event: CommonEvent<any>) => void--
dumi10:24