Skip to content

feature request: add first class support for filtering HTMLAttributes #151

Closed
@cdaringe

Description

problem

often times, one defines an a prop interface by extending HTML attributes, e.g React.ReactNode<HTMLInputAttributes>.

e.g.

interface MyProps extends React.ReactNode<HTMLInputAttributes> {
  /** a really great prop */
  bestProp: string
}

consequently, the styleguidist prop types generates prop documentation for all of the HTML attributes, not simply bestProp.

discussion

  • first, thanks for this great lib
  • second, because this pattern is so common in react, it may be worth considering adding first class support for omitting HTML attributes from the generated definitions.

thoughts? thanks!

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions