Components: Document when "rest props" are passed down to underlying element/component

[mirka]

What problem does this address?

A lot of our components pass down any "rest props" to an internal element or component. Our TypeScript annotations reflect this accurately, but we don't usually mention it in the docs (e.g. Storybook). It would be good to note these explicitly.

What is your proposed solution?

Ideally we figure out a way present this information systematically in both the Storybook and README docs. At minimum, the information should be available in the Storybook docs.

It should say something like "Any other props will be passed down to the underlying foo element" (or Foo component).

[Vrishabhsk]

Hi @mirka 👋

• I have raised a PR for a potential improvement : Feature : Components Documentation for "rest props" #68099
• Currently I have implemented it for the Badge Component. Once finalized on the solution, I'll add it package-wide.

Let me know your thoughts on this. Thanks