doczjs / docz

✍ It has never been so easy to document your things!
https://docz.site
MIT License
23.63k stars 1.46k forks source link

Allow splitting props into groups #895

Closed droganov closed 4 years ago

droganov commented 5 years ago

The case: I'm documenting tsx UI lib. In that lib, modules compose other modules, so do props:

export interface Props extends AtomProps {
  fitAll?: boolean;
  fitLeft?: boolean;
  fitRight?: boolean;
}

Docz Props component is actually able to understand extends, but I'd really love to split records visually and document the composition better.

maryiam commented 5 years ago

+1

maryiam commented 5 years ago

In the same context, I'm documenting TSX UI lib as well. I have a custom button that extends React.ButtonHTMLAttributes<HTMLButtonElement> props.

Docz props table contains now all props including ButtonHTMLAttributes (263 default HTML Button props like onClick, className, onSubmit..) which is very noisy and doesn't give clear visibility of my custom button props.

I would like to be able at least to separate props or ideally have the possibility to hide the extended props. Is this possible? image

stale[bot] commented 4 years ago

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

stale[bot] commented 4 years ago

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.