vue的prop 验证，props设置类型检查、必填、默认值和自定义验证函数等

转载于 2021-12-31 17:28:22 发布 · 8.2k 阅读

4 ·

本内容遵循CC 4.0 BY-SA版权协议

原文链接：https://v3.cn.vuejs.org/guide/component-props.html#prop-%E9%AA%8C%E8%AF%81

收录于

vue

当前文章被收录于：

vue

10 篇文章 1 人学习

订阅专栏查看详情

当前文章被以下社区和专栏收录：

本文详细介绍了Vue.js中组件props的验证机制，包括基本类型检查、多种可能的类型、必填项、默认值设置（数值、对象、函数）以及自定义验证函数的使用方法。通过这些配置，可以确保组件接收到的数据符合预期，提高代码的健壮性。

app.component('my-component', {
  props: {
    // 基础的类型检查 (`null` 和 `undefined` 值会通过任何类型验证)
    propA: Number,
    // 多个可能的类型
    propB: [String, Number],
    // 必填的字符串
    propC: {
      type: String,
      required: true
    },
    // 带有默认值的数字
    propD: {
      type: Number,
      default: 100
    },
    // 带有默认值的对象
    propE: {
      type: Object,
      // 对象或数组的默认值必须从一个工厂函数返回
      default() {
        return { message: 'hello' }
      }
    },
    // 自定义验证函数
    propF: {
      validator(value) {
        // 这个值必须与下列字符串中的其中一个相匹配
        return ['success', 'warning', 'danger'].includes(value)
      }
    },
    // 具有默认值的函数
    propG: {
      type: Function,
      // 与对象或数组的默认值不同，这不是一个工厂函数——这是一个用作默认值的函数
      default() {
        return 'Default function'
      }
    }
  }
})