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

Can I "get" the intended HTML element to be rendered? #566

Open
lucastobrazil opened this issue Feb 26, 2022 · 0 comments
Open

Can I "get" the intended HTML element to be rendered? #566

lucastobrazil opened this issue Feb 26, 2022 · 0 comments

Comments

@lucastobrazil
Copy link

I would like to document both the props and the HTML element that a react component plans on rendering:

const MyComponent = ({ foo, bar, ...restProps }) => <h1 foo={ foo } bar={bar}  {...restProps } />;

MyComponent.propTypes = {
   foo: PropTypes.string,
   bar: PropTypes.number,
}

In the above example I want to be able to document:

  1. The props stated in propTypes
  2. The "native" HTML props that would be valid for an h1 element.

In the docs i wanna say:
"here are the explicitly set props and this component also takes all valid props for HTMLHeadingElement"

Is it possible for us to get the h1 tag from docgen so we can associate that component's documentation with its html tag?

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

No branches or pull requests

1 participant