hy-app 0.2.13 → 0.2.15

package/components/hy-radio/hy-radio.vue

@@ -16,11 +16,7 @@
           :class="iconClasses(item)"
           :style="iconWrapStyle(item)"
         >
-          <slot
-            name="icon"
-            :iconColor="iconColor"
-            :iconSize="addUnit(sizeType[size] ?? iconSize)"
-          >
+          <slot name="icon" :iconColor="iconColor" :iconSize="addUnit(sizeType[size] ?? iconSize)">
             <HyIcon
               class="hy-radio__icon-wrap__icon"
               :name="IconConfig.CHECK_MASK"
@@ -35,16 +31,14 @@
         >
           <slot name="label" :record="item">
             <text
-              :class="[
-                'hy-radio__text',
-                disabled && 'hy-radio__label-wrap--disabled',
-              ]"
+              :class="['hy-radio__text', disabled && 'hy-radio__label-wrap--disabled']"
               :style="{
                 color: labelColor,
                 fontSize: addUnit(sizeType[size] ?? labelSize),
               }"
-              >{{ item[fieldNames.label] }}</text
             >
+              {{ item[fieldNames.label] }}
+            </text>
           </slot>
         </view>
       </view>
@@ -53,35 +47,124 @@
 </template>
 
 <script lang="ts">
+/**
+ * 复选框组件一般用于需要多个选择的场景，该组件功能完整，使用方便
+ * @displayName hy-radio
+ */
+defineOptions({})
 export default {
-  name: "hy-radio",
+  name: 'hy-radio',
   options: {
     addGlobalClass: true,
     virtualHost: true,
-    styleIsolation: "shared",
+    styleIsolation: 'shared',
   },
-};
+}
 </script>
 
 <script setup lang="ts">
-import type IProps from "./typing";
-import type { CheckboxColumnsVo } from "../hy-check-button/typing";
-import defaultProps from "./props";
-import {
-  computed,
-  type CSSProperties,
-  reactive,
-  ref,
-  toRefs,
-  watch,
-} from "vue";
-import { addUnit, bem, error } from "../../utils";
-import { IconConfig } from "../../config";
+import { computed, reactive, ref, toRefs, watch } from 'vue'
+import type { CSSProperties, PropType } from 'vue'
+import type { IRadioEmits } from './typing'
+import type { CheckboxColumnsVo, IFieldNames } from '../hy-check-button/typing'
+import { addUnit, bem, error } from '../../utils'
+import { IconConfig } from '../../config'
 
 // 组件
-import HyIcon from "../hy-icon/hy-icon.vue";
+import HyIcon from '../hy-icon/hy-icon.vue'
 
-const props = withDefaults(defineProps<IProps>(), defaultProps);
+// const props = withDefaults(defineProps<IProps>(), defaultProps);
+const props = defineProps({
+  /** 双向绑定值，数组类型 */
+  modelValue: {
+    type: [String, Number],
+    required: true,
+  },
+  /** 选择列表数据 */
+  columns: {
+    type: Array as unknown as PropType<Array<CheckboxColumnsVo>>,
+    default: [],
+    required: true,
+  },
+  /** 自定义接收columns的键 */
+  fieldNames: {
+    type: Object as unknown as PropType<IFieldNames>,
+    default: {
+      label: 'label',
+      value: 'value',
+      checked: 'checked',
+    },
+  },
+  /**
+   * 标签的大小
+   * @values small,medium,large
+   * */
+  size: {
+    type: String,
+    default: 'medium',
+  },
+  /**
+   * 标签的形状
+   * @values circle,square
+   * */
+  shape: {
+    type: String,
+    default: 'square',
+  },
+  /** 是否禁用 */
+  disabled: {
+    type: Boolean,
+    default: false,
+  },
+  /** 选中状态下的颜色 */
+  activeColor: String,
+  /** 未选中的颜色 */
+  inactiveColor: {
+    type: String,
+    default: '#c8c9cc',
+  },
+  /** 图标的大小，单位px */
+  iconSize: {
+    type: [String, Number],
+    default: '20',
+  },
+  /** 图标颜色 */
+  iconColor: String,
+  /**
+   * 勾选图标的对齐方式
+   * @values left,right
+   * */
+  iconPlacement: {
+    type: String,
+    default: 'left',
+  },
+  /** 竖向配列时，是否显示下划线 */
+  borderBottom: {
+    type: Boolean,
+    default: false,
+  },
+  /** label的字体大小，px单位 */
+  labelSize: [String, Number],
+  /** label的颜色 */
+  labelColor: String,
+  /** 是否禁止点击提示语选中复选框 */
+  labelDisabled: {
+    type: Boolean,
+    default: false,
+  },
+  /**
+   * 排列方式
+   * @values row,column
+   * */
+  placement: {
+    type: String,
+    default: 'row',
+  },
+  /** 定义需要用到的外部样式 */
+  customStyle: {
+    type: Object as PropType<CSSProperties>,
+  },
+})
 const {
   modelValue,
   columns,
@@ -96,30 +179,28 @@ const {
   placement,
   iconColor,
   labelDisabled,
-} = toRefs(props);
-const emit = defineEmits(["change", "update:modelValue"]);
+} = toRefs(props)
+const emit = defineEmits<IRadioEmits>()
 
