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 PlainText Storybook stories #67341

Merged
merged 5 commits into from
Dec 20, 2024

Conversation

SainathPoojary
Copy link
Contributor

Part of #67165

What?

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

Why?

  • To provide clear visual documentation for the PlainText component.
  • To enable interactive testing for various PlainText 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 PlainText component.
    • PlainText with a long text value to test auto-grow functionality.
    • PlainText with a custom class name applied.

Screenshots or screencast

Screen.Recording.2024-11-27.at.2.47.13.PM.mov

- Add Default, LongText, and WithClassName stories
- Configure meta for PlainText component
@SainathPoojary SainathPoojary marked this pull request as ready for review November 27, 2024 09:35
Copy link

github-actions bot commented Nov 27, 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 a review from youknowriad November 29, 2024 00:11
@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-38-57.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 noticed that this component is missing JSDoc. If you don't mind, could you also add that? See the comment here.

- Enhance prop descriptions
- Fix import order in storybook.
@SainathPoojary
Copy link
Contributor Author

Hi @t-hamano,

I’ve made the suggested changes and added JSDoc as recommended. Please review and let me know if anything else is needed.

2024-12-18.10-48-54.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 update!

One last thing: I would be happy if we could unify the following three descriptions of the value prop and the onbChange prop.

  • JSDoc
  • README
  • Storybook

It would probably be best to unify them as follows, but what do you think?

  • props.value: String value of the textarea.
  • props.onChange: Function called when the text value changes.

@SainathPoojary
Copy link
Contributor Author

Agreed, @t-hamano. The proposed wording is clear and concise, and I’ll update it accordingly.

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 👍

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