search

Shopify / polaris

Shopify’s design system to help us work together to build a great experience for all of our merchants.
https://polaris.shopify.com
Other
5.72k stars 1.17k forks source link

Make subcomponents discoverable #7266

Open heyjoethomas opened 1 year ago

heyjoethomas commented 1 year ago

Feature request summary

There are a number of Polaris components that rely on subcomponents to compose themselves or add functionality. Currently you can only see this in the code preview. But you can't see them within the actual props table or anywhere else on the documentation. If these subcomponents have props then there is no way to discover them besides going into the codebase

Rationale

If subcomponents are not exposed we are making it harder for developers to use and build confidently. They will be slowed down and will have to context switch in order to get the info they need.

Example

The example below is for the Popover component. We can see that there are two subcomponents being used: Popover.Pane and Popover.Pane

Screen Shot 2022-09-23 at 1 43 54 PM
pgib commented 1 year ago

I came here to say the same thing. The most frustrating thing about using a new system of components is when the documentation is lacking. It's time-consuming to dig through source code to figure things out. At version 10, there should at the very least be props documentation for the sub-components that we're expected to use. 🙏

github-actions[bot] commented 1 year ago

Hi! We noticed there hasn’t been activity on this issue in a while. After 30 days, it will close automatically.

If it’s still relevant, or you have updates, comment and let us know. And don’t worry, you can always re-open later if needed.

pgib commented 1 year ago

KEEPALIVE

github-actions[bot] commented 7 months ago

Hi! We noticed there hasn’t been activity on this issue in a while. After 30 days, it will close automatically.

If it’s still relevant, or you have updates, comment and let us know. And don’t worry, you can always re-open later if needed.

heyjoethomas commented 6 months ago

Keep open

github-actions[bot] commented 2 weeks ago

Hi! We noticed there hasn’t been activity on this issue in a while. After 30 days, it will close automatically.

If it’s still relevant, or you have updates, comment and let us know. And don’t worry, you can always re-open later if needed.

pgib commented 2 weeks ago

KEEPALIVE