vant 3.4.5 → 4.0.0-alpha.0

package/es/picker/Picker.d.ts

@@ -5,7 +5,7 @@ export declare const pickerSharedProps: {
     loading: BooleanConstructor;
     readonly: BooleanConstructor;
     allowHtml: BooleanConstructor;
-    itemHeight: {
+    optionHeight: {
         type: (NumberConstructor | StringConstructor)[];
         default: number;
     };
@@ -17,7 +17,7 @@ export declare const pickerSharedProps: {
         type: (NumberConstructor | StringConstructor)[];
         default: number;
     };
-    visibleItemCount: {
+    visibleOptionNum: {
         type: (NumberConstructor | StringConstructor)[];
         default: number;
     };
@@ -29,7 +29,7 @@ declare const pickerProps: {
     loading: BooleanConstructor;
     readonly: BooleanConstructor;
     allowHtml: BooleanConstructor;
-    itemHeight: {
+    optionHeight: {
         type: (NumberConstructor | StringConstructor)[];
         default: number;
     };
@@ -41,7 +41,7 @@ declare const pickerProps: {
         type: (NumberConstructor | StringConstructor)[];
         default: number;
     };
-    visibleItemCount: {
+    visibleOptionNum: {
         type: (NumberConstructor | StringConstructor)[];
         default: number;
     };
@@ -49,13 +49,12 @@ declare const pickerProps: {
     confirmButtonText: StringConstructor;
 } & {
     columns: {
-        type: PropType<(PickerOption | PickerColumn)[]>;
+        type: PropType<(PickerColumn | PickerOption)[]>;
         default: () => never[];
     };
-    valueKey: StringConstructor;
-    defaultIndex: {
-        type: (NumberConstructor | StringConstructor)[];
-        default: number;
+    modelValue: {
+        type: PropType<(string | number)[]>;
+        default: () => never[];
     };
     toolbarPosition: {
         type: PropType<PickerToolbarPosition>;
@@ -69,7 +68,7 @@ declare const _default: import("vue").DefineComponent<{
     loading: BooleanConstructor;
     readonly: BooleanConstructor;
     allowHtml: BooleanConstructor;
-    itemHeight: {
+    optionHeight: {
         type: (NumberConstructor | StringConstructor)[];
         default: number;
     };
@@ -81,7 +80,7 @@ declare const _default: import("vue").DefineComponent<{
         type: (NumberConstructor | StringConstructor)[];
         default: number;
     };
-    visibleItemCount: {
+    visibleOptionNum: {
         type: (NumberConstructor | StringConstructor)[];
         default: number;
     };
@@ -89,25 +88,24 @@ declare const _default: import("vue").DefineComponent<{
     confirmButtonText: StringConstructor;
 } & {
     columns: {
-        type: PropType<(PickerOption | PickerColumn)[]>;
+        type: PropType<(PickerColumn | PickerOption)[]>;
         default: () => never[];
     };
-    valueKey: StringConstructor;
-    defaultIndex: {
-        type: (NumberConstructor | StringConstructor)[];
-        default: number;
+    modelValue: {
+        type: PropType<(string | number)[]>;
+        default: () => never[];
     };
     toolbarPosition: {
         type: PropType<PickerToolbarPosition>;
         default: PickerToolbarPosition;
     };
     columnsFieldNames: PropType<PickerFieldNames>;
-}, () => JSX.Element, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, ("change" | "cancel" | "confirm")[], "change" | "cancel" | "confirm", import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<ExtractPropTypes<{
+}, () => JSX.Element, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, ("update:modelValue" | "change" | "cancel" | "confirm")[], "update:modelValue" | "change" | "cancel" | "confirm", import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<ExtractPropTypes<{
     title: StringConstructor;
     loading: BooleanConstructor;
     readonly: BooleanConstructor;
     allowHtml: BooleanConstructor;
-    itemHeight: {
+    optionHeight: {
         type: (NumberConstructor | StringConstructor)[];
         default: number;
     };
@@ -119,7 +117,7 @@ declare const _default: import("vue").DefineComponent<{
         type: (NumberConstructor | StringConstructor)[];
         default: number;
     };
-    visibleItemCount: {
+    visibleOptionNum: {
         type: (NumberConstructor | StringConstructor)[];
         default: number;
     };
@@ -127,13 +125,12 @@ declare const _default: import("vue").DefineComponent<{
     confirmButtonText: StringConstructor;
 } & {
     columns: {
-        type: PropType<(PickerOption | PickerColumn)[]>;
+        type: PropType<(PickerColumn | PickerOption)[]>;
         default: () => never[];
     };
-    valueKey: StringConstructor;
-    defaultIndex: {
-        type: (NumberConstructor | StringConstructor)[];
-        default: number;
+    modelValue: {
+        type: PropType<(string | number)[]>;
+        default: () => never[];
     };
     toolbarPosition: {
         type: PropType<PickerToolbarPosition>;
@@ -142,18 +139,19 @@ declare const _default: import("vue").DefineComponent<{
     columnsFieldNames: PropType<PickerFieldNames>;
 }>> & {
     onChange?: ((...args: any[]) => any) | undefined;
+    "onUpdate:modelValue"?: ((...args: any[]) => any) | undefined;
     onCancel?: ((...args: any[]) => any) | undefined;
     onConfirm?: ((...args: any[]) => any) | undefined;
 }, {
+    modelValue: (string | number)[];
     readonly: boolean;
     loading: boolean;
-    defaultIndex: string | number;
     allowHtml: boolean;
-    itemHeight: string | number;
+    optionHeight: string | number;
     showToolbar: boolean;
     swipeDuration: string | number;
-    visibleItemCount: string | number;
-    columns: (PickerOption | PickerColumn)[];
+    visibleOptionNum: string | number;
+    columns: (PickerColumn | PickerOption)[];
     toolbarPosition: PickerToolbarPosition;
 }>;
 export default _default;

package/es/picker/Picker.js

@@ -1,6 +1,7 @@
 import { createVNode as _createVNode } from "vue";
 import { ref, watch, computed, defineComponent } from "vue";
-import { extend, unitToPx, truthProp, makeArrayProp, preventDefault, makeStringProp, makeNumericProp, createNamespace, HAPTICS_FEEDBACK, BORDER_UNSET_TOP_BOTTOM } from "../utils";
+import { extend, unitToPx, truthProp, isSameValue, makeArrayProp, preventDefault, makeStringProp, makeNumericProp, createNamespace, HAPTICS_FEEDBACK, BORDER_UNSET_TOP_BOTTOM } from "../utils";
+import { isOptionExist, getColumnsType, findOptionByValue, formatCascadeColumns, getFirstEnabledOption, assignDefaultFields } from "./utils";
 import { useChildren } from "@vant/use";
 import { useExpose } from "../composables/use-expose";
 import { Loading } from "../loading";
@@ -11,198 +12,85 @@ const pickerSharedProps = {
   loading: Boolean,
   readonly: Boolean,
   allowHtml: Boolean,
-  itemHeight: makeNumericProp(44),
+  optionHeight: makeNumericProp(44),
   showToolbar: truthProp,
   swipeDuration: makeNumericProp(1e3),
-  visibleItemCount: makeNumericProp(6),
+  visibleOptionNum: makeNumericProp(6),
   cancelButtonText: String,
   confirmButtonText: String
 };
 const pickerProps = extend({}, pickerSharedProps, {
   columns: makeArrayProp(),
-  valueKey: String,
-  defaultIndex: makeNumericProp(0),
+  modelValue: makeArrayProp(),
   toolbarPosition: makeStringProp("top"),
   columnsFieldNames: Object
 });
 var stdin_default = defineComponent({
   name,
   props: pickerProps,
-  emits: ["confirm", "cancel", "change"],
+  emits: ["confirm", "cancel", "change", "update:modelValue"],
   setup(props, {
     emit,
     slots
   }) {
-    if (process.env.NODE_ENV !== "production") {
-      if (slots.default) {
-        console.warn('[Vant] Picker: "default" slot is deprecated, please use "toolbar" slot instead.');
-      }
-      if (props.valueKey) {
-        console.warn('[Vant] Picker: "valueKey" prop is deprecated, please use "columnsFieldNames" prop instead.');
-      }
-    }
-    const hasOptions = ref(false);
-    const formattedColumns = ref([]);
-    const {
-      text: textKey,
-      values: valuesKey,
-      children: childrenKey
-    } = extend({
-      text: props.valueKey || "text",
-      values: "values",
-      children: "children"
-    }, props.columnsFieldNames);
+    const selectedValues = ref(props.modelValue);
     const {
       children,
       linkChildren
     } = useChildren(PICKER_KEY);
     linkChildren();
-    const itemHeight = computed(() => unitToPx(props.itemHeight));
-    const dataType = computed(() => {
-      const firstColumn = props.columns[0];
-      if (typeof firstColumn === "object") {
-        if (childrenKey in firstColumn) {
-          return "cascade";
-        }
-        if (valuesKey in firstColumn) {
-          return "object";
-        }
-      }
-      return "plain";
-    });
-    const formatCascade = () => {
-      var _a;
-      const formatted = [];
-      let cursor = {
-        [childrenKey]: props.columns
-      };
-      while (cursor && cursor[childrenKey]) {
-        const children2 = cursor[childrenKey];
-        let defaultIndex = (_a = cursor.defaultIndex) != null ? _a : +props.defaultIndex;
-        while (children2[defaultIndex] && children2[defaultIndex].disabled) {
-          if (defaultIndex < children2.length - 1) {
-            defaultIndex++;
-          } else {
-            defaultIndex = 0;
-            break;
-          }
-        }
-        formatted.push({
-          [valuesKey]: cursor[childrenKey],
-          className: cursor.className,
-          defaultIndex
-        });
-        cursor = children2[defaultIndex];
-      }
-      formattedColumns.value = formatted;
-    };
-    const format = () => {
+    const fields = computed(() => assignDefaultFields(props.columnsFieldNames));
+    const optionHeight = computed(() => unitToPx(props.optionHeight));
+    const columnsType = computed(() => getColumnsType(props.columns, fields.value));
+    const currentColumns = computed(() => {
       const {
         columns
       } = props;
-      if (dataType.value === "plain") {
-        formattedColumns.value = [{
-          [valuesKey]: columns
-        }];
-      } else if (dataType.value === "cascade") {
-        formatCascade();
-      } else {
-        formattedColumns.value = columns;
-      }
-      hasOptions.value = formattedColumns.value.some((item) => item[valuesKey] && item[valuesKey].length !== 0);
-    };
-    const getIndexes = () => children.map((child) => child.state.index);
-    const setColumnValues = (index, options) => {
-      const column = children[index];
-      if (column) {
-        column.setOptions(options);
-        hasOptions.value = true;
-      }
-    };
-    const onCascadeChange = (columnIndex) => {
-      let cursor = {
-        [childrenKey]: props.columns
-      };
-      const indexes = getIndexes();
-      for (let i = 0; i <= columnIndex; i++) {
-        cursor = cursor[childrenKey][indexes[i]];
-      }
-      while (cursor && cursor[childrenKey]) {
-        columnIndex++;
-        setColumnValues(columnIndex, cursor[childrenKey]);
-        cursor = cursor[childrenKey][cursor.defaultIndex || 0];
-      }
-    };
-    const getChild = (index) => children[index];
-    const getColumnValue = (index) => {
-      const column = getChild(index);
-      if (column) {
-        return column.getValue();
-      }
-    };
-    const setColumnValue = (index, value) => {
-      const column = getChild(index);
-      if (column) {
-        column.setValue(value);
-        if (dataType.value === "cascade") {
-          onCascadeChange(index);
-        }
-      }
-    };
-    const getColumnIndex = (index) => {
-      const column = getChild(index);
-      if (column) {
-        return column.state.index;
-      }
-    };
-    const setColumnIndex = (columnIndex, optionIndex) => {
-      const column = getChild(columnIndex);
-      if (column) {
-        column.setIndex(optionIndex);
-        if (dataType.value === "cascade") {
-          onCascadeChange(columnIndex);
-        }
+      switch (columnsType.value) {
+        case "multiple":
+          return columns;
+        case "cascade":
+          return formatCascadeColumns(columns, fields.value, selectedValues);
+        default:
+          return [columns];
       }
-    };
-    const getColumnValues = (index) => {
-      const column = getChild(index);
-      if (column) {
-        return column.state.options;
+    });
+    const hasOptions = computed(() => currentColumns.value.some((options) => options.length));
+    const selectedOptions = computed(() => currentColumns.value.map((options, index) => findOptionByValue(options, selectedValues.value[index], fields.value)));
+    const setValue = (index, value) => {
+      if (selectedValues.value[index] !== value) {
+        const newValues = selectedValues.value.slice(0);
+        newValues[index] = value;
+        selectedValues.value = newValues;
+      }
+    };
+    const onChange = (value, columnIndex) => {
+      setValue(columnIndex, value);
+      if (columnsType.value === "cascade") {
+        selectedValues.value.forEach((value2, index) => {
+          const options = currentColumns.value[index];
+          if (!isOptionExist(options, value2, fields.value)) {
+            setValue(index, options.length ? options[0][fields.value.value] : void 0);
+          }
+        });
       }
-    };
-    const getValues = () => children.map((child) => child.getValue());
-    const setValues = (values) => {
-      values.forEach((value, index) => {
-        setColumnValue(index, value);
+      emit("change", {
+        columnIndex,
+        selectedValues: selectedValues.value,
+        selectedOptions: selectedOptions.value
       });
     };
-    const setIndexes = (indexes) => {
-      indexes.forEach((optionIndex, columnIndex) => {
-        setColumnIndex(columnIndex, optionIndex);
-      });
-    };
-    const emitAction = (event) => {
-      if (dataType.value === "plain") {
-        emit(event, getColumnValue(0), getColumnIndex(0));
-      } else {
-        emit(event, getValues(), getIndexes());
-      }
-    };
-    const onChange = (columnIndex) => {
-      if (dataType.value === "cascade") {
-        onCascadeChange(columnIndex);
-      }
-      if (dataType.value === "plain") {
-        emit("change", getColumnValue(0), getColumnIndex(0));
-      } else {
-        emit("change", getValues(), columnIndex);
-      }
-    };
     const confirm = () => {
       children.forEach((child) => child.stopMomentum());
-      emitAction("confirm");
+      emit("confirm", {
+        selectedValues: selectedValues.value,
+        selectedOptions: selectedOptions.value
+      });
     };
-    const cancel = () => emitAction("cancel");
+    const cancel = () => emit("cancel", {
+      selectedValues: selectedValues.value,
+      selectedOptions: selectedOptions.value
+    });
     const renderTitle = () => {
       if (slots.title) {
         return slots.title();
@@ -231,36 +119,31 @@ var stdin_default = defineComponent({
     };
     const renderToolbar = () => {
       if (props.showToolbar) {
-        const slot = slots.toolbar || slots.default;
         return _createVNode("div", {
           "class": bem("toolbar")
-        }, [slot ? slot() : [renderCancel(), renderTitle(), renderConfirm()]]);
-      }
-    };
-    const renderColumnItems = () => formattedColumns.value.map((item, columnIndex) => {
-      var _a;
-      return _createVNode(Column, {
-        "textKey": textKey,
-        "readonly": props.readonly,
-        "allowHtml": props.allowHtml,
-        "className": item.className,
-        "itemHeight": itemHeight.value,
-        "defaultIndex": (_a = item.defaultIndex) != null ? _a : +props.defaultIndex,
-        "swipeDuration": props.swipeDuration,
-        "initialOptions": item[valuesKey],
-        "visibleItemCount": props.visibleItemCount,
-        "onChange": () => onChange(columnIndex)
-      }, {
-        option: slots.option
-      });
-    });
+        }, [slots.toolbar ? slots.toolbar() : [renderCancel(), renderTitle(), renderConfirm()]]);
+      }
+    };
+    const renderColumnItems = () => currentColumns.value.map((options, columnIndex) => _createVNode(Column, {
+      "value": selectedValues.value[columnIndex],
+      "fields": fields.value,
+      "options": options,
+      "readonly": props.readonly,
+      "allowHtml": props.allowHtml,
+      "optionHeight": optionHeight.value,
+      "swipeDuration": props.swipeDuration,
+      "visibleOptionNum": props.visibleOptionNum,
+      "onChange": (value) => onChange(value, columnIndex)
+    }, {
+      option: slots.option
+    }));
     const renderMask = (wrapHeight) => {
       if (hasOptions.value) {
         const frameStyle = {
-          height: `${itemHeight.value}px`
+          height: `${optionHeight.value}px`
         };
         const maskStyle = {
-          backgroundSize: `100% ${(wrapHeight - itemHeight.value) / 2}px`
+          backgroundSize: `100% ${(wrapHeight - optionHeight.value) / 2}px`
         };
         return [_createVNode("div", {
           "class": bem("mask"),
@@ -272,7 +155,7 @@ var stdin_default = defineComponent({
       }
     };
     const renderColumns = () => {
-      const wrapHeight = itemHeight.value * +props.visibleItemCount;
+      const wrapHeight = optionHeight.value * +props.visibleOptionNum;
       const columnsStyle = {
         height: `${wrapHeight}px`
       };
@@ -282,21 +165,33 @@ var stdin_default = defineComponent({
         "onTouchmove": preventDefault
       }, [renderColumnItems(), renderMask(wrapHeight)]);
     };
-    watch(() => props.columns, format, {
+    watch(currentColumns, (columns) => {
+      columns.forEach((options, index) => {
+        if (options.length && !isOptionExist(options, selectedValues.value[index], fields.value)) {
+          setValue(index, getFirstEnabledOption(options)[fields.value.value]);
+        }
+      });
+    }, {
+      immediate: true
+    });
+    watch(() => props.modelValue, (newValues) => {
+      if (!isSameValue(newValues, selectedValues.value)) {
+        selectedValues.value = newValues;
+      }
+    }, {
+      deep: true
+    });
+    watch(selectedValues, (newValues) => {
+      if (!isSameValue(newValues, props.modelValue)) {
+        emit("update:modelValue", newValues);
+      }
+    }, {
       immediate: true
     });
+    const getSelectedOptions = () => selectedOptions.value;
     useExpose({
       confirm,
-      getValues,
-      setValues,
-      getIndexes,
-      setIndexes,
-      getColumnIndex,
-      setColumnIndex,
-      getColumnValue,
-      setColumnValue,
-      getColumnValues,
-      setColumnValues
+      getSelectedOptions
     });
     return () => {
       var _a, _b;

package/es/picker/PickerColumn.d.ts

@@ -1,59 +1,51 @@
-import { type InjectionKey } from 'vue';
-import type { PickerOption, PickerColumnProvide } from './types';
+import { type PropType, type InjectionKey } from 'vue';
+import type { PickerOption, PickerFieldNames, PickerColumnProvide } from './types';
 export declare const PICKER_KEY: InjectionKey<PickerColumnProvide>;
 declare const _default: import("vue").DefineComponent<{
-    textKey: {
-        type: StringConstructor;
+    value: (NumberConstructor | StringConstructor)[];
+    fields: {
+        type: PropType<Required<PickerFieldNames>>;
         required: true;
     };
+    options: {
+        type: PropType<PickerOption[]>;
+        default: () => never[];
+    };
     readonly: BooleanConstructor;
     allowHtml: BooleanConstructor;
-    className: import("vue").PropType<unknown>;
-    itemHeight: {
+    optionHeight: {
         type: NumberConstructor;
         required: true;
     };
-    defaultIndex: {
-        type: NumberConstructor;
-        default: number;
-    };
     swipeDuration: {
         type: (NumberConstructor | StringConstructor)[];
         required: true;
     };
-    initialOptions: {
-        type: import("vue").PropType<PickerOption[]>;
-        default: () => never[];
-    };
-    visibleItemCount: {
+    visibleOptionNum: {
         type: (NumberConstructor | StringConstructor)[];
         required: true;
     };
 }, () => JSX.Element, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, "change"[], "change", import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
-    textKey: {
-        type: StringConstructor;
+    value: (NumberConstructor | StringConstructor)[];
+    fields: {
+        type: PropType<Required<PickerFieldNames>>;
         required: true;
     };
+    options: {
+        type: PropType<PickerOption[]>;
+        default: () => never[];
+    };
     readonly: BooleanConstructor;
     allowHtml: BooleanConstructor;
-    className: import("vue").PropType<unknown>;
-    itemHeight: {
+    optionHeight: {
         type: NumberConstructor;
         required: true;
     };
-    defaultIndex: {
-        type: NumberConstructor;
-        default: number;
-    };
     swipeDuration: {
         type: (NumberConstructor | StringConstructor)[];
         required: true;
     };
-    initialOptions: {
-        type: import("vue").PropType<PickerOption[]>;
-        default: () => never[];
-    };
-    visibleItemCount: {
+    visibleOptionNum: {
         type: (NumberConstructor | StringConstructor)[];
         required: true;
     };
@@ -61,8 +53,7 @@ declare const _default: import("vue").DefineComponent<{
     onChange?: ((...args: any[]) => any) | undefined;
 }, {
     readonly: boolean;
-    defaultIndex: number;
     allowHtml: boolean;
-    initialOptions: PickerOption[];
+    options: PickerOption[];
 }>;
 export default _default;