Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Addon-docs: Update type/value rendering for 6.0 recommendations #10311

Closed
4 tasks
shilman opened this issue Apr 4, 2020 · 3 comments
Closed
4 tasks

Addon-docs: Update type/value rendering for 6.0 recommendations #10311

shilman opened this issue Apr 4, 2020 · 3 comments

Comments

@shilman
Copy link
Member

shilman commented Apr 4, 2020

Addons___Docs___mdx_-_hello_story_⋅_Storybook

Storybook 5.3 has a nice type rendering system based on react-docgen-typescript-loader. In SB 6.0 we've updated the recommended configuration, which brings a lot of improvements. However, the new setup exercises a new codepath that contains poor type/value rendering heuristics. These need to be updated before launch:

  • Union
  • Intersection
  • Function
  • etc.
@sunyatasattva
Copy link

@shilman Is there any news on this? The docs point out, for example, to the dealbreaker of imported types not working in react-docgen and link to the relevant PR, mentioning it is open. The PR has since been closed (reactjs/react-docgen#352) and instead another one has been merged (reactjs/react-docgen#464). Probably the docs should be updated accordingly as this is not anymore a deal breaker for react-docgen.

Otherwise, is there any plan to figure out things like union or signature with the current recommended configuration?

@shilman
Copy link
Member Author

shilman commented Nov 30, 2021

@sunyatasattva We now recommend react-docgen-typescript as the recommended docgen handler for Typescript. Any PRs to improve react-docgen handling would be highly appreciated.

@shilman
Copy link
Member Author

shilman commented Jun 8, 2023

We’re cleaning house! Storybook has changed a lot since this issue was created and we don’t know if it’s still valid. Please open a new issue referencing this one if:

@shilman shilman closed this as not planned Won't fix, can't repro, duplicate, stale Jun 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants