Skip to content

Button 按钮

该组件内部实现以uni-app button 组件为基础,进行二次封装,主要区别在于:

  • 按钮type值有更多的主题颜色
  • 按钮size值有更多的尺寸可选
  • 按钮icon值有更多的图标可选

平台兼容性

App(vue)App(nvue)H5小程序VUE2VUE3

注意

  1. 此组件内部使用uni-app button 组件为基础,除了开头中所说的增加的功能,另外暴露出来的props属性和官方组件的属性完全一致, uni-app button 组件比较特殊,因为它有一些其他小程序平台的特定能力,请参考文档后面的参数列表,更详细说明请参uni-app方文档: uni-app方button组件
  2. 由于微信小程序的限制,在微信小程序中设置了 form-typewu-button无法触发 form 组件的 submit 事件(H5和APP正常),详见微信小程序文档Bug & Tip部分

基本使用

文字内容通过 text 传入

vue
<wu-button text="千金散尽还复来"></wu-button>
<wu-button text="千金散尽还复来"></wu-button>

设置按钮的多种形态

  • type 值可选的有 default (默认)、primarysuccessinfowarningerror
  • 通过 plain 值设置是否镂空
  • 通过 hairline 值设置是否细边
  • 通过 disabled 值设置是否禁用
  • 通过 loading 值设置是否开启加载图标,loadingText设置加载中文字
  • 通过 icon 值设置是否显示图标
  • 通过 shape 值设置按钮形状,circle 为圆角
  • 通过 color 值设置按钮渐变颜色
  • 通过 size 值设置按钮的大小
vue
<template>
	<view style="padding: 20px;">
		<wu-button type="primary" text="确定"></wu-button>
		<wu-button type="primary" :plain="true" text="镂空"></wu-button>
		<wu-button type="primary" :plain="true" :hairline="true" text="细边"></wu-button>
		<wu-button type="primary" :disabled="disabled" text="禁用"></wu-button>
		<wu-button type="primary" loading loadingText="加载中"></wu-button>
		<wu-button type="primary" icon="map" text="图标按钮"></wu-button>
		<wu-button type="primary" shape="circle" text="按钮形状"></wu-button>
		<wu-button text="渐变色按钮" color="linear-gradient(to right, rgb(66, 83, 216), rgb(213, 51, 186))"></wu-button>
		<wu-button type="primary" size="small" text="大小尺寸"></wu-button>
	</view>
</template>
<script>
export default {
	data() {
		return {
			disabled: true
		};
	}
};
</script>
<template>
	<view style="padding: 20px;">
		<wu-button type="primary" text="确定"></wu-button>
		<wu-button type="primary" :plain="true" text="镂空"></wu-button>
		<wu-button type="primary" :plain="true" :hairline="true" text="细边"></wu-button>
		<wu-button type="primary" :disabled="disabled" text="禁用"></wu-button>
		<wu-button type="primary" loading loadingText="加载中"></wu-button>
		<wu-button type="primary" icon="map" text="图标按钮"></wu-button>
		<wu-button type="primary" shape="circle" text="按钮形状"></wu-button>
		<wu-button text="渐变色按钮" color="linear-gradient(to right, rgb(66, 83, 216), rgb(213, 51, 186))"></wu-button>
		<wu-button type="primary" size="small" text="大小尺寸"></wu-button>
	</view>
</template>
<script>
export default {
	data() {
		return {
			disabled: true
		};
	}
};
</script>

定义需要用到的外部样式

  1. 针对非微信小程序平台,组件的根元素就是uni-app button 组件,所以修改按钮的样式很容易,直接给组件定义类名或者嵌入内联样式即可。
  2. 如果是微信小程序,编译后页面会有组件同名的元素存在,导致样式传递有问题。
  3. 如果是为了修改按钮与其他元素之间的距离或者宽度等,可以给按钮外面套一个 view 元素,控制这个 view 与其他元素的距离或者宽度,即可达到同等效果。

所以:我们提供了一个 custom-style 参数,推荐用户可以用对象形式传递样式给组件内部,注意驼峰命名。

vue
<template>
	<view>
		<wu-button :custom-style="customStyle" color="#fff" text="雪月夜"></wu-button>
	</view>
</template>
<script>
	export default {
		data() {
			return {}
		},
		computed: {
			customStyle() {
				return {
					height: '80rpx',
					background: '#3c9cff',
					color: '#fff',
					borderRadius: '40rpx' ,//圆角
					// nvue中必须是下方的写法
					'border-top-right-radius': '40rpx',
					'border-bottom-left-radius': '40rpx',
					'border-bottom-right-radius': '40rpx'
				}
			}
		}
	}
</script>
<template>
	<view>
		<wu-button :custom-style="customStyle" color="#fff" text="雪月夜"></wu-button>
	</view>
</template>
<script>
	export default {
		data() {
			return {}
		},
		computed: {
			customStyle() {
				return {
					height: '80rpx',
					background: '#3c9cff',
					color: '#fff',
					borderRadius: '40rpx' ,//圆角
					// nvue中必须是下方的写法
					'border-top-right-radius': '40rpx',
					'border-bottom-left-radius': '40rpx',
					'border-bottom-right-radius': '40rpx'
				}
			}
		}
	}
