question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

addon-docs <Props> table should show CSS custom properties and parts

See original GitHub issue

Is your feature request related to a problem? Please describe.

I have a custom-elements.json with the cssCustomProperties and cssShadowParts fields but when I add the <Props /> element to generate the props table in my mdx storybook these relevant tables are noticeably missing from the docs tab.

Describe the solution you’d like

The generated table has all the other relevant properties (like attributes, properties, slots, etc.) it would be nice if CSS custom properties and CSS shadow parts would be added as well

Describe alternatives you’ve considered

I could manually document these, but those run the risk of becoming obsolete, missing, or out of sync. Also the noticeable jump between the built in table and the manual table is weird.

Are you able to assist bring the feature to reality?

Yes, but only requested.

Additional context

The two added props table sections

Issue Analytics

  • State:closed
  • Created 3 years ago
  • Reactions:1
  • Comments:6 (4 by maintainers)

github_iconTop GitHub Comments

1reaction
shilmancommented, Sep 26, 2020

Yowza!! I just released https://github.com/storybookjs/storybook/releases/tag/v6.1.0-alpha.17 containing PR #10442 that references this issue. Upgrade today to try it out!

You can find this prerelease on the @next NPM tag.

Closing this issue. Please re-open if you think there’s still more to do.

0reactions
stale[bot]commented, Jun 2, 2020

Hey there, it’s me again! I am going close this issue to help our maintainers focus on the current development roadmap instead. If the issue mentioned is still a concern, please open a new ticket and mention this old one. Cheers and thanks for using Storybook!

Read more comments on GitHub >

github_iconTop Results From Across the Web

ArgsTable - Storybook - JS.ORG
Storybook Docs automatically generates component args tables for components in supported frameworks. These tables list the arguments (args for short) of the ...
Read more >
Using CSS custom properties (variables) - MDN Web Docs
Custom properties (sometimes referred to as CSS variables or cascading variables) are entities defined by CSS authors that contain specific ...
Read more >
@component-controls/storybook - npm
Specify the component(s), for which to have information displayed. The default, a value of `"."` will indicate to display information for the ...
Read more >
Documenting design systems with Storybook Docs
<ArgsTable> is a table component that lists property descriptions and ... title specifies the name of the story that will show up in...
Read more >
A Complete Guide to Custom Properties | CSS-Tricks
In no small part because they cascade. The fact that they can be updated in JavaScript opens up even more interesting possibilities. Table...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found