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 DateFormatPicker Component #67290

Merged
merged 4 commits into from
Dec 18, 2024

Conversation

SainathPoojary
Copy link
Contributor

Part of #67165

What?

This PR adds Storybook stories for the DateFormatPicker component to improve component documentation and testability.

Why?

  • To provide clear visual documentation for the DateFormatPicker component.
  • To enable interactive testing for various DateFormatPicker scenarios.
  • To enhance the development experience for Block Editor components.

Testing Instructions

  1. Run npm run storybook:dev
  2. Open Storybook at http://localhost:50240/
  3. Verify the following stories are present and functioning:
    • Default rendering of the DateFormatPicker.
    • DateFormatPicker with the format set to null.
    • DateFormatPicker with defaultFormat set to empty string.

Screencast

Screen.Recording.2024-11-26.at.9.35.24.AM.mov

Copy link

github-actions bot commented Nov 26, 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: SainathPoojary <[email protected]>
Co-authored-by: t-hamano <[email protected]>

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

@akasunil akasunil added [Type] Developer Documentation Documentation for developers Storybook Storybook and its stories for components labels Nov 28, 2024
@miminari miminari requested review from noisysocks and mirka and removed request for ellatrix November 29, 2024 00:03
- Removed `useEffect` and streamlined state handling.
- Improved parameter descriptions and documentation.
- Removed unused story variants for clarity.
@SainathPoojary
Copy link
Contributor Author

Hi @t-hamano ,

I have made the necessary changes to the PR based on the general feedback provided. Additionally, I reviewed other similar PRs with requested changes and implemented those adjustments as well. Could you kindly take a look at the PR when you have a moment?

Thank you!

2024-12-11.00-28-15.mp4

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! I only have two small suggestions, but everything works as expected 👍

@SainathPoojary
Copy link
Contributor Author

Thank you, @t-hamano, for the review! I have implemented the changes as you suggested.

image

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!

P.S. Thanks to your efforts, I was able to find two issues with this component that we will address in a follow-up 👍

  • The browser's default border is applied to the fieldset element
  • There is no space between the example text and the "Choose a format" control

date-format-picker

@t-hamano t-hamano merged commit 287d653 into WordPress:trunk Dec 18, 2024
63 checks passed
@github-actions github-actions bot added this to the Gutenberg 20.0 milestone Dec 18, 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.

3 participants