docs(ts-support): annotating props with validators and default values #730
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
JensDll
changed the title
JensDll
force-pushed
the
ts-support-annotating-props
branch
from
1c28008 to
8c9bc9b
Compare
|
@JensD98 thank you so much for this addition! The only fix here: could we reuse the example from above instead of changing it to use a different prop so readers would have a smooth transition? |
|
@NataliaTepluhina I can see what you mean. However, I feel like having an object with three properties for demonstrating default values two times can get a bit lengthy. Would adding the numbers array prop to the example above already help? |
|
I changed both examples to use the |
NataliaTepluhina
approved these changes
Dec 8, 2020
fimion
pushed a commit
to fimion/docs-next
that referenced
this pull request
Dec 21, 2020
…vuejs#730) * docs(ts-support): annotating props with validators and default values * docs(ts-support): annotating props added prop for number array * added missing comma * docs(ts-support): annotating props use the Book interface in examples
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.
Description of Problem
The example under Annotating Props in the TypeScript Support section of the docs would break the prop type for the component because of the
validatorfunction.Proposed Solution
Give an example of how to correctly use
validatorsanddefaultvalues for objects and arrays.Additional Information
Related issue