Added options for object-based props definition in API #2028
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- fixed a link to props section
LinusBorg
requested changes
Feb 23, 2019
|
Thanks for the blazing fast review, @LinusBorg! I've added some requested changes |
phanan
reviewed
Feb 23, 2019
Co-Authored-By: NataliaTepluhina <[email protected]>
Co-Authored-By: NataliaTepluhina <[email protected]>
Co-Authored-By: NataliaTepluhina <[email protected]>
|
Thanks @phanan! Yes, I agree, I forgot to mention warnings are thrown only on dev environment |
phanan
approved these changes
Feb 24, 2019
|
Looks great! I think it's good enough to merge now 👍 |
phanan
pushed a commit
to phanan-forks/vuejs.org
that referenced
this pull request
Mar 14, 2019
* feat: add API entry on props options - fixed a link to props section * fix: moved a link and added read-more types link * Update src/v2/api/index.md Co-Authored-By: NataliaTepluhina <[email protected]> * Update src/v2/api/index.md Co-Authored-By: NataliaTepluhina <[email protected]> * Update src/v2/api/index.md Co-Authored-By: NataliaTepluhina <[email protected]>
phanan
pushed a commit
to phanan-forks/vuejs.org
that referenced
this pull request
Mar 20, 2019
* feat: add API entry on props options - fixed a link to props section * fix: moved a link and added read-more types link * Update src/v2/api/index.md Co-Authored-By: NataliaTepluhina <[email protected]> * Update src/v2/api/index.md Co-Authored-By: NataliaTepluhina <[email protected]> * Update src/v2/api/index.md Co-Authored-By: NataliaTepluhina <[email protected]>
Jinjiang
reviewed
Mar 26, 2019
| @@ -509,6 +509,15 @@ type: api | |||
|
|
|||
| A list/hash of attributes that are exposed to accept data from the parent component. It has an Array-based simple syntax and an alternative Object-based syntax that allows advanced configurations such as type checking, custom validation and default values. | |||
|
|
|||
| With Object-based syntax, you can use following options: | |||
| - **type:** can be one of the following native constructors: `String`, `Number`, `Boolean`, `Array`, `Object`, `Date`, `Function`, `Symbol`, any custom constructor function or an array of those. Will check if a prop has a given type, and will throw a warning if it doesn't. [More information](../guide/components-props.html#Prop-Types) on prop types. | |||
There was a problem hiding this comment.
Is it better to wrap the object keys type, default, required and validator with backquotes? Because they are kinds of actual code somehow. 🤔
I will give a PR if you all don't mind.
Thanks.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I created a draft API entry describing all possible options we can have with Object-syntax prop. Also, I fixes a link @phanan mentioned in #2027.
Close #2027