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

Support @deprecated jsdoc tag #12759

Closed
StJohn3D opened this issue Oct 14, 2020 · 7 comments · Fixed by #21794
Closed

Support @deprecated jsdoc tag #12759

StJohn3D opened this issue Oct 14, 2020 · 7 comments · Fixed by #21794

Comments

@StJohn3D
Copy link

Is your feature request related to a problem? Please describe
In my component's props TS interface, I can use JSDoc comments to set the description, and can even use the @default tag to describe the default value 💯
However, nothing happens when I use the @deprecated tag.

Describe the solution you'd like
Some ideas:

  • It would be nice if the parent <tr> got required and deprecated classesNames e.g. <tr className="required"> & <tr className="deprecated"> so that I can easily apply custom styling to these rows.
  • For deprecated props, it would be nice if the prop name appeared grayed out, and the word Deprecated appeared in bold below it, followed by any description. e.g.

    PropName
    Deprecated since version 2.0

Describe alternatives you've considered
For now I will simply omit deprecated props manually per story via the meta default export's parameters.
parameters.docs.page.excludeProps = ['my_depricated_prop_name']

Are you able to assist to bring the feature to reality?
Perhaps in the future but not at this time.

Additional context
https://jsdoc.app/tags-deprecated.html

@siradji
Copy link

siradji commented Oct 15, 2020

Hi, Can i dig into this?

@shilman
Copy link
Member

shilman commented Oct 16, 2020

@Kraken-coder yes please! assigned 🚀

@storybookjs storybookjs deleted a comment Jan 31, 2021
@leticiavna
Copy link

Hi, I would like to try to fix this issue, but I see someone else already is assigned. Can I try it out still or should I look for another one? Also, is this still a issue, since its from last year?

@shilman
Copy link
Member

shilman commented Jun 5, 2021

@leticiavna please do! 🙏

@shilman shilman assigned leticiavna and unassigned siradji Jun 5, 2021
@yuisato1025
Copy link
Contributor

Hi, since it seems there is no update on this issue, I would like to tackle it.

@shilman
Copy link
Member

shilman commented Jan 18, 2023

Gadzooks!! I just released https://github.com/storybookjs/storybook/releases/tag/v7.0.0-beta.30 containing PR #20154 that references this issue. Upgrade today to the @next NPM tag to try it out!

npx sb@next upgrade --prerelease

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

@shilman
Copy link
Member

shilman commented Mar 29, 2023

Olé!! I just released https://github.com/storybookjs/storybook/releases/tag/v7.0.0-rc.9 containing PR #21794 that references this issue. Upgrade today to the @next NPM tag to try it out!

npx sb@next upgrade --prerelease

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants