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

Provide descriptions as documentation for the widgets #135

Open
jusa3 opened this issue Sep 25, 2024 · 1 comment
Open

Provide descriptions as documentation for the widgets #135

jusa3 opened this issue Sep 25, 2024 · 1 comment
Labels
enhancement New feature or request

Comments

@jusa3
Copy link
Collaborator

jusa3 commented Sep 25, 2024

To enhance the documentation, a short description of the widgets in the Storybook would be nice. Maybe at the top of the Docs tab. There is an example for the AutocompleteWidget. It is a comment in the AutocompleteWidget.tsx. Sadly, I did not find a solution yet to gather the widget descriptions in a file as with the arguments in the storyArgs.ts.

@jusa3 jusa3 added the enhancement New feature or request label Sep 25, 2024
@VincentKneip
Copy link
Collaborator

You can add a description in the .stories.tsx file like this:

parameters: {
  layout: "centered",
  docs: {
    description: {
      component: "-> Here comes the description <-"
    }
  }
},

Like this, we could set component to a string constant from a file containing all descriptions.
Disadvantage: Does not support Markdown

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants