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

Storybook: Add stories for the ContrastChecker component #68120

Merged
merged 2 commits into from
Dec 27, 2024

Conversation

himanshupathak95
Copy link
Contributor

@himanshupathak95 himanshupathak95 commented Dec 19, 2024

Part of #67165

What?

This PR adds the Storybook stories for the ContrastChecker component in the block editor. It includes comprehensive stories demonstrating different text alignment states.

Testing Instructions

  • Start Storybook by running npm run storybook:dev
  • Open Storybook at http://localhost:50240/
  • Navigate to "BlockEditor/ContrastChecker" in the Storybook sidebar
  • Test the stories

Screencast

Screen.Recording.2024-12-19.at.13.22.09.mov

@himanshupathak95 himanshupathak95 changed the title Storybook: Add stories for the contrast-checker component Storybook: Add stories for the ContrastChecker component Dec 19, 2024
@himanshupathak95 himanshupathak95 marked this pull request as ready for review December 19, 2024 07:56
Copy link

github-actions bot commented Dec 19, 2024

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: himanshupathak95 <abcd95@git.wordpress.org>
Co-authored-by: t-hamano <wildworks@git.wordpress.org>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

@himanshupathak95
Copy link
Contributor Author

Hi @t-hamano,
I've created a story for the ContrastChecker component, following the patterns in README.md. Would you mind taking a look at my pull request and sharing your thoughts?

Thanks!

Copy link
Contributor

@t-hamano t-hamano left a comment

Choose a reason for hiding this comment

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

Thanks for the PR!

This component is a bit special in that it doesn't render anything if the contrast is sufficient. This may confuse developers seeing this component for the first time.

How about setting a default value to intentionally cause insufficient contrast?

export const Default = {
	args: {
		backgroundColor: ...,
		textColor: ...,
	},
};

@himanshupathak95
Copy link
Contributor Author

Thanks, @t-hamano for the wonderful suggestions.

I have addressed all your comments. Please let me know if it tests well for you.

Copy link
Contributor

@t-hamano t-hamano left a comment

Choose a reason for hiding this comment

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

LGTM! Works as expected.

d6887a6f4eee9592e69715b2bef89f87.mp4

@t-hamano t-hamano added [Type] Developer Documentation Documentation for developers Storybook Storybook and its stories for components labels Dec 27, 2024
@t-hamano t-hamano merged commit af49fcb into WordPress:trunk Dec 27, 2024
68 checks passed
@github-actions github-actions bot added this to the Gutenberg 20.0 milestone Dec 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Storybook Storybook and its stories for components [Type] Developer Documentation Documentation for developers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants