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

Patterns: Display descriptions in the UI #55242

Open
carolinan opened this issue Oct 11, 2023 · 5 comments
Open

Patterns: Display descriptions in the UI #55242

carolinan opened this issue Oct 11, 2023 · 5 comments
Labels
[Feature] Patterns A collection of blocks that can be synced (previously reusable blocks) or unsynced [Type] Enhancement A suggestion for improvement.

Comments

@carolinan
Copy link
Contributor

What problem does this address?

Patterns have an optional Description parameter. When patterns register a description, it is visually hidden, only available for screen reader users.

If there are many patterns registered, there can often be subtle differences between them, and it would benefit all users to have the description visible.
Not having the description leads to needing to make the pattern titles as descriptive as possible.

What is your proposed solution?

Display pattern descriptions in selected places in the UI.

@carolinan carolinan added [Type] Enhancement A suggestion for improvement. [Feature] Patterns A collection of blocks that can be synced (previously reusable blocks) or unsynced labels Oct 11, 2023
@richtabor
Copy link
Member

Maybe if we had detail views of the locked theme patterns, then it could show on the details view. I don't think we should have details view unless we can edit them like you can a theme's template parts.

CleanShot 2023-10-11 at 11 48 15

@unscripted
Copy link
Member

I've had two clients ask me about pattern descriptions in the last week. Both were during training sessions where they wanted more detail than the title offered.

This was requested for patterns we include in the theme and the patterns they create (#55244).

cc: @WordPress/outreach.

@annezazu
Copy link
Contributor

This might be neat to have as part of data views work where folks can optionally show descriptions similar to toggling on/off other fields.

@richtabor
Copy link
Member

where folks can optionally show descriptions similar to toggling on/off other fields.

CleanShot 2024-04-25 at 12 56 04

Yup, could be a field here.

@richtabor
Copy link
Member

It would be nice to also show the description when a pattern is inserted, instead of the default description:

CleanShot 2024-04-25 at 12 55 25

This description here does not render for the pattern's block card:

CleanShot 2024-04-25 at 12 54 02

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Feature] Patterns A collection of blocks that can be synced (previously reusable blocks) or unsynced [Type] Enhancement A suggestion for improvement.
Projects
No open projects
Status: No status
Development

No branches or pull requests

4 participants