Leo/documentation/105 add documentation to sharedui components using storybook #146
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Introduce a mock i18n setup within Storybook using i18next and react-i18next. Renamed `preview.ts` to `preview.tsx` to include the I18nextProvider decorator for proper localization in stories.
Incorporate the Providers component within Storybook's decorators to ensure consistent use of global providers across stories. This change improves the overall integration and testing of components wrapped in providers.
Modified the webpack configuration in Storybook to handle SVG files correctly by excluding them from the default file loader and adding a rule to use SVGR for SVG file imports. This ensures SVGs are processed and handled as React components.
Imported the main SCSS stylesheet to the Storybook preview configuration to ensure consistent styling throughout the Storybook components. This change helps maintain visual consistency and leverages the project's existing style definitions.
Commented out the SVG loader configuration in the Storybook webpack setup to prevent conflicts with other image types. Added a note to investigate the issue further.
Updated `SocialSection`, `Rights`, and `FooterDesktop` stories to use the latest `Meta` and `StoryObj` types from Storybook. Replaced old `ComponentStory` and `ComponentMeta` types to improve maintainability and consistency.
Updated the Storybook meta configuration for the Footer Title component by replacing `ComponentMeta` and `ComponentStory` with `Meta` and `StoryObj`. This streamlines the code and makes the story definitions more consistent with the
Updated `FooterDesktop.stories.tsx` to enhance component and story documentation. Added controls and descriptions for props, and included additional Storybook parameters for improved clarity.
Updated Button stories from the legacy Storybook format to the new v6 format using StoryObj and Meta. This enhances the maintainability and readability of story definitions and ensures better integration with Storybook's newer features and best practices.
MikhailDeriabin
approved these changes
Oct 8, 2024
leolabdev
deleted the
leo/documentation/105-add-documentation-to-sharedui-components-using-storybook
branch
2 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I made a setup and fixed some problems related to the configuration, now I would like to pass this task to the next hands