</script>

各家小程序开放能力的对接

wu-ui 已对接 uni-app 档关于uni-app方button组件的所有开放能力(截止2023-08-03) uni-app 文档说明使用即可,如果有发现遗漏的地方,请加群反馈。

API

Button Props

属性名说明类型默认值可选值
hairline是否显示按钮的细边框Booleantruetrue/false
type按钮的样式类型Stringinfoinfo/primary/error/warning/success
size按钮的大小Stringnormalnormal/large/mini
shape按钮外观形状,见上方说明Stringsquaresquare/circle
plain按钮是否镂空,背景色透明Booleanfalsetrue/false
disabled是否禁用Booleanfalsetrue/false
loading按钮名称前是否带 loading 图标Booleanfalsetrue/false
loadingText加载中提示文字String--
loadingMode加载状态图标类型Stringspinner-
loadingSize加载图标大小String/Number15-
openType开放能力,具体请看uniapp稳定关于button组件部分说明uni-app方button组件String--
formType用于 <form> 组件,点击分别会触发 <form> 组件的 submit/reset 事件String--
appParameter打开 APP 时,向 APP 传递的参数,open-type=launchApp时有效 (注:只微信小程序、QQ小程序有效)String--
hoverStopPropagation指定是否阻止本节点的祖先节点出现点击态,微信小程序有效(默认 true)Booleantruetrue/false
lang指定返回用户信息的语言,zh_CN 简体中文,zh_TW 繁体中文,en 英文Stringen-
sessionFrom会话来源,openType="contact"时有效String--
sendMessageTitle会话内消息卡片标题,openType="contact"时有效String--
sendMessagePath会话内消息卡片点击跳转小程序路径,openType="contact"时有效String--
sendMessageImg会话内消息卡片图片,openType="contact"时有效String--
showMessageCard是否显示会话内消息卡片,设置此参数为 true,用户进入客服会话会在右下角显示"可能要发送的小程序"提示,用户点击后可以快速发送小程序消息,openType="contact"时有效String--
dataName额外传参参数,用于小程序的data-xxx属性,通过target.dataset.name获取String--
throttleTime节流,一定时间内只能触发一次,单位毫秒(ms)String/Number0-
hoverStartTime按住后多久出现点击态,单位毫秒String/Number0-
hoverStayTime手指松开后点击态保留时间,单位毫秒String/Number200-
text按钮文字,之所以通过props传入,是因为slot传入的话(注:nvue中无法控制文字的样式)String/Number--
icon按钮图标String--
iconColor按钮颜色String在plain=true镂空状态下,颜色与边框保持一致,否则为白色(主题为info时为黑色#000000)-
color按钮颜色,支持传入linear-gradient渐变色String--
customTextStyle自定义按钮文字的样式,避免设置customStyle设置覆盖不了样式的情况Object/String--
customStyle定义需要用到的外部样式,详细见上方文档Object/String--

Button Events

说明:目前经测试(Hbuilder X 2.6.8),在H5,APP,可以直接对组件监听 tap 事件,等同组件内部发出的 click 事件效果,某些HX版本上, 微信小程序对组件使用 tap 事件可能无效,故建议对按钮组件的点击事件监听统一使用组件内部发出的 click 事件。

属性名说明类型默认值平台差异说明
click按钮点击,请勿使用@tap点击事件,微信小程序无效,返回值为点击事件及参数Handler--
getphonenumber获取用户手机号回调, open-type="getPhoneNumber"生效Handler-微信、支付宝、百度、抖音、快手、京东小程序
getuserinfo用户点击该按钮时,会返回获取到的用户信息,从返回参数的detail中获取到的值同uni.getUserInfo,open-type="getUserInfo"生效Handler-微信、QQ、百度、快手、京东小程序
error当使用开放能力时,发生错误的回调, open-type="launchApp"生效Handler-微信、QQ、快手、京东小程序
opensetting从小程序打开 App 成功的回调,open-type="launchApp"生效Handler-微信、QQ、百度、快手、京东小程序
launchapp打开 APP 成功的回调,open-type="launchApp"生效Handler-微信、QQ、快手、京东小程序
contact客服消息回调,open-type="contact"生效Handler-微信、QQ、百度、快手小程序
chooseavatar获取用户头像回调,open-type="chooseAvatar"生效Handler-微信小程序
addgroupapp添加群应用的回调,open-type="addGroupApp"生效Handler-QQ小程序
chooseaddress调起用户编辑并选择收货地址的回调,open-type="chooseAddress"生效Handler-百度小程序
chooseinvoicetitle用户选择发票抬头的回调,open-type="chooseInvoiceTitle"生效Handler-百度小程序
subscribe订阅消息授权回调,open-type="subscribe"生效Handler-百度小程序
login登录回调,open-type="login"生效Handler-百度小程序
im监听跳转IM的成功回调,open-type="im"生效Handler-抖音小程序2.68.0版本+

关于 open-type 详情,请参考 uniapp 官方提供的 button open-type有效值