vant 4.0.0-alpha.3 → 4.0.0-beta.1

package/es/field/Field.d.ts

@@ -209,7 +209,7 @@ declare const _default: import("vue").DefineComponent<{
         type: BooleanConstructor;
         default: null;
     };
-}, () => JSX.Element, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, ("clear" | "focus" | "blur" | "keypress" | "clickInput" | "clickLeftIcon" | "clickRightIcon" | "update:modelValue")[], "clear" | "focus" | "blur" | "keypress" | "clickInput" | "clickLeftIcon" | "clickRightIcon" | "update:modelValue", import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<ExtractPropTypes<{
+}, () => JSX.Element, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, ("clear" | "focus" | "blur" | "keypress" | "clickInput" | "endValidate" | "startValidate" | "clickLeftIcon" | "clickRightIcon" | "update:modelValue")[], "clear" | "focus" | "blur" | "keypress" | "clickInput" | "endValidate" | "startValidate" | "clickLeftIcon" | "clickRightIcon" | "update:modelValue", import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<ExtractPropTypes<{
     icon: StringConstructor;
     size: PropType<import("../cell").CellSize>;
     title: (NumberConstructor | StringConstructor)[];
@@ -297,17 +297,19 @@ declare const _default: import("vue").DefineComponent<{
     onKeypress?: ((...args: any[]) => any) | undefined;
     onClear?: ((...args: any[]) => any) | undefined;
     onClickInput?: ((...args: any[]) => any) | undefined;
+    onEndValidate?: ((...args: any[]) => any) | undefined;
+    onStartValidate?: ((...args: any[]) => any) | undefined;
     onClickLeftIcon?: ((...args: any[]) => any) | undefined;
     onClickRightIcon?: ((...args: any[]) => any) | undefined;
     "onUpdate:modelValue"?: ((...args: any[]) => any) | undefined;
 }, {
     type: FieldType;
+    required: boolean;
     center: boolean;
     autofocus: boolean;
     disabled: boolean;
     isLink: boolean;
     border: boolean;
-    required: boolean;
     clickable: boolean | null;
     clearable: boolean;
     clearIcon: string;

package/es/field/Field.mjs

@@ -0,0 +1,452 @@
+import { createTextVNode as _createTextVNode, mergeProps as _mergeProps, createVNode as _createVNode } from "vue";
+import { ref, watch, provide, computed, nextTick, reactive, onMounted, defineComponent } from "vue";
+import { isDef, extend, addUnit, toArray, FORM_KEY, numericProp, unknownProp, resetScroll, formatNumber, preventDefault, makeStringProp, makeNumericProp, createNamespace } from "../utils/index.mjs";
+import { cutString, runSyncRule, endComposing, mapInputType, isEmptyValue, startComposing, getRuleMessage, resizeTextarea, getStringLength, runRuleValidator } from "./utils.mjs";
+import { cellSharedProps } from "../cell/Cell.mjs";
+import { CUSTOM_FIELD_INJECTION_KEY, useParent } from "@vant/use";
+import { useId } from "../composables/use-id.mjs";
+import { useExpose } from "../composables/use-expose.mjs";
+import { Icon } from "../icon/index.mjs";
+import { Cell } from "../cell/index.mjs";
+const [name, bem] = createNamespace("field");
+const fieldSharedProps = {
+  id: String,
+  name: String,
+  leftIcon: String,
+  rightIcon: String,
+  autofocus: Boolean,
+  clearable: Boolean,
+  maxlength: numericProp,
+  formatter: Function,
+  clearIcon: makeStringProp("clear"),
+  modelValue: makeNumericProp(""),
+  inputAlign: String,
+  placeholder: String,
+  autocomplete: String,
+  errorMessage: String,
+  enterkeyhint: String,
+  clearTrigger: makeStringProp("focus"),
+  formatTrigger: makeStringProp("onChange"),
+  error: {
+    type: Boolean,
+    default: null
+  },
+  disabled: {
+    type: Boolean,
+    default: null
+  },
+  readonly: {
+    type: Boolean,
+    default: null
+  }
+};
+const fieldProps = extend({}, cellSharedProps, fieldSharedProps, {
+  rows: numericProp,
+  type: makeStringProp("text"),
+  rules: Array,
+  autosize: [Boolean, Object],
+  labelWidth: numericProp,
+  labelClass: unknownProp,
+  labelAlign: String,
+  showWordLimit: Boolean,
+  errorMessageAlign: String,
+  colon: {
+    type: Boolean,
+    default: null
+  }
+});
+var stdin_default = defineComponent({
+  name,
+  props: fieldProps,
+  emits: ["blur", "focus", "clear", "keypress", "clickInput", "endValidate", "startValidate", "clickLeftIcon", "clickRightIcon", "update:modelValue"],
+  setup(props, {
+    emit,
+    slots
+  }) {
+    const id = useId();
+    const state = reactive({
+      status: "unvalidated",
+      focused: false,
+      validateMessage: ""
+    });
+    const inputRef = ref();
+    const customValue = ref();
+    const {
+      parent: form
+    } = useParent(FORM_KEY);
+    const getModelValue = () => {
+      var _a;
+      return String((_a = props.modelValue) != null ? _a : "");
+    };
+    const getProp = (key) => {
+      if (isDef(props[key])) {
+        return props[key];
+      }
+      if (form && isDef(form.props[key])) {
+        return form.props[key];
+      }
+    };
+    const showClear = computed(() => {
+      const readonly = getProp("readonly");
+      if (props.clearable && !readonly) {
+        const hasValue = getModelValue() !== "";
+        const trigger = props.clearTrigger === "always" || props.clearTrigger === "focus" && state.focused;
+        return hasValue && trigger;
+      }
+      return false;
+    });
+    const formValue = computed(() => {
+      if (customValue.value && slots.input) {
+        return customValue.value();
+      }
+      return props.modelValue;
+    });
+    const runRules = (rules) => rules.reduce((promise, rule) => promise.then(() => {
+      if (state.status === "failed") {
+        return;
+      }
+      let {
+        value
+      } = formValue;
+      if (rule.formatter) {
+        value = rule.formatter(value, rule);
+      }
+      if (!runSyncRule(value, rule)) {
+        state.status = "failed";
+        state.validateMessage = getRuleMessage(value, rule);
+        return;
+      }
+      if (rule.validator) {
+        if (isEmptyValue(value) && rule.validateEmpty === false) {
+          return;
+        }
+        return runRuleValidator(value, rule).then((result) => {
+          if (result && typeof result === "string") {
+            state.status = "failed";
+            state.validateMessage = result;
+          } else if (result === false) {
+            state.status = "failed";
+            state.validateMessage = getRuleMessage(value, rule);
+          }
+        });
+      }
+    }), Promise.resolve());
+    const resetValidation = () => {
+      state.status = "unvalidated";
+      state.validateMessage = "";
+    };
+    const endValidate = () => emit("endValidate", {
+      status: state.status
+    });
+    const validate = (rules = props.rules) => new Promise((resolve) => {
+      resetValidation();
+      if (rules) {
+        emit("startValidate");
+        runRules(rules).then(() => {
+          if (state.status === "failed") {
+            resolve({
+              name: props.name,
+              message: state.validateMessage
+            });
+            endValidate();
+          } else {
+            state.status = "passed";
+            resolve();
+            endValidate();
+          }
+        });
+      } else {
+        resolve();
+      }
+    });
+    const validateWithTrigger = (trigger) => {
+      if (form && props.rules) {
+        const {
+          validateTrigger
+        } = form.props;
+        const defaultTrigger = toArray(validateTrigger).includes(trigger);
+        const rules = props.rules.filter((rule) => {
+          if (rule.trigger) {
+            return toArray(rule.trigger).includes(trigger);
+          }
+          return defaultTrigger;
+        });
+        if (rules.length) {
+          validate(rules);
+        }
+      }
+    };
+    const limitValueLength = (value) => {
+      const {
+        maxlength
+      } = props;
+      if (isDef(maxlength) && getStringLength(value) > maxlength) {
+        const modelValue = getModelValue();
+        if (modelValue && getStringLength(modelValue) === +maxlength) {
+          return modelValue;
+        }
+        return cutString(value, +maxlength);
+      }
+      return value;
+    };
+    const updateValue = (value, trigger = "onChange") => {
+      value = limitValueLength(value);
+      if (props.type === "number" || props.type === "digit") {
+        const isNumber = props.type === "number";
+        value = formatNumber(value, isNumber, isNumber);
+      }
+      if (props.formatter && trigger === props.formatTrigger) {
+        value = props.formatter(value);
+      }
+      if (inputRef.value && inputRef.value.value !== value) {
+        inputRef.value.value = value;
+      }
+      if (value !== props.modelValue) {
+        emit("update:modelValue", value);
+      }
+    };
+    const onInput = (event) => {
+      if (!event.target.composing) {
+        updateValue(event.target.value);
+      }
+    };
+    const blur = () => {
+      var _a;
+      return (_a = inputRef.value) == null ? void 0 : _a.blur();
+    };
+    const focus = () => {
+      var _a;
+      return (_a = inputRef.value) == null ? void 0 : _a.focus();
+    };
+    const adjustTextareaSize = () => {
+      const input = inputRef.value;
+      if (props.type === "textarea" && props.autosize && input) {
+        resizeTextarea(input, props.autosize);
+      }
+    };
+    const onFocus = (event) => {
+      state.focused = true;
+      emit("focus", event);
+      nextTick(adjustTextareaSize);
+      if (getProp("readonly")) {
+        blur();
+      }
+    };
+    const onBlur = (event) => {
+      if (getProp("readonly")) {
+        return;
+      }
+      state.focused = false;
+      updateValue(getModelValue(), "onBlur");
+      emit("blur", event);
+      validateWithTrigger("onBlur");
+      nextTick(adjustTextareaSize);
+      resetScroll();
+    };
+    const onClickInput = (event) => emit("clickInput", event);
+    const onClickLeftIcon = (event) => emit("clickLeftIcon", event);
+    const onClickRightIcon = (event) => emit("clickRightIcon", event);
+    const onClear = (event) => {
+      preventDefault(event);
+      emit("update:modelValue", "");
+      emit("clear", event);
+    };
+    const showError = computed(() => {
+      if (typeof props.error === "boolean") {
+        return props.error;
+      }
+      if (form && form.props.showError && state.status === "failed") {
+        return true;
+      }
+    });
+    const labelStyle = computed(() => {
+      const labelWidth = getProp("labelWidth");
+      if (labelWidth) {
+        return {
+          width: addUnit(labelWidth)
+        };
+      }
+    });
+    const onKeypress = (event) => {
+      const ENTER_CODE = 13;
+      if (event.keyCode === ENTER_CODE) {
+        const submitOnEnter = form && form.props.submitOnEnter;
+        if (!submitOnEnter && props.type !== "textarea") {
+          preventDefault(event);
+        }
+        if (props.type === "search") {
+          blur();
+        }
+      }
+      emit("keypress", event);
+    };
+    const getInputId = () => props.id || `${id}-input`;
+    const getValidationStatus = () => state.status;
+    const renderInput = () => {
+      const controlClass = bem("control", [getProp("inputAlign"), {
+        error: showError.value,
+        custom: !!slots.input,
+        "min-height": props.type === "textarea" && !props.autosize
+      }]);
+      if (slots.input) {
+        return _createVNode("div", {
+          "class": controlClass,
+          "onClick": onClickInput
+        }, [slots.input()]);
+      }
+      const inputAttrs = {
+        id: getInputId(),
+        ref: inputRef,
+        name: props.name,
+        rows: props.rows !== void 0 ? +props.rows : void 0,
+        class: controlClass,
+        disabled: getProp("disabled"),
+        readonly: getProp("readonly"),
+        autofocus: props.autofocus,
+        placeholder: props.placeholder,
+        autocomplete: props.autocomplete,
+        enterkeyhint: props.enterkeyhint,
+        "aria-labelledby": props.label ? `${id}-label` : void 0,
+        onBlur,
+        onFocus,
+        onInput,
+        onClick: onClickInput,
+        onChange: endComposing,
+        onKeypress,
+        onCompositionend: endComposing,
+        onCompositionstart: startComposing
+      };
+      if (props.type === "textarea") {
+        return _createVNode("textarea", inputAttrs, null);
+      }
+      return _createVNode("input", _mergeProps(mapInputType(props.type), inputAttrs), null);
+    };
+    const renderLeftIcon = () => {
+      const leftIconSlot = slots["left-icon"];
+      if (props.leftIcon || leftIconSlot) {
+        return _createVNode("div", {
+          "class": bem("left-icon"),
+          "onClick": onClickLeftIcon
+        }, [leftIconSlot ? leftIconSlot() : _createVNode(Icon, {
+          "name": props.leftIcon,
+          "classPrefix": props.iconPrefix
+        }, null)]);
+      }
+    };
+    const renderRightIcon = () => {
+      const rightIconSlot = slots["right-icon"];
+      if (props.rightIcon || rightIconSlot) {
+        return _createVNode("div", {
+          "class": bem("right-icon"),
+          "onClick": onClickRightIcon
+        }, [rightIconSlot ? rightIconSlot() : _createVNode(Icon, {
+          "name": props.rightIcon,
+          "classPrefix": props.iconPrefix
+        }, null)]);
+      }
+    };
+    const renderWordLimit = () => {
+      if (props.showWordLimit && props.maxlength) {
+        const count = getStringLength(getModelValue());
+        return _createVNode("div", {
+          "class": bem("word-limit")
+        }, [_createVNode("span", {
+          "class": bem("word-num")
+        }, [count]), _createTextVNode("/"), props.maxlength]);
+      }
+    };
+    const renderMessage = () => {
+      if (form && form.props.showErrorMessage === false) {
+        return;
+      }
+      const message = props.errorMessage || state.validateMessage;
+      if (message) {
+        const slot = slots["error-message"];
+        const errorMessageAlign = getProp("errorMessageAlign");
+        return _createVNode("div", {
+          "class": bem("error-message", errorMessageAlign)
+        }, [slot ? slot({
+          message
+        }) : message]);
+      }
+    };
+    const renderLabel = () => {
+      const colon = getProp("colon") ? ":" : "";
+      if (slots.label) {
+        return [slots.label(), colon];
+      }
+      if (props.label) {
+        return _createVNode("label", {
+          "id": `${id}-label`,
+          "for": getInputId()
+        }, [props.label + colon]);
+      }
+    };
+    const renderFieldBody = () => [_createVNode("div", {
+      "class": bem("body")
+    }, [renderInput(), showClear.value && _createVNode(Icon, {
+      "name": props.clearIcon,
+      "class": bem("clear"),
+      "onTouchstart": onClear
+    }, null), renderRightIcon(), slots.button && _createVNode("div", {
+      "class": bem("button")
+    }, [slots.button()])]), renderWordLimit(), renderMessage()];
+    useExpose({
+      blur,
+      focus,
+      validate,
+      formValue,
+      resetValidation,
+      getValidationStatus
+    });
+    provide(CUSTOM_FIELD_INJECTION_KEY, {
+      customValue,
+      resetValidation,
+      validateWithTrigger
+    });
+    watch(() => props.modelValue, () => {
+      updateValue(getModelValue());
+      resetValidation();
+      validateWithTrigger("onChange");
+      nextTick(adjustTextareaSize);
+    });
+    onMounted(() => {
+      updateValue(getModelValue(), props.formatTrigger);
+      nextTick(adjustTextareaSize);
+    });
+    return () => {
+      const disabled = getProp("disabled");
+      const labelAlign = getProp("labelAlign");
+      const Label = renderLabel();
+      const LeftIcon = renderLeftIcon();
+      return _createVNode(Cell, {
+        "size": props.size,
+        "icon": props.leftIcon,
+        "class": bem({
+          error: showError.value,
+          disabled,
+          [`label-${labelAlign}`]: labelAlign
+        }),
+        "center": props.center,
+        "border": props.border,
+        "isLink": props.isLink,
+        "clickable": props.clickable,
+        "titleStyle": labelStyle.value,
+        "valueClass": bem("value"),
+        "titleClass": [bem("label", [labelAlign, {
+          required: props.required
+        }]), props.labelClass],
+        "arrowDirection": props.arrowDirection
+      }, {
+        icon: LeftIcon ? () => LeftIcon : null,
+        title: Label ? () => Label : null,
+        value: renderFieldBody,
+        extra: slots.extra
+      });
+    };
+  }
+});
+export {
+  stdin_default as default,
+  fieldSharedProps
+};

package/es/field/index.d.ts

@@ -81,7 +81,7 @@ export declare const Field: import("../utils").WithInstall<import("vue").DefineC
         type: BooleanConstructor;
         default: null;
     };
-}, () => JSX.Element, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, ("clear" | "focus" | "blur" | "keypress" | "clickInput" | "clickLeftIcon" | "clickRightIcon" | "update:modelValue")[], "clear" | "focus" | "blur" | "keypress" | "clickInput" | "clickLeftIcon" | "clickRightIcon" | "update:modelValue", import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+}, () => JSX.Element, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, ("clear" | "focus" | "blur" | "keypress" | "clickInput" | "endValidate" | "startValidate" | "clickLeftIcon" | "clickRightIcon" | "update:modelValue")[], "clear" | "focus" | "blur" | "keypress" | "clickInput" | "endValidate" | "startValidate" | "clickLeftIcon" | "clickRightIcon" | "update:modelValue", import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
     icon: StringConstructor;
     size: import("vue").PropType<import("..").CellSize>;
     title: (NumberConstructor | StringConstructor)[];
@@ -169,17 +169,19 @@ export declare const Field: import("../utils").WithInstall<import("vue").DefineC
     onKeypress?: ((...args: any[]) => any) | undefined;
     onClear?: ((...args: any[]) => any) | undefined;
     onClickInput?: ((...args: any[]) => any) | undefined;
+    onEndValidate?: ((...args: any[]) => any) | undefined;
+    onStartValidate?: ((...args: any[]) => any) | undefined;
     onClickLeftIcon?: ((...args: any[]) => any) | undefined;
     onClickRightIcon?: ((...args: any[]) => any) | undefined;
     "onUpdate:modelValue"?: ((...args: any[]) => any) | undefined;
 }, {
     type: import("./types").FieldType;
+    required: boolean;
     center: boolean;
     autofocus: boolean;
     disabled: boolean;
     isLink: boolean;
     border: boolean;
-    required: boolean;
     clickable: boolean | null;
     clearable: boolean;
     clearIcon: string;
@@ -193,7 +195,7 @@ export declare const Field: import("../utils").WithInstall<import("vue").DefineC
 }>>;
 export default Field;
 export type { FieldProps };
-export type { FieldType, FieldRule, FieldInstance, FieldTextAlign, FieldRuleMessage, FieldClearTrigger, FieldFormatTrigger, FieldRuleValidator, FiledRuleFormatter, FieldValidateError, FieldAutosizeConfig, FieldValidateTrigger, } from './types';
+export type { FieldType, FieldRule, FieldInstance, FieldTextAlign, FieldRuleMessage, FieldClearTrigger, FieldFormatTrigger, FieldRuleValidator, FiledRuleFormatter, FieldValidateError, FieldAutosizeConfig, FieldValidateTrigger, FieldValidationStatus, } from './types';
 declare module 'vue' {
     interface GlobalComponents {
         VanField: typeof Field;

package/es/field/index.mjs

@@ -0,0 +1,8 @@
+import { withInstall } from "../utils/index.mjs";
+import _Field from "./Field.mjs";
+const Field = withInstall(_Field);
+var stdin_default = Field;
+export {
+  Field,
+  stdin_default as default
+};

package/es/field/types.d.ts

@@ -23,13 +23,16 @@ export declare type FieldRule = {
     required?: boolean;
     validator?: FieldRuleValidator;
     formatter?: FiledRuleFormatter;
+    validateEmpty?: boolean;
 };
+export declare type FieldValidationStatus = 'passed' | 'failed' | 'unvalidated';
 export declare type FieldFormSharedProps = 'colon' | 'disabled' | 'readonly' | 'labelWidth' | 'labelAlign' | 'inputAlign' | 'errorMessageAlign';
 export declare type FieldExpose = {
     blur: () => void | undefined;
     focus: () => void | undefined;
     validate: (rules?: FieldRule[] | undefined) => Promise<void | FieldValidateError>;
     resetValidation: () => void;
+    getValidationStatus: () => FieldValidationStatus;
     /** @private */
     formValue: ComputedRef<unknown>;
 };

package/es/field/utils.d.ts

@@ -1,5 +1,6 @@
 import { HTMLAttributes, InputHTMLAttributes } from 'vue';
 import type { FieldRule, FieldType, FieldAutosizeConfig } from './types';
+export declare function isEmptyValue(value: unknown): boolean;
 export declare function runSyncRule(value: unknown, rule: FieldRule): boolean;
 export declare function runRuleValidator(value: unknown, rule: FieldRule): Promise<unknown>;
 export declare function getRuleMessage(value: unknown, rule: FieldRule): string;

package/es/field/utils.mjs

@@ -0,0 +1,107 @@
+import {
+  isObject,
+  isPromise,
+  isFunction,
+  getRootScrollTop,
+  setRootScrollTop
+} from "../utils/index.mjs";
+function isEmptyValue(value) {
+  if (Array.isArray(value)) {
+    return !value.length;
+  }
+  if (value === 0) {
+    return false;
+  }
+  return !value;
+}
+function runSyncRule(value, rule) {
+  if (isEmptyValue(value)) {
+    if (rule.required) {
+      return false;
+    }
+    if (rule.validateEmpty === false) {
+      return true;
+    }
+  }
+  if (rule.pattern && !rule.pattern.test(String(value))) {
+    return false;
+  }
+  return true;
+}
+function runRuleValidator(value, rule) {
+  return new Promise((resolve) => {
+    const returnVal = rule.validator(value, rule);
+    if (isPromise(returnVal)) {
+      returnVal.then(resolve);
+      return;
+    }
+    resolve(returnVal);
+  });
+}
+function getRuleMessage(value, rule) {
+  const { message } = rule;
+  if (isFunction(message)) {
+    return message(value, rule);
+  }
+  return message || "";
+}
+function startComposing({ target }) {
+  target.composing = true;
+}
+function endComposing({ target }) {
+  if (target.composing) {
+    target.composing = false;
+    target.dispatchEvent(new Event("input"));
+  }
+}
+function resizeTextarea(input, autosize) {
+  const scrollTop = getRootScrollTop();
+  input.style.height = "auto";
+  let height = input.scrollHeight;
+  if (isObject(autosize)) {
+    const { maxHeight, minHeight } = autosize;
+    if (maxHeight !== void 0) {
+      height = Math.min(height, maxHeight);
+    }
+    if (minHeight !== void 0) {
+      height = Math.max(height, minHeight);
+    }
+  }
+  if (height) {
+    input.style.height = `${height}px`;
+    setRootScrollTop(scrollTop);
+  }
+}
+function mapInputType(type) {
+  if (type === "number") {
+    return {
+      type: "text",
+      inputmode: "decimal"
+    };
+  }
+  if (type === "digit") {
+    return {
+      type: "tel",
+      inputmode: "numeric"
+    };
+  }
+  return { type };
+}
+function getStringLength(str) {
+  return [...str].length;
+}
+function cutString(str, maxlength) {
+  return [...str].slice(0, maxlength).join("");
+}
+export {
+  cutString,
+  endComposing,
+  getRuleMessage,
+  getStringLength,
+  isEmptyValue,
+  mapInputType,
+  resizeTextarea,
+  runRuleValidator,
+  runSyncRule,
+  startComposing
+};