Skip to content
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

Are private (or protected, or hidden) props possible? #331

Closed
n1313 opened this issue Feb 20, 2017 · 3 comments
Closed

Are private (or protected, or hidden) props possible? #331

n1313 opened this issue Feb 20, 2017 · 3 comments

Comments

@n1313
Copy link
Collaborator

n1313 commented Feb 20, 2017

In some cases a component might have a prop that should not be accessed by the user. It could be useful to hide this prop from the documentation or mark it in some other way.

An example of this would be a container component that is wrapped in Redux connect() with props that are managed by react-redux. I have a number of props that must be declared on the component for action dispatch to work and should not be tampered with by a user.

@sapegin
Copy link
Member

sapegin commented Feb 20, 2017

How about @ignore JSDoc tag?

/cc @kof

@kof
Copy link

kof commented Feb 20, 2017

@sapegin @ignore sounds exactly right! Just tried, we currently render it as text in description field, I assume rs needs to handle this prop?

@sapegin
Copy link
Member

sapegin commented Feb 20, 2017

@kof Yup! ;-)

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

No branches or pull requests

3 participants