Vue 'props' Option

❮ Previous Vue Instance Options Reference Next ❯

Example

Using the props option to create props for the component.

export default {
    props: [
        'foodName',
        'foodDesc'
    ]
};
Run Example »

See more examples below

Definition and Usage

The props option is an array (simple form), or an object (full form), with all the props inside.

When the props option is given as an array (simple form, see the example above), the array just consists of the names of the props as strings.

When the props option is given as an object (full form, see the example below), several options can be defined in addition to the prop names:

Option Description
type Define the prop data type. Possible types: String, Number, Boolean, Array, Object, Date, Function, or Symbol. Vue will generate a warning if the actual provided prop is of a different type than what it is defined.
default Define a default prop value. If a specific prop is not provided by the parent component, the default value will be used.
required Define if a prop is required or not. When running the Vue application in development mode, Vue will generate a warning to the console in case a required prop is not provided.
validator Define a custom validator function. The function takes the prop value as an argument, and we can write out own rules for when a prop is valid or not. Returning false will generate a warning in development mode.

More Examples

Example

Defining props as objects with options.

FoodItem.vue:

<template>
	<div>
		<h2>{{ foodName }}</h2>
		<p>{{ foodDesc }}</p>
	</div>
</template>

<script>
export default {
	props: {
		foodName: {
			type: String,
			required: true
		},
		foodDesc: {
			type: String,
			required: false,
			default: 'This is the food description...'
		}
	}
};
</script>

App.vue:

<template>
  <h1>Food</h1>
  <p>Food description is not provided for 'Pizza' and 'Rice', so the default description is used.</p>
  <div id="wrapper">
    <food-item 
      food-name="Apples" 
      food-desc="Apples are a type of fruit that grow on trees."/>
    <food-item 
      food-name="Pizza"/>
    <food-item 
      food-name="Rice"/>
  </div> 
</template>

<style>
  #wrapper {
    display: flex;
    flex-wrap: wrap;
  }
  #wrapper > div {
    border: dashed black 1px;
    flex-basis: 120px;
    margin: 10px;
    padding: 10px;
    background-color: lightgreen;
  }
</style>
Run Example »

Related Pages

Vue Tutorial: Vue Props

Vue Tutorial: Vue $emit() Method

Vue Reference: Vue $props Object


❮ Previous Vue Instance Options Reference Next ❯
Copyright 1999-2023 by Refsnes Data. All Rights Reserved.