Skip to content

Document all options for object-based props definition in API #2027

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
LinusBorg opened this issue Feb 22, 2019 · 1 comment · Fixed by #2028
Closed

Document all options for object-based props definition in API #2027

LinusBorg opened this issue Feb 22, 2019 · 1 comment · Fixed by #2028

Comments

@LinusBorg
Copy link
Member

This issue is a consequence of a conversation I had on the forum:

https://forum.vuejs.org/t/where-are-prop-options-documented/56692/3?u=linusborg

The user raised valid points, namely that the API docs in that area don't acually document the options that are avaliable except for the brief example that's given. For details about these options, the reader is forwarded to the Props Guide, but information here is spread across multiple sections in the guide, making it hard to get the full picture of what options are available and what their syntax is.

So we should clearly and still briefly document all options that are available in the API docs section:

  • type
  • default
  • required
  • validator
@phanan
Copy link
Member

phanan commented Feb 22, 2019

It seems the "See also" link in the props API section also needs an update. Right now it's pointed to https://vuejs.org/v2/guide/components.html#Props which is no more, and then redirected to https://vuejs.org/v2/guide/components.html#Passing-Data-to-Child-Components-with-Props. The correct URL should be https://vuejs.org/v2/guide/components-props.html I believe.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants