CNCEC_APP/uni_modules/uview-pro/components/u-button/u-button.vue

591 lines
18 KiB
Vue
Raw Normal View History

2026-03-25 14:54:15 +08:00
<template>
<!-- prettier-ignore -->
<button
id="u-wave-btn"
class="u-btn u-line-1 u-fix-ios-appearance"
:class="[
'u-size-' + size,
plain ? 'u-btn--' + type + '--plain' : '',
loading ? 'u-loading' : '',
shape === 'circle' ? 'u-round-circle' : '',
hairLine ? showHairLineBorder : 'u-btn--bold-border',
'u-btn--' + type,
disabled ? `u-btn--${type}--disabled` : '',
customClass
]"
:hover-start-time="Number(hoverStartTime)"
:hover-stay-time="Number(hoverStayTime)"
:disabled="disabled"
:form-type="(formType as any)"
:open-type="disabled || loading ? undefined : openType"
:app-parameter="appParameter"
:hover-stop-propagation="hoverStopPropagation"
:send-message-title="sendMessageTitle"
:send-message-path="sendMessagePath"
:lang="(lang as any)"
:data-name="dataName"
:session-from="sessionFrom"
:send-message-img="sendMessageImg"
:show-message-card="showMessageCard"
@getAuthorize="getAuthorize"
@getuserinfo="getuserinfo"
@contact="contact"
@getphonenumber="getphonenumber"
@error="error"
@launchapp="launchapp"
@opensetting="opensetting"
@chooseavatar="chooseavatar"
@agreeprivacyauthorization="agreeprivacyauthorization"
:style="
$u.toStyle(
{
overflow: ripple ? 'hidden' : 'visible'
},
customStyle
)
"
@tap.stop="click($event)"
:hover-class="getHoverClass"
:loading="loading"
>
<slot>{{ props.text }}</slot>
<view
v-if="ripple"
class="u-wave-ripple"
:class="[waveActive ? 'u-wave-active' : '']"
:style="{
top: rippleTop + 'px',
left: rippleLeft + 'px',
width: fields.targetWidth + 'px',
height: fields.targetWidth + 'px',
'background-color': rippleBgColor || 'rgba(0, 0, 0, 0.15)'
}"
></view>
</button>
</template>
<script lang="ts">
export default {
name: 'u-button',
options: {
addGlobalClass: true,
// #ifndef MP-TOUTIAO
virtualHost: true,
// #endif
styleIsolation: 'shared'
}
};
</script>
<script setup lang="ts">
import { ref, computed, nextTick } from 'vue';
import { $u } from '../../';
import { ButtonProps } from './types';
/**
* button 按钮
* @description Button 按钮
* @tutorial https://uviewpro.cn/zh/components/button.html
* @property {String} size 按钮的大小
* @property {Boolean} ripple 是否开启点击水波纹效果
* @property {String} ripple-bg-color 水波纹的背景色ripple为true时有效
* @property {String} type 按钮的样式类型
* @property {Boolean} plain 按钮是否镂空背景色透明
* @property {Boolean} disabled 是否禁用
* @property {Boolean} hair-line 是否显示按钮的细边框(默认true)
* @property {String} shape 按钮外观形状见文档说明
* @property {Boolean} loading 按钮名称前是否带 loading 图标(App-nvue 平台 ios 上为雪花Android上为圆圈)
* @property {String} form-type 用于 <form> 组件点击分别会触发 <form> 组件的 submit/reset 事件
* @property {String} open-type 开放能力
* @property {String} data-name 额外传参参数用于小程序的data-xxx属性通过target.dataset.name获取
* @property {String} hover-class 指定按钮按下去的样式类 hover-class="none" 没有点击态效果(App-nvue 平台暂不支持)
* @property {Number} hover-start-time 按住后多久出现点击态单位毫秒
* @property {Number} hover-stay-time 手指松开后点击态保留时间单位毫秒
* @property {Object} custom-style 对按钮的自定义样式对象形式见文档说明
* @property {String} app-parameter 打开 APP APP 传递的参数open-type=launchApp时有效
* @property {Boolean} hover-stop-propagation 指定是否阻止本节点的祖先节点出现点击态微信小程序有效
* @property {String} lang 指定返回用户信息的语言zh_CN 简体中文zh_TW 繁体中文en 英文只微信小程序有效
* @property {String} session-from 会话来源open-type="contact"时有效只微信小程序有效
* @property {String} send-message-title 会话内消息卡片标题open-type="contact"时有效
* @property {String} send-message-path 会话内消息卡片点击跳转小程序路径open-type="contact"时有效
* @property {String} send-message-img 会话内消息卡片图片open-type="contact"时有效
* @property {Boolean} show-message-card 是否显示会话内消息卡片open-type="contact"时有效
* @property {Number|String} throttle-time 节流一定时间内只能触发一次单位毫秒
* @property {String} scope 支付宝小程序 open-type getAuthorize 时有效可选值'phoneNumber' | 'userInfo'
* @event {Function} click 按钮点击
* @event {Function} getphonenumber open-type="getPhoneNumber"时有效
* @event {Function} getuserinfo 用户点击该按钮时会返回获取到的用户信息从返回参数的detail中获取到的值同uni.getUserInfo
* @event {Function} error 当使用开放能力时发生错误的回调
* @event {Function} opensetting 在打开授权设置页并关闭后回调
* @event {Function} launchapp 打开 APP 成功的回调
* @event {Function} contact 客服消息回调
* @event {Function} chooseavatar 头像选择回调
* @event {Function} agreeprivacyauthorization 用户点击允许授权回调
* @example <u-button>月落</u-button>
*/
const emit = defineEmits([
'click',
'getuserinfo',
'contact',
'getphonenumber',
'error',
'launchapp',
'opensetting',
'chooseavatar',
'agreeprivacyauthorization'
]);
const props = defineProps(ButtonProps);
/**
* 按钮水波纹相关状态
*/
const rippleTop = ref(0); // 水波纹的起点Y坐标到按钮上边界的距离
const rippleLeft = ref(0); // 水波纹起点X坐标到按钮左边界的距离
const fields = ref<Record<string, any>>({}); // 波纹按钮节点信息
const waveActive = ref(false); // 激活水波纹
/**
* 当没有传bgColor变量时按钮按下去的颜色类名
* @returns {string}
*/
const getHoverClass = computed(() => {
// 如果开启水波纹效果则不启用hover-class效果
if (props.loading || props.disabled || props.ripple) return '';
// 如果用户传了 hoverClass优先使用用户的
if (props.hoverClass) return props.hoverClass;
let hoverClass = '';
hoverClass = props.plain ? 'u-' + props.type + '-plain-hover' : 'u-' + props.type + '-hover';
return hoverClass;
});
/**
* 'primary', 'success', 'error', 'warning'类型下不显示边框否则会造成四角有毛刺现象
* @returns {string}
*/
const showHairLineBorder = computed(() => {
if (['primary', 'success', 'error', 'warning'].indexOf(props.type) >= 0 && !props.plain) {
return '';
} else {
return 'u-hairline-border';
}
});
/**
* 按钮点击
* @param e 事件对象
* @emits click
*/
function click(e: any) {
if (Number(props.throttleTime)) {
$u.throttle(() => {
clickAction(e);
}, Number(props.throttleTime));
} else {
clickAction(e);
}
}
function clickAction(e: any) {
// 如果按钮时disabled和loading状态不触发水波纹效果
if (props.loading === true || props.disabled === true) return;
// 是否开启水波纹效果
if (props.ripple) {
// 每次点击时,移除上一次的类,再次添加,才能触发动画效果
waveActive.value = false;
nextTick(() => {
getWaveQuery(e);
});
}
emit('click', e);
}
/**
* 查询按钮的节点信息
* @param e 事件对象
*/
function getWaveQuery(e: any) {
getElQuery().then((res: any[]) => {
// 查询返回的是一个数组节点
let data = res[0];
// 查询不到节点信息,不操作
if (!data.width || !data.width) return;
// 水波纹的最终形态是一个正方形(通过border-radius让其变为一个圆形),这里要保证正方形的边长等于按钮的最长边
// 最终的方形(变换后的圆形)才能覆盖整个按钮
data.targetWidth = data.height > data.width ? data.height : data.width;
if (!data.targetWidth) return;
fields.value = data;
let touchesX = '',
touchesY = '';
// #ifdef MP-BAIDU
// @ts-ignore
touchesX = e.changedTouches[0].clientX;
touchesY = e.changedTouches[0].clientY;
// #endif
// #ifdef MP-ALIPAY
// @ts-ignore
touchesX = e.detail.clientX;
touchesY = e.detail.clientY;
// #endif
// #ifndef MP-BAIDU || MP-ALIPAY
// @ts-ignore
touchesX = e.touches[0].clientX;
touchesY = e.touches[0].clientY;
// #endif
// 获取触摸点相对于按钮上边和左边的x和y坐标原理是通过屏幕的触摸点touchesY减去按钮的上边界data.top
// 但是由于`transform-origin`默认是center所以这里再减去半径才是水波纹view应该的位置
// 总的来说,就是把水波纹的矩形(变换后的圆形)的中心点,移动到我们的触摸点位置
rippleTop.value = Number(touchesY) - data.top - data.targetWidth / 2;
rippleLeft.value = Number(touchesX) - data.left - data.targetWidth / 2;
nextTick(() => {
waveActive.value = true;
});
});
}
/**
* 获取节点信息
* @returns {Promise<any[]>}
*/
function getElQuery(): Promise<any[]> {
return new Promise(resolve => {
let queryInfo: any = '';
// 获取元素节点信息请查看uniapp相关文档
// https://uniapp.dcloud.io/api/ui/nodes-info?id=nodesrefboundingclientrect
// @ts-ignore
queryInfo = uni.createSelectorQuery().in(null);
// #ifdef MP-ALIPAY
// @ts-ignore
queryInfo = uni.createSelectorQuery();
// #endif
queryInfo.select('.u-btn').boundingClientRect();
queryInfo.exec((data: any) => {
resolve(data);
});
});
}
// 下面为对接uniapp官方按钮开放能力事件回调的对接
/**
* open-type="getPhoneNumber"时有效
*/
function getphonenumber(event: any) {
emit('getphonenumber', event);
}
/**
* 用户点击该按钮时会返回获取到的用户信息从返回参数的detail中获取到的值同uni.getUserInfo
*/
function getuserinfo(event: any) {
emit('getuserinfo', event);
}
/**
* 当使用开放能力时发生错误的回调
*/
function error(event: any) {
emit('error', event);
}
/**
* 在打开授权设置页并关闭后回调
*/
function opensetting(event: any) {
emit('opensetting', event);
}
/**
* 打开 APP 成功的回调
*/
function launchapp(event: any) {
emit('launchapp', event);
}
/**
* 支付宝小程序授权
* @param event
*/
function getAuthorize(event: any) {
if (props.scope === 'phoneNumber') {
getphonenumber(event);
} else if (props.scope === 'userInfo') {
getuserinfo(event);
}
}
/**
* 客服消息回调
* @param event
*/
function contact(event: any) {
emit('contact', event);
}
/**
* 头像选择回调
* @param event
*/
function chooseavatar(event: any) {
emit('chooseavatar', event);
}
/**
* 用户点击允许授权回调
* @param event
*/
function agreeprivacyauthorization(event: any) {
emit('agreeprivacyauthorization', event);
}
</script>
<style scoped lang="scss">
@import '../../libs/css/style.components.scss';
.u-btn::after {
border: none;
}
.u-btn {
position: relative;
border: 0;
//border-radius: 10rpx;
/* #ifndef APP-NVUE */
display: inline-flex;
/* #endif */
// 避免边框某些场景可能被“裁剪”不能设置为hidden
overflow: visible;
line-height: 1;
@include vue-flex;
align-items: center;
justify-content: center;
cursor: pointer;
padding: 0 40rpx;
z-index: 1;
box-sizing: border-box;
transition: all 0.15s;
&--bold-border {
border: 1px solid var(--u-white-color);
}
&--default {
color: $u-content-color;
border-color: var(--u-light-color);
background-color: var(--u-bg-white);
}
&--primary {
color: var(--u-white-color);
border-color: $u-type-primary;
background-color: $u-type-primary;
}
&--success {
color: var(--u-white-color);
border-color: $u-type-success;
background-color: $u-type-success;
}
&--error {
color: var(--u-white-color);
border-color: $u-type-error;
background-color: $u-type-error;
}
&--warning {
color: var(--u-white-color);
border-color: $u-type-warning;
background-color: $u-type-warning;
}
&--default--disabled {
color: var(--u-white-color);
border-color: var(--u-border-color);
background-color: var(--u-bg-white);
}
&--primary--disabled {
color: var(--u-white-color) !important;
border-color: $u-type-primary-disabled !important;
background-color: $u-type-primary-disabled !important;
}
&--success--disabled {
color: var(--u-white-color) !important;
border-color: $u-type-success-disabled !important;
background-color: $u-type-success-disabled !important;
}
&--error--disabled {
color: var(--u-white-color) !important;
border-color: $u-type-error-disabled !important;
background-color: $u-type-error-disabled !important;
}
&--warning--disabled {
color: var(--u-white-color) !important;
border-color: $u-type-warning-disabled !important;
background-color: $u-type-warning-disabled !important;
}
&--primary--plain {
color: $u-type-primary !important;
border-color: $u-type-primary-disabled !important;
background-color: $u-type-primary-light !important;
}
&--success--plain {
color: $u-type-success !important;
border-color: $u-type-success-disabled !important;
background-color: $u-type-success-light !important;
}
&--error--plain {
color: $u-type-error !important;
border-color: $u-type-error-disabled !important;
background-color: $u-type-error-light !important;
}
&--warning--plain {
color: $u-type-warning !important;
border-color: $u-type-warning-disabled !important;
background-color: $u-type-warning-light !important;
}
}
.u-hairline-border:after {
content: ' ';
position: absolute;
pointer-events: none;
// 设置为border-box意味着下面的scale缩小为0.5实际上缩小的是伪元素的内容border-box意味着内容不含border
box-sizing: border-box;
// 中心点作为变形(scale())的原点
-webkit-transform-origin: 0 0;
transform-origin: 0 0;
left: 0;
top: 0;
width: 199.8%;
height: 199.7%;
-webkit-transform: scale(0.5, 0.5);
transform: scale(0.5, 0.5);
border: 1px solid currentColor;
z-index: 1;
}
.u-wave-ripple {
z-index: 0;
position: absolute;
border-radius: 100%;
background-clip: padding-box;
pointer-events: none;
user-select: none;
transform: scale(0);
opacity: 1;
transform-origin: center;
}
.u-wave-ripple.u-wave-active {
opacity: 0;
transform: scale(2);
transition:
opacity 1s linear,
transform 0.4s linear;
}
.u-round-circle {
border-radius: 100rpx;
}
.u-round-circle::after {
border-radius: 100rpx;
}
.u-loading::after {
background-color: hsla(0, 0%, 100%, 0.35);
}
.u-size-default {
font-size: 30rpx;
height: 80rpx;
line-height: 80rpx;
}
.u-size-medium {
/* #ifndef APP-NVUE */
display: inline-flex;
/* #endif */
width: auto;
font-size: 26rpx;
height: 70rpx;
line-height: 70rpx;
padding: 0 80rpx;
}
.u-size-mini {
/* #ifndef APP-NVUE */
display: inline-flex;
/* #endif */
width: auto;
font-size: 22rpx;
padding-top: 1px;
height: 50rpx;
line-height: 50rpx;
padding: 0 20rpx;
}
.u-primary-plain-hover {
color: var(--u-white-color) !important;
background: $u-type-primary-dark !important;
}
.u-default-plain-hover {
color: $u-type-primary-dark !important;
background: $u-type-primary-light !important;
}
.u-success-plain-hover {
color: var(--u-white-color) !important;
background: $u-type-success-dark !important;
}
.u-warning-plain-hover {
color: var(--u-white-color) !important;
background: $u-type-warning-dark !important;
}
.u-error-plain-hover {
color: var(--u-white-color) !important;
background: $u-type-error-dark !important;
}
.u-info-plain-hover {
color: var(--u-white-color) !important;
background: $u-type-info-dark !important;
}
.u-default-hover {
color: $u-type-primary-dark !important;
border-color: $u-type-primary-dark !important;
background-color: $u-type-primary-light !important;
}
.u-primary-hover {
background: $u-type-primary-dark !important;
color: var(--u-white-color);
}
.u-success-hover {
background: $u-type-success-dark !important;
color: var(--u-white-color);
}
.u-info-hover {
background: $u-type-info-dark !important;
color: var(--u-white-color);
}
.u-warning-hover {
background: $u-type-warning-dark !important;
color: var(--u-white-color);
}
.u-error-hover {
background: $u-type-error-dark !important;
color: var(--u-white-color);
}
</style>