-const columns_1 = ref();
+const columns_1 = ref()
 const sizeType: AnyObject = reactive({
   small: 14,
   medium: 18,
   large: 22,
-});
+})
 
 watch(
   () => modelValue.value,
   (newValue) => {
     columns_1.value = columns.value.map((item: any) => {
-      item[fieldNames.value.checked] =
-        newValue === item[fieldNames.value.value];
-      return item;
-    });
+      item[fieldNames.value.checked] = newValue === item[fieldNames.value.value]
+      return item
+    })
   },
   { immediate: true },
-);
+)
 
-const isDisabled = (disabledVal?: boolean): boolean =>
-  disabled.value || !!disabledVal;
+const isDisabled = (disabledVal?: boolean): boolean => disabled.value || !!disabledVal
 
 /**
  * @description icon颜色
@@ -128,55 +209,55 @@ const iconColorCom = computed(() => {
   return (check: boolean) => {
     if (disabled.value) {
       if (check) {
-        return "#c8c9cc";
+        return '#c8c9cc'
       } else {
-        return "#F5F5F5";
+        return '#F5F5F5'
       }
     } else {
-      return iconColor.value || "#ffffff";
+      return iconColor.value || '#ffffff'
     }
-  };
-});
+  }
+})
 /**
  * @description 单选框样式
  * */
 const radioStyle = computed(() => {
-  const style: CSSProperties = {};
-  if (borderBottom.value && placement.value === "row") {
+  const style: CSSProperties = {}
+  if (borderBottom.value && placement.value === 'row') {
     error(
-      "检测到您将borderBottom设置为true，需要同时将u-checkbox-group的placement设置为column才有效",
-    );
+      '检测到您将borderBottom设置为true，需要同时将u-checkbox-group的placement设置为column才有效',
+    )
   }
   // 当父组件设置了显示下边框并且排列形式为纵向时，给内容和边框之间加上一定间隔
-  if (borderBottom.value && placement.value === "column") {
-    style.paddingBottom = "8px";
+  if (borderBottom.value && placement.value === 'column') {
+    style.paddingBottom = '8px'
   }
-  return Object.assign(style, customStyle.value);
-});
+  return Object.assign(style, customStyle.value)
+})
 const bemClass = computed(() => {
-  return bem("radio-group", props, ["placement"]);
-});
+  return bem('radio-group', props, ['placement'])
+})
 
 /**
  * @description 定义icon的Class类名
  * */
 const iconClasses = computed(() => {
   return (temp: CheckboxColumnsVo): string[] => {
-    let classes: string[] = [];
+    let classes: string[] = []
     // 组件的形状
-    classes.push("hy-radio__icon-wrap--" + shape.value);
+    classes.push('hy-radio__icon-wrap--' + shape.value)
     if (isDisabled(temp?.disabled)) {
-      classes.push("hy-radio__icon-wrap--disabled");
+      classes.push('hy-radio__icon-wrap--disabled')
     }
     if (temp[fieldNames.value.checked]) {
-      classes.push("hy-radio__icon-wrap--checked");
+      classes.push('hy-radio__icon-wrap--checked')
       if (isDisabled(temp?.disabled)) {
-        classes.push("hy-radio__icon-wrap--disabled--checked");
+        classes.push('hy-radio__icon-wrap--disabled--checked')
       }
     }
-    return classes;
-  };
-});
+    return classes
+  }
+})
 
 /**
  * @description 定义icon的样式
@@ -184,50 +265,50 @@ const iconClasses = computed(() => {
 const iconWrapStyle = computed(() => {
   return (temp: CheckboxColumnsVo): CSSProperties => {
     // checkbox的整体样式
-    const style: CSSProperties = {};
+    const style: CSSProperties = {}
     style.backgroundColor =
       temp[fieldNames.value.checked] && !isDisabled(temp?.disabled)
         ? activeColor.value
         : !isDisabled(temp?.disabled)
-          ? "#ffffff"
-          : "";
+          ? '#ffffff'
+          : ''
     style.borderColor =
       temp[fieldNames.value.checked] && !isDisabled(temp?.disabled)
         ? activeColor.value
-        : inactiveColor.value;
-    style.width = addUnit(sizeType[size.value] ?? size.value);
-    style.height = addUnit(sizeType[size.value] ?? size.value);
-    return style;
-  };
-});
+        : inactiveColor.value
+    style.width = addUnit(sizeType[size.value] ?? size.value)
+    style.height = addUnit(sizeType[size.value] ?? size.value)
+    return style
+  }
+})
 
 /**
  * @description 点击图标
  * */
 const iconClickHandler = (e: Event, temp: CheckboxColumnsVo) => {
-  e.stopPropagation();
+  e.stopPropagation()
   if (!isDisabled(temp?.disabled)) {
-    setRadioCheckedStatus(temp);
+    setRadioCheckedStatus(temp)
   }
-};
+}
 /**
  * @description 点击整体
  * */
 const wrapperClickHandler = (e: Event, temp: CheckboxColumnsVo) => {
-  e.stopPropagation();
+  e.stopPropagation()
   if (!isDisabled(temp?.disabled) || !labelDisabled.value) {
-    setRadioCheckedStatus(temp);
+    setRadioCheckedStatus(temp)
   }
-};
+}
 /**
  * @description 点击label
  * */
 const labelClickHandler = (e: Event, temp: CheckboxColumnsVo) => {
-  e.stopPropagation();
+  e.stopPropagation()
   if (!isDisabled(temp?.disabled) || !labelDisabled.value) {
-    setRadioCheckedStatus(temp);
+    setRadioCheckedStatus(temp)
   }
-};
+}
 
 /**
  * @description 执行函数改变状态传给父值
@@ -236,21 +317,21 @@ const setRadioCheckedStatus = (temp: CheckboxColumnsVo) => {
   // 将本组件标记为与原来相反的状态
   columns_1.value = columns_1.value.map((item) => {
     if (temp[fieldNames.value.value] === item[fieldNames.value.value]) {
-      item[fieldNames.value.checked] = true;
+      item[fieldNames.value.checked] = true
     } else {
-      item[fieldNames.value.checked] = false;
+      item[fieldNames.value.checked] = false
     }
-    return item;
-  });
-  emit("change", temp);
-  emit("update:modelValue", temp[fieldNames.value.value]);
+    return item
+  })
+  emit('change', temp)
+  emit('update:modelValue', temp[fieldNames.value.value])
   // 双向绑定
   // if (this.usedAlone) {
   // 	this.$emit('update:checked', this.isChecked)
   // }
-};
+}
 </script>
 
 <style lang="scss" scoped>
-@import "./index.scss";
+@import './index.scss';
 </style>

package/components/hy-radio/typing.d.ts

@@ -1,85 +1,92 @@
-import type { CSSProperties } from "vue";
-import { CheckboxColumnsVo, IFieldNames } from "../hy-check-button/typing";
+import type { CSSProperties } from 'vue'
+import { CheckboxColumnsVo, IFieldNames } from '../hy-check-button/typing'
 
 export default interface HyRadioProps {
   /**
    * @description 双向绑定值，数组类型
    * */
-  modelValue: string | number;
+  modelValue: string | number
   /**
    * @description 接受数组值
    * */
-  columns: CheckboxColumnsVo[];
+  columns: CheckboxColumnsVo[]
   /**
    * @description 自定义接收columns的键
    * */
-  fieldNames?: IFieldNames;
+  fieldNames?: IFieldNames
   /**
    * @description checkbox组件的标示符
    * */
-  name?: string;
+  name?: string
   /**
    * @description 形状，square为方形，circle为圆型
    * */
-  shape?: HyApp.ShapeType;
+  shape?: HyApp.ShapeType
   /**
    * @description 整体的大小
    * */
-  size?: HyApp.SizeType | string | number;
+  size?: HyApp.SizeType | string | number
   /**
    * @description 是否默认选中
    * */
-  checkbox?: boolean;
+  checkbox?: boolean
   /**
    * @description 是否禁用
    * */
-  disabled?: boolean;
+  disabled?: boolean
   /**
    * @description 选中状态下的颜色，如设置此值，将会覆盖parent的activeColor值
    * */
-  activeColor?: string;
+  activeColor?: string
   /**
    * @description 未选中的颜色
    * */
-  inactiveColor?: string;
+  inactiveColor?: string
   /**
    * @description 图标的大小，单位px
    * */
-  iconSize?: string;
+  iconSize?: string
   /**
    * @description 图标颜色
    * */
-  iconColor?: string;
+  iconColor?: string
   /**
    * @description label提示文字，因为nvue下，直接slot进来的文字，由于特殊的结构，无法修改样式
    * */
-  label?: string;
+  label?: string
   /**
    * @description label的字体大小，px单位
    * */
-  labelSize?: string | number;
+  labelSize?: string | number
   /**
    * @description label的颜色
    * */
-  labelColor?: string;
+  labelColor?: string
   /**
    * @description 勾选图标的对齐方式，left-左边，right-右边
    * */
-  iconPlacement?: HyApp.LeftRightType;
+  iconPlacement?: HyApp.LeftRightType
   /**
    * @description 竖向配列时，是否显示下划线
    * */
-  borderBottom?: boolean;
+  borderBottom?: boolean
   /**
    * @description 是否禁止点击提示语选中复选框
    * */
-  labelDisabled?: boolean;
+  labelDisabled?: boolean
   /**
    * @description 定义需要用到的外部样式
    * */
-  customStyle?: CSSProperties;
+  customStyle?: CSSProperties
   /**
    * @description 布局方式，row-横向，column-纵向
    * */
-  placement?: HyApp.DirectionType;
+  placement?: HyApp.DirectionType
+}
+
+export interface IRadioEmits {
+  /** 选择触发 */
+  (e: 'change', temp: CheckboxColumnsVo): void
+  /** 更新值触发 */
+  (e: 'update:modelValue', temp: any): void
 }