-
Notifications
You must be signed in to change notification settings - Fork 3k
feat(ui): Storybook for UI package #13983
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
Draft
zawoj
wants to merge
29
commits into
payloadcms:main
Choose a base branch
from
zawoj:ui
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
+12,732
−326
Conversation
This file contains hidden or 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
Pull Request titles must follow the Conventional Commits specification and have valid scopes. The subject "Storybook for UI package" found in the pull request title "feat(ui): Storybook for UI package"
|
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.
What?
This PR adds comprehensive Storybook integration to the Payload UI package, including:
Note: This is currently in progress - Many components still need documentation and proper story implementations.
Why?
The Payload UI package contains many reusable components, but currently lacks:
Storybook solves these problems by providing a dedicated environment for component development, testing, and documentation.
How?
.storybook/
configuration with React + Vite integration.stories.tsx
files for each UI component with various states and props.mdx
files with component documentation and usage examplesDockerfile.ui
and deployment configuration for production hostingstorybook
andserve-storybook
scripts to package.jsonserve
for static file servingCurrent Focus: The most challenging aspect is implementing stories for more advanced components that require Payload API and context to function properly. These components need proper mocking and context providers to work in isolation within Storybook.
Preview: https://payloadcms-ui.coolify.zawojit.com/
The implementation follows Storybook best practices and integrates seamlessly with the existing Payload UI package structure.