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

docs(storybook): display overview documentation of subcomponents #7934

Closed
wants to merge 2 commits into from

Conversation

dobrinyonkov
Copy link
Contributor

@dobrinyonkov dobrinyonkov commented Nov 29, 2023

Closes: #7895

Problem: storybook doesn't display the overview documentation of the subcomponents.

Summary:

  • Introduced custom TabbedArgsTable using the ui5-tabcontainer instead of the storybook's built in tabs.
  • Conditionally render TabbedArgsTable based on sub-components, improving dosc display flexibility.
  • Introduced the argTypeRegistry to dynamically fetch local argument types for components, enhancing the extensibility of the documentation system.
  • Enhanced Storybook documentation generation in samples-prepare.js by dynamically exporting sub-components, component info, and registering arg types using argTypeRegistry.

Screenshot when the main component is selected:
image

Screenshot when any of the subcomponents are selected:
image

info: {
package: `@ui5/webcomponents${package !== 'main' ? `-${package}` : ''}`,
since: moduleAPI.since
},
subComponents: moduleAPI.appenddocs?.split(" ").map(item => item.split(".").pop()),
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

appenddocs is removed from new custom-elements-manifest. we have to think about other solution

@nnaydenow nnaydenow deleted the storybook-subcomponents-docs branch May 29, 2024 10:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Storybook: missing overview section for sub components
3 participants