Skip to content

Adding block description settings in preference#68435

Closed
benazeer-ben wants to merge 2 commits intoWordPress:trunkfrom
benazeer-ben:block-description-settings
Closed

Adding block description settings in preference#68435
benazeer-ben wants to merge 2 commits intoWordPress:trunkfrom
benazeer-ben:block-description-settings

Conversation

@benazeer-ben
Copy link
Contributor

What?

Fixes: #42197

How?

Added a toggle to the Appearance section in Preferences modal, which allows you to turn off block descriptions.

Testing Instructions

  • Go to WP admin dashboard.
  • Open any page/post in edit mode.
  • Add any block, check its description in the editor sidebar.
  • Open Preference modal from the Options.
  • Turn off/on the Show block descriptions option from Appearance section.
  • Check the block description based on the settings and verify.

Screenshots or screencast

Screenshare.-.2024-12-31.5_17_44.PM.mp4

@github-actions
Copy link

github-actions bot commented Dec 31, 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: benazeer-ben <benazeer@git.wordpress.org>
Co-authored-by: carolinan <poena@git.wordpress.org>
Co-authored-by: Mamaduka <mamaduka@git.wordpress.org>
Co-authored-by: t-hamano <wildworks@git.wordpress.org>
Co-authored-by: richtabor <richtabor@git.wordpress.org>

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

@akasunil akasunil added [Type] Enhancement A suggestion for improvement. [Package] Preferences /packages/preferences labels Jan 6, 2025
@benazeer-ben
Copy link
Contributor Author

Hi Team,

Whenever you have some time, could you please review this PR? I’d really appreciate your feedback.

Thanks in advance!

cc: @t-hamano @carolinan

Copy link
Contributor

@carolinan carolinan left a comment

Choose a reason for hiding this comment

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

Thank you for the ping.
I have tested the functionality and it is working as described.
The text strings; the label and description, also feel suitable to me.

I am personally not sure about this use case. It also hides the description of patterns and block variations, like the explanation for the grid and stack group block variations.
But since it was requested by @richtabor I will assume he still wants this change to go in.

@t-hamano
Copy link
Contributor

Thanks for the PR, @benazeer-ben!

I am personally not sure about this use case.

To be honest, I'm not sure how useful this feature would be 😅 Either way, we'll need some design feedback.

@WordPress/gutenberg-design

Furthermore, if we do move forward with this feature, we might want to consider whether we need a similar setup for the widget editor, which would need to implement the same functionality separately.

Copy link
Member

@Mamaduka Mamaduka left a comment

Choose a reason for hiding this comment

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

I think we should be careful when introducing similar preferences and keep WP's "Decisions, not options" philosophy in mind.

  • If most block descriptions aren't helpful in the sidebar, maybe we should remove them.
  • Alternatively, we could hide them when simplifying editing is enabled.

Thanks again for contributing, @benazeer-ben! For similar enhancement requests, I recommend requesting initial feedback on the issue before moving to implementation.

@benazeer-ben
Copy link
Contributor Author

I think we should be careful when introducing similar preferences and keep WP's "Decisions, not options" philosophy in mind.

Thanks for the info, @Mamaduka. I will ensure to request initial feedback on any enhancement issue before proceeding with implementation.

Should I close this PR? Please guide me on the next steps.

@Mamaduka
Copy link
Member

Yes, let's close this for now. Thanks again, @benazeer-ben!

@Mamaduka Mamaduka closed this Mar 11, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

[Package] Preferences /packages/preferences [Type] Enhancement A suggestion for improvement.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add setting to turn off block descriptions

5 participants