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 BlockTitle Component #67234

Open
wants to merge 5 commits into
base: trunk
Choose a base branch
from

Conversation

SainathPoojary
Copy link
Contributor

Part of #67165

What?

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

Why?

  • Provide visual documentation for the BlockTitle component
  • Enable interactive testing of different block title scenarios
  • Improve 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 block title rendering
    • Block title with maximum length truncation
    • Different block type titles (paragraph, heading, nested blocks)

Screencast

Screen.Recording.2024-11-22.at.6.53.22.PM.mov

Copy link

github-actions bot commented Nov 22, 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.

@SainathPoojary SainathPoojary changed the title Doc: Add Storybook for BlockTitle Storybook: Add stories for BlockTitle Component Nov 22, 2024
@akasunil akasunil added [Type] Developer Documentation Documentation for developers Storybook Storybook and its stories for components labels Nov 25, 2024
@miminari miminari requested review from Mamaduka and ramonjd and removed request for ellatrix November 28, 2024 23:58
@ramonjd ramonjd requested a review from a team November 29, 2024 00:25
@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-52-17.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! If you have any questions about the feedback I left, feel free to ask 👍

Comment on lines 51 to 71
clientId: {
control: {
type: 'select',
labels: {
[ blocks[ 0 ].clientId ]: "Paragraph's Client ID",
[ blocks[ 1 ].clientId ]: "Heading's Client ID",
[ blocks[ 2 ].clientId ]: "Group's Client ID",
},
},
options: [
blocks[ 0 ].clientId,
blocks[ 1 ].clientId,
blocks[ 2 ].clientId,
],
description: 'Client ID of block.',
table: {
type: {
summary: 'string',
},
},
},
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
clientId: {
control: {
type: 'select',
labels: {
[ blocks[ 0 ].clientId ]: "Paragraph's Client ID",
[ blocks[ 1 ].clientId ]: "Heading's Client ID",
[ blocks[ 2 ].clientId ]: "Group's Client ID",
},
},
options: [
blocks[ 0 ].clientId,
blocks[ 1 ].clientId,
blocks[ 2 ].clientId,
],
description: 'Client ID of block.',
table: {
type: {
summary: 'string',
},
},
},
clientId: {
description: 'Client ID of block.',
table: {
type: {
summary: 'string',
},
},
},

Personally, I don't think this control needs to be selectable since this component is only concerned with the title string and it doesn't really matter what the block is.

…ovider

- Replaced BlockEditorProvider with ExperimentalBlockEditorProvider.
- Simplified blocks array to include a single paragraph block.
- Removed unnecessary client ID mappings and control options.
- Cleaned up redundant comments and controls.
@SainathPoojary
Copy link
Contributor Author

Hey @t-hamano,

I’ve implemented the suggested changes as recommended. Let me know if there’s anything else you’d like me to adjust.

Thank you!

Screenshot 2024-12-18 at 11 19 08 AM

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