uview-pro 0.2.1 → 0.2.3

package/components/u-checkbox/u-checkbox.vue

@@ -1,267 +1,286 @@
-<template>
-    <view class="u-checkbox" :style="[checkboxStyle]">
-        <view class="u-checkbox__icon-wrap" @tap="toggle" :class="[iconClass]" :style="[iconStyle]">
-            <u-icon class="u-checkbox__icon-wrap__icon" name="checkbox-mark" :size="checkboxIconSize" :color="iconColor" />
-        </view>
-        <view
-            class="u-checkbox__label"
-            @tap="onClickLabel"
-            :style="{
-                fontSize: $u.addUnit(labelSize)
-            }"
-        >
-            <slot />
-        </view>
-    </view>
-</template>
-
-<script setup lang="ts">
-import { computed, inject, getCurrentInstance, onMounted } from 'vue';
-import { $u } from '../..';
-import { CheckboxProps } from './types';
-
-defineOptions({
-    name: 'u-checkbox'
-});
-
-/**
- * checkbox 复选框
- * @description 该组件需要搭配checkboxGroup组件使用，以便用户进行操作时，获得当前复选框组的选中情况。
- * @tutorial https://uviewpro.cn/zh/components/checkbox.html
- * @property {String Number} icon-size 图标大小，单位rpx（默认20）
- * @property {String Number} label-size label字体大小，单位rpx（默认28）
- * @property {String Number} name checkbox组件的标示符
- * @property {String} shape 形状，见官网说明（默认circle）
- * @property {Boolean} disabled 是否禁用
- * @property {Boolean} label-disabled 是否禁止点击文本操作checkbox
- * @property {String} active-color 选中时的颜色，如设置CheckboxGroup的active-color将失效
- * @event {Function} change 某个checkbox状态发生变化时触发，回调为一个对象
- * @example <u-checkbox v-model="checked" :disabled="false">天涯</u-checkbox>
- */
-
-const props = defineProps(CheckboxProps);
-
-const emit = defineEmits(['change', 'update:modelValue']);
-
-const instance = getCurrentInstance();
-const instanceProxy = instance?.proxy;
-// 父组件 group 注入
-let parent = inject<any>('u-checkbox-group', null);
-
-// 组件注册到 group
-onMounted(() => {
-    // 兼容头条小程序不支持provide/inject
-    // #ifdef MP-TOUTIAO
-    parent = $u.parentData('u-checkbox-group', instance);
-    // #endif
-    // 如果存在u-checkbox-group，将本组件的实例塞进父组件的children中
-    if (parent && parent.children && !parent.children.value.includes(instanceProxy)) {
-        parent.children.value.push(instanceProxy);
-    }
-});
-
-// 是否禁用，如果父组件u-checkbox-group禁用的话，将会忽略子组件的配置
-const isDisabled = computed(() => {
-    return props.disabled !== '' ? props.disabled : parent ? parent.props.disabled : false;
-});
-// 是否禁用label点击
-const isLabelDisabled = computed(() => {
-    return props.labelDisabled !== '' ? props.labelDisabled : parent ? parent.props.labelDisabled : false;
-});
-// 组件尺寸，对应size的值，默认值为34rpx
-const checkboxSize = computed(() => {
-    return props.size ? props.size : parent ? parent.props.size : 34;
-});
-// 组件的勾选图标的尺寸，默认20
-const checkboxIconSize = computed(() => {
-    return props.iconSize ? props.iconSize : parent ? parent.props.iconSize : 20;
-});
-// 组件选中激活时的颜色
-const elActiveColor = computed(() => {
-    return props.activeColor ? props.activeColor : parent ? parent.props.activeColor : 'primary';
-});
-// 组件的形状
-const elShape = computed(() => {
-    return props.shape ? props.shape : parent ? parent.props.shape : 'square';
-});
-// 图标样式
-const iconStyle = computed(() => {
-    let style: Record<string, string> = {};
-    // 既要判断是否手动禁用，还要判断用户v-model绑定的值，如果绑定为false，那么也无法选中
-    if (elActiveColor.value && props.modelValue && !isDisabled.value) {
-        style.borderColor = elActiveColor.value;
-        style.backgroundColor = elActiveColor.value;
-    }
-    style.width = $u.addUnit(checkboxSize.value);
-    style.height = $u.addUnit(checkboxSize.value);
-    return style;
-});
-// checkbox内部的勾选图标，如果选中状态，为白色，否则为透明色即可
-const iconColor = computed(() => {
-    return props.modelValue ? '#ffffff' : 'transparent';
-});
-const iconClass = computed(() => {
-    let classes: string[] = [];
-    classes.push('u-checkbox__icon-wrap--' + elShape.value);
-    if (props.modelValue == true) classes.push('u-checkbox__icon-wrap--checked');
-    if (isDisabled.value) classes.push('u-checkbox__icon-wrap--disabled');
-    if (props.modelValue && isDisabled.value) classes.push('u-checkbox__icon-wrap--disabled--checked');
-    // 支付宝小程序无法动态绑定一个数组类名，否则解析出来的结果会带有","，而导致失效
-    return classes.join(' ');
-});
-const checkboxStyle = computed(() => {
-    let style: Record<string, string> = {};
-    if (parent && parent.props.width) {
-        style.width = parent.props.width;
-        // #ifdef MP
-        // 各家小程序因为它们特殊的编译结构，使用float布局
-        style.float = 'left';
-        // #endif
-        // #ifndef MP
-        // H5和APP使用flex布局
-        style.flex = `0 0 ${parent.props.width}`;
-        // #endif
-    }
-    if (parent && parent.props.wrap) {
-        style.width = '100%';
-        // #ifndef MP
-        // H5和APP使用flex布局，将宽度设置100%，即可自动换行
-        style.flex = '0 0 100%';
-        // #endif
-    }
-    return style;
-});
-
-/**
- * 点击label
- */
-function onClickLabel() {
-    if (!isLabelDisabled.value && !isDisabled.value) {
-        setValue();
-    }
-}
-/**
- * 点击icon
- */
-function toggle() {
-    if (!isDisabled.value) {
-        setValue();
-    }
-}
-/**
- * 触发change事件
- */
-function emitEvent() {
-    emit('change', {
-        value: !props.modelValue,
-        name: props.name
-    });
-    // 执行父组件u-checkbox-group的事件方法
-    // 等待下一个周期再执行，因为emit('input')作用于父组件，再反馈到子组件内部，需要时间
-    setTimeout(() => {
-        if (parent && parent.children && parent.children.value && parent.children.value.includes(instanceProxy) && parent.emitEvent) parent.emitEvent();
-    }, 80);
-}
-/**
- * 设置input的值，这里通过input事件，设置通过v-model绑定的组件的值
- */
-function setValue() {
-    // 判断是否超过了可选的最大数量
-    let checkedNum = 0;
-    if (parent && parent.children && parent.children.value) {
-        // 只要父组件的某一个子元素的value为true，就加1(已有的选中数量)
-        parent.children.value.forEach((val: any) => {
-            if (val.value) checkedNum++;
-        });
-    }
-    // 如果原来为选中状态，那么可以取消
-    if (props.modelValue == true) {
-        emitEvent();
-        emit('update:modelValue', !props.modelValue);
-    } else {
-        // 如果超出最多可选项，提示
-        if (parent && checkedNum >= parent.props.max) {
-            return $u.toast(`最多可选${parent.props.max}项`);
-        }
-        // 如果原来为未选中状态，需要选中的数量少于父组件中设置的max值，才可以选中
-        emitEvent();
-        emit('update:modelValue', !props.modelValue);
-    }
-}
-
-defineExpose({ setValue, emitEvent });
-</script>
-
-<style lang="scss" scoped>
-@import '../../libs/css/style.components.scss';
-
-.u-checkbox {
-    /* #ifndef APP-NVUE */
-    display: inline-flex;
-    /* #endif */
-    align-items: center;
-    overflow: hidden;
-    user-select: none;
-    line-height: 1.8;
-
-    &__icon-wrap {
-        color: $u-content-color;
-        flex: none;
-        display: -webkit-flex;
-        @include vue-flex;
-        align-items: center;
-        justify-content: center;
-        box-sizing: border-box;
-        width: 42rpx;
-        height: 42rpx;
-        color: transparent;
-        text-align: center;
-        transition-property: color, border-color, background-color;
-        font-size: 20px;
-        border: 1px solid #c8c9cc;
-        transition-duration: 0.2s;
-
-        /* #ifdef MP-TOUTIAO */
-        // 头条小程序兼容性问题，需要设置行高为0，否则图标偏下
-        &__icon {
-            line-height: 0;
-        }
-        /* #endif */
-
-        &--circle {
-            border-radius: 100%;
-        }
-
-        &--square {
-            border-radius: 6rpx;
-        }
-
-        &--checked {
-            color: #fff;
-            background-color: $u-type-primary;
-            border-color: $u-type-primary;
-        }
-
-        &--disabled {
-            background-color: #ebedf0;
-            border-color: #c8c9cc;
-        }
-
-        &--disabled--checked {
-            color: #c8c9cc !important;
-        }
-    }
-
-    &__label {
-        word-wrap: break-word;
-        margin-left: 10rpx;
-        margin-right: 24rpx;
-        color: $u-content-color;
-        font-size: 30rpx;
-
-        &--disabled {
-            color: #c8c9cc;
-        }
-    }
-}
-</style>
+<template>
+    <view class="u-checkbox" :style="[checkboxStyle]">
+        <view class="u-checkbox__icon-wrap" @tap="toggle" :class="iconClass" :style="$u.toStyle(iconStyle)">
+            <u-icon
+                class="u-checkbox__icon-wrap__icon"
+                name="checkbox-mark"
+                :size="checkboxIconSize"
+                :color="iconColor"
+            />
+        </view>
+        <view
+            class="u-checkbox__label"
+            @tap="onClickLabel"
+            :style="{
+                fontSize: $u.addUnit(labelSize)
+            }"
+        >
+            <slot />
+        </view>
+    </view>
+</template>
+
+<script lang="ts">
+export default {
+    name: 'u-checkbox',
+    options: {
+        addGlobalClass: true,
+        // #ifndef MP-TOUTIAO
+        virtualHost: true,
+        // #endif
+        styleIsolation: 'shared'
+    }
+};
+</script>
+
+<script setup lang="ts">
+import { computed, onUnmounted } from 'vue';
+import { $u, useChildren, onParentEvent } from '../..';
+import { CheckboxProps } from './types';
+
+/**
+ * checkbox 复选框
+ * @description 该组件需要搭配checkboxGroup组件使用，以便用户进行操作时，获得当前复选框组的选中情况。
+ * @tutorial https://uviewpro.cn/zh/components/checkbox.html
+ * @property {String Number} icon-size 图标大小，单位rpx（默认20）
+ * @property {String Number} label-size label字体大小，单位rpx（默认28）
+ * @property {String Number} name checkbox组件的标示符
+ * @property {String} shape 形状，见官网说明（默认circle）
+ * @property {Boolean} disabled 是否禁用
+ * @property {Boolean} label-disabled 是否禁止点击文本操作checkbox
+ * @property {String} active-color 选中时的颜色，如设置CheckboxGroup的active-color将失效
+ * @event {Function} change 某个checkbox状态发生变化时触发，回调为一个对象
+ * @example <u-checkbox v-model="checked" :disabled="false">天涯</u-checkbox>
+ */
+
+const props = defineProps(CheckboxProps);
+const emit = defineEmits(['change', 'update:modelValue']);
+
+// 使用子组件Hook
+const { childId, parentExposed } = useChildren('u-checkbox', 'u-checkbox-group');
+
+// 是否禁用，如果父组件u-checkbox-group禁用的话，将会忽略子组件的配置
+const isDisabled = computed(() => {
+    return props.disabled !== '' ? props.disabled : (parentExposed.value?.props?.disabled ?? false);
+});
+
+// 是否禁用label点击
+const isLabelDisabled = computed(() => {
+    return props.labelDisabled !== '' ? props.labelDisabled : (parentExposed.value?.props?.labelDisabled ?? false);
+});
+
+// 组件尺寸，对应size的值，默认值为34rpx
+const checkboxSize = computed(() => {
+    return props.size ? props.size : (parentExposed.value?.props?.size ?? 34);
+});
+
+// 组件的勾选图标的尺寸，默认20
+const checkboxIconSize = computed(() => {
+    return props.iconSize ? props.iconSize : (parentExposed.value?.props?.iconSize ?? 20);
+});
+
+// 组件选中激活时的颜色
+const elActiveColor = computed(() => {
+    return props.activeColor ? props.activeColor : (parentExposed.value?.props?.activeColor ?? 'primary');
+});
+
+// 组件的形状
+const elShape = computed(() => {
+    return props.shape ? props.shape : (parentExposed.value?.props?.shape ?? 'square');
+});
+
+// 图标样式
+const iconStyle = computed(() => {
+    let style: Record<string, string> = {};
+    if (elActiveColor.value && props.modelValue && !isDisabled.value) {
+        style.borderColor = elActiveColor.value;
+        style.backgroundColor = elActiveColor.value;
+    }
+    style.width = $u.addUnit(checkboxSize.value);
+    style.height = $u.addUnit(checkboxSize.value);
+    return style;
+});
+
+// checkbox内部的勾选图标，如果选中状态，为白色，否则为透明色即可
+const iconColor = computed(() => {
+    return props.modelValue ? '#ffffff' : 'transparent';
+});
+
+const iconClass = computed(() => {
+    let classes: string[] = [];
+    classes.push('u-checkbox__icon-wrap--' + elShape.value);
+    if (props.modelValue == true) classes.push('u-checkbox__icon-wrap--checked');
+    if (isDisabled.value) classes.push('u-checkbox__icon-wrap--disabled');
+    if (props.modelValue && isDisabled.value) classes.push('u-checkbox__icon-wrap--disabled--checked');
+    return classes.join(' ');
+});
+
+const checkboxStyle = computed(() => {
+    let style: Record<string, string> = {};
+    if (parentExposed.value?.props?.width) {
+        style.width = parentExposed.value.props.width;
+        // #ifdef MP
+        style.float = 'left';
+        // #endif
+        // #ifndef MP
+        style.flex = `0 0 ${parentExposed.value.props.width}`;
+        // #endif
+    }
+    if (parentExposed.value?.props?.wrap) {
+        style.width = '100%';
+        // #ifndef MP
+        style.flex = '0 0 100%';
+        // #endif
+    }
+    return style;
+});
+
+/**
+ * 点击label
+ */
+function onClickLabel() {
+    if (!isLabelDisabled.value && !isDisabled.value) {
+        setValue();
+    }
+}
+
+/**
+ * 点击icon
+ */
+function toggle() {
+    if (!isDisabled.value) {
+        setValue();
+    }
+}
+
+/**
+ * 触发change事件
+ */
+function emitEvent() {
+    const changeValue = {
+        value: !props.modelValue,
+        name: props.name
+    };
+    emit('change', changeValue);
+
+    // 通知父组件状态变化
+    setTimeout(() => {
+        if (parentExposed.value?.emitEvent) {
+            parentExposed.value.emitEvent();
+        }
+    }, 80);
+}
+
+/**
+ * 设置通过v-model绑定的组件的值
+ */
+function setValue() {
+    // 判断是否超过了可选的最大数量
+    if (props.modelValue == true) {
+        emitEvent();
+        emit('update:modelValue', false);
+    } else {
+        if (!parentExposed.value?.validateSelection()) {
+            return;
+        }
+        emitEvent();
+        emit('update:modelValue', true);
+    }
+}
+
+// 监听父组件事件
+const unsubscribeSetChecked = onParentEvent(childId, 'setChecked', data => {
+    if (!isDisabled.value) {
+        emit('update:modelValue', data.checked);
+        if (data.checked !== props.modelValue) {
+            emitEvent();
+        }
+    }
+});
+
+// 在适当的时候取消监听
+onUnmounted(() => {
+    unsubscribeSetChecked();
+});
+
+defineExpose({
+    isChecked: computed(() => props.modelValue),
+    name: props.name,
+    setValue,
+    emitEvent,
+    props
+});
+</script>
+
+<style lang="scss" scoped>
+@import '../../libs/css/style.components.scss';
+
+.u-checkbox {
+    /* #ifndef APP-NVUE */
+    display: inline-flex;
+    /* #endif */
+    align-items: center;
+    overflow: hidden;
+    user-select: none;
+    line-height: 1.8;
+
+    &__icon-wrap {
+        color: $u-content-color;
+        flex: none;
+        display: -webkit-flex;
+        @include vue-flex;
+        align-items: center;
+        justify-content: center;
+        box-sizing: border-box;
+        width: 42rpx;
+        height: 42rpx;
+        color: transparent;
+        text-align: center;
+        transition-property: color, border-color, background-color;
+        font-size: 20px;
+        border: 1px solid #c8c9cc;
+        transition-duration: 0.2s;
+
+        /* #ifdef MP-TOUTIAO */
+        &__icon {
+            line-height: 0;
+        }
+        /* #endif */
+
+        &--circle {
+            border-radius: 100%;
+        }
+
+        &--square {
+            border-radius: 6rpx;
+        }
+
+        &--checked {
+            color: #fff;
+            background-color: $u-type-primary;
+            border-color: $u-type-primary;
+        }
+
+        &--disabled {
+            background-color: #ebedf0;
+            border-color: #c8c9cc;
+        }
+
+        &--disabled--checked {
+            color: #c8c9cc !important;
+        }
+    }
+
+    &__label {
+        word-wrap: break-word;
+        margin-left: 10rpx;
+        margin-right: 24rpx;
+        color: $u-content-color;
+        font-size: 30rpx;
+
+        &--disabled {
+            color: #c8c9cc;
+        }
+    }
+}
+</style>

package/components/u-checkbox-group/types.ts

@@ -1,32 +1,32 @@
-import { type ExtractPropTypes, type PropType } from 'vue';
-import type { Shape } from '../../types/global';
-
-/**
- * checkbox-group 复选框组类型定义
- * @description 供 u-checkbox-group 组件 props 使用
- */
-
-export const CheckboxGroupProps = {
-    /** 最多能选中多少个checkbox */
-    max: { type: [Number, String], default: 999 },
-    /** 是否禁用所有复选框 */
-    disabled: { type: Boolean, default: false },
-    /** 在表单内提交时的标识符 */
-    name: { type: [Boolean, String], default: '' },
-    /** 是否禁止点击提示语选中复选框 */
-    labelDisabled: { type: Boolean, default: false },
-    /** 形状，square为方形，circle为原型 */
-    shape: { type: String as PropType<Shape>, default: 'square' },
-    /** 选中状态下的颜色 */
-    activeColor: { type: String, default: '#2979ff' },
-    /** 组件的整体大小 */
-    size: { type: [String, Number], default: 34 },
-    /** 每个checkbox占u-checkbox-group的宽度 */
-    width: { type: String, default: 'auto' },
-    /** 是否每个checkbox都换行 */
-    wrap: { type: Boolean, default: false },
-    /** 图标的大小，单位rpx */
-    iconSize: { type: [String, Number], default: 20 }
-};
-
-export type CheckboxGroupProps = ExtractPropTypes<typeof CheckboxGroupProps>;
+import { type ExtractPropTypes, type PropType } from 'vue';
+import type { Shape } from '../../types/global';
+
+/**
+ * checkbox-group 复选框组类型定义
+ * @description 供 u-checkbox-group 组件 props 使用
+ */
+
+export const CheckboxGroupProps = {
+    /** 最多能选中多少个checkbox */
+    max: { type: Number, default: 999 },
+    /** 是否禁用所有复选框 */
+    disabled: { type: Boolean, default: false },
+    /** 在表单内提交时的标识符 */
+    name: { type: [Boolean, String], default: '' },
+    /** 是否禁止点击提示语选中复选框 */
+    labelDisabled: { type: Boolean, default: false },
+    /** 形状，square为方形，circle为原型 */
+    shape: { type: String as PropType<Shape>, default: 'square' },
+    /** 选中状态下的颜色 */
+    activeColor: { type: String, default: '#2979ff' },
+    /** 组件的整体大小 */
+    size: { type: [String, Number], default: 34 },
+    /** 每个checkbox占u-checkbox-group的宽度 */
+    width: { type: String, default: 'auto' },
+    /** 是否每个checkbox都换行 */
+    wrap: { type: Boolean, default: false },
+    /** 图标的大小，单位rpx */
+    iconSize: { type: [String, Number], default: 20 }
+};
+
+export type CheckboxGroupProps = ExtractPropTypes<typeof CheckboxGroupProps>;