props传值方式和校验

2024-01-16 12:11:58

1、prop 的大小写

HTML 中的 attribute 名是大小写不敏感的，
所以浏览器会把所有大写字符解释为小写字符。这意味着当你使用 DOM 中的模板时，
camelCase (驼峰命名法) 的 prop 名需要使用其等价的 kebab-case (短横线分隔命名) 命名，千万不要理解错哦，只有以下场景才是满足的哟

 <component-prop
      postTitle="title"
      post-name="name"
 ></component-prop>

 props: ["postTitle", "postName"],

页面效果

过postTitle="title" 方式传值，props: ["postTitle"]可以接收到值值为:title

通过post-name="name" 方式传值，props: ["postName"]可以接收到值值为:name

以下这样写是接收不到值的

    <component-prop
      posttitle1="title1"
      postName1="name1"
    ></component-prop>

props: ["postTitle1", "postname1"] 接收不到值

2、Prop 类型

到这里，我们只看到了以字符串数组形式列出的 prop：

props: ['title', 'likes', 'isPublished', 'commentIds', 'author']

但是，通常你希望每个 prop 都有指定的值类型。这时，你可以以对象形式列出 prop，这些 property 的名称和值分别是 prop 各自的名称和类型

props: {
  title: String,
  likes: Number,
  isPublished: Boolean,
  commentIds: Array,
  author: Object,
  callback: Function,
  contactsPromise: Promise // or any other constructor
}

这不仅为你的组件提供了文档，还会在它们遇到错误的类型时从浏览器的 JavaScript 控制台提示用户。你会在这个页面接下来的部分看到类型检查和其它 prop 验证

3、Prop传值类型

传入一个数字

<blog-post v-bind:likes="42"></blog-post>

<blog-post v-bind:likes="post.likes"></blog-post>

传入一个布尔值

<!-- 包含该 prop 没有值的情况在内，都意味着 `true`。-->
<blog-post is-published></blog-post>

<!-- 即便 `false` 是静态的，我们仍然需要 `v-bind` 来告诉 Vue -->
<!-- 这是一个 JavaScript 表达式而不是一个字符串。-->
<blog-post v-bind:is-published="false"></blog-post>

<!-- 用一个变量进行动态赋值。-->
<blog-post v-bind:is-published="post.isPublished"></blog-post>

传入一个数组

<!-- 即便数组是静态的，我们仍然需要 `v-bind` 来告诉 Vue -->
<!-- 这是一个 JavaScript 表达式而不是一个字符串。-->
<blog-post v-bind:comment-ids="[234, 266, 273]"></blog-post>

<!-- 用一个变量进行动态赋值。-->
<blog-post v-bind:comment-ids="post.commentIds"></blog-post>

传入一个对象

<!-- 即便对象是静态的，我们仍然需要 `v-bind` 来告诉 Vue -->
<!-- 这是一个 JavaScript 表达式而不是一个字符串。-->
<blog-post
  v-bind:author="{
    name: 'Veronica',
    company: 'Veridian Dynamics'
  }"
></blog-post>

<!-- 用一个变量进行动态赋值。-->
<blog-post v-bind:author="post.author"></blog-post>

传入一个对象的所有 property

如果你想要将一个对象的所有 property 都作为 prop 传入，你可以使用不带参数的 v-bind (取代 v-bind:prop-name)。例如，对于一个给定的对象 post：

export default {
  name: "compontProps",
  data: {
    post: {
      id: 1,
      title: "My Journey with Vue",
    }
  }
};

<blog-post v-bind="post"></blog-post>

子组件中接props接收

props: [ "id","title"],

在页面上显示效果

    <div>
      <span> 对象类型 传入一个对象的所有 property</span>
      <span style="color: red">id:{{ id }} </span>
      <span style="color: red">title:{{ title }} </span>
    </div>
  </div>

4、单向数据流

所有的 prop 都使得其父子 prop 之间形成了一个单向下行绑定：父级 prop 的更新会向下流动到子组件中，但是反过来则不行。这样会防止从子组件意外变更父级组件的状态，从而导致你的应用的数据流向难以理解。

额外的，每次父级组件发生变更时，子组件中所有的 prop 都将会刷新为最新的值。这意味着你不应该在一个子组件内部改变 prop。如果你这样做了，Vue 会在浏览器的控制台中发出警告。

这里有两种常见的试图变更一个 prop 的情形

1、这个 prop 用来传递一个初始值；这个子组件接下来希望将其作为一个本地的 prop 数据来使用。在这种情况下，最好定义一个本地的 data property 并将这个 prop 用作其初始值：

props: ['initialCounter'],
data: function () {
  return {
    counter: this.initialCounter
  }
}

2、这个 prop 以一种原始的值传入且需要进行转换。在这种情况下，最好使用这个 prop 的值来定义一个计算属性：

props: ['size'],
computed: {
  normalizedSize: function () {
    return this.size.trim().toLowerCase()
  }
}

注意在 JavaScript 中对象和数组是通过引用传入的，所以对于一个数组或对象类型的 prop 来说，在子组件中改变变更这个对象或数组本身将会影响到父组件的状态。

5、Prop 验证

为了定制 prop 的验证方式，你可以为 props 中的值提供一个带有验证需求的对象，而不是一个字符串数组。例如：

Vue.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: function () {
        return { message: 'hello' }
      }
    },
    // 自定义验证函数
    propF: {
      validator: function (value) {
        // 这个值必须匹配下列字符串中的一个
        return ['success', 'warning', 'danger'].indexOf(value) !== -1
      }
    }
  }
})

在父组件中传值

<my-component
      v-bind:propA="propA"
      v-bind:propB="propB"
      v-bind:propC="propC"
      v-bind:propF="propF"
      v-bind="post"
    ></my-component>

data中赋值

data: {
    propA: 1,
    propB: "a",
    propC: "c",
    propF:'0'
  },

用户未传propD和propE，页面依旧可以渲染出来值，都是取的默认值

页面渲染出来的效果

可以查看控制台，发现propF校验失败

6、类型检查

type 可以是下列原生构造函数中的一个：

String
Number
Boolean
Array
Object
Date
Function
Symbol

额外的，type 还可以是一个自定义的构造函数，并且通过 instanceof 来进行检查确认。例如，给定下列现成的构造函数：

function Person (firstName, lastName) {
  this.firstName = firstName
  this.lastName = lastName
}

你可以使用：

Vue.component('blog-post', {
  props: {
    author: Person
  }
})

验证 author prop 的值是否是通过 new Person 创建的。

7、非 Prop 的 Attribute

一个非 prop 的 attribute 是指传向一个组件，但是该组件并没有相应 prop 定义的 attribute。

因为显式定义的 prop 适用于向一个子组件传入信息，然而组件库的作者并不总能预见组件会被用于怎样的场景。这也是为什么组件可以接受任意的 attribute，而这些 attribute 会被添加到这个组件的根元素上

例如：

    <component-prop2 data-date-picker="activated"
      v-bind:propA="propA"
      v-bind:propB="propB"
      v-bind:propC="propC"
      v-bind:propF="propF"
      v-bind="post"
    ></component-prop2>

在子组件上未定义props来接收，但在页面上可以看到，这个属性依旧添加上根元素上了

从上述效果可以看出data-date-picker添加在根元素上了

8、替换/合并已有的 Attribute

想象一下 <bootstrap-date-input> 的模板是这样的：

<input type="date" class="form-control">

为了给我们的日期选择器插件定制一个主题，我们可能需要像这样添加一个特别的类名：

    <component-date
      type="text"
      value="text"
      class="date-picker-theme-dark"
    ></component-date>

在这种情况下，我们定义了两个不同的 class 的值：

form-control，这是在子组件的模板内设置好的
date-picker-theme-dark，这是从组件的父级传入的

对于绝大多数 attribute 来说，从外部提供给组件的值会替换掉组件内部设置好的值。所以如果传入 type="text" 就会替换掉 type="date" 并把它破坏！庆幸的是，class 和 style attribute 会稍微智能一些，即两边的值会被合并起来，从而得到最终的值：form-control date-picker-theme-dark。下面看一下页面渲染出来的效果

从渲染效果来看，type和value父组件会覆盖子组件，class 父组件和子组件合在一样，样式有设置相同的值，子组件会覆盖父组件， width 和background-color 子组件覆盖了父组件

9、禁用 Attribute 继承

如果你不希望组件的根元素继承 attribute，你可以在组件的选项中设置 inheritAttrs: false。例如：

Vue.component('my-component', {
  inheritAttrs: false,
  // ...
})

页面渲染的效果

从渲染效果来看，添加禁用之后，type和value属性不收父组件的影响，class 父组件和子组件合在一样，样式有设置相同的值，子组件会覆盖父组件， width 和background-color 子组件覆盖了父组件

注意 inheritAttrs: false 选项不会影响 style 和 class 的绑定。

码农公寓