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.

Sign up for GitHub

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

Jump to bottom

Patterns: Add descriptions to user-created patterns #55244

Closed
carolinan opened this issue Oct 11, 2023 · 7 comments
Closed

Patterns: Add descriptions to user-created patterns #55244

carolinan opened this issue Oct 11, 2023 · 7 comments
Assignees
@carolinan
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?

Pattern descriptions add important information for any user who is not able to see the blocks that are included in a pattern, or any user who needs the information in a different format than the preview.

There is no way for a user to add a description to user-created patterns.

What is your proposed solution?

Perhaps the excerpt field could be re-purposed as a description for this post type.
@carolinan carolinan added [Focus] Accessibility (a11y) Changes that impact accessibility and need corresponding review (e.g. markup changes). [Feature] Patterns A collection of blocks that can be synced (previously reusable blocks) or unsynced labels Oct 11, 2023
@richtabor
Copy link
Member

I agree this could be nice, especially as patterns keep evolving.

Something like this:

patterns-inspector

@jordesign jordesign added the [Type] Enhancement A suggestion for improvement. label Oct 11, 2023
@jordesign jordesign changed the title Add descriptions to user-created patterns Patterns: Add descriptions to user-created patterns Oct 11, 2023
@richtabor richtabor removed the [Focus] Accessibility (a11y) Changes that impact accessibility and need corresponding review (e.g. markup changes). label Dec 14, 2023
@richtabor richtabor added this to Polish Dec 14, 2023
@richtabor richtabor moved this to Todo in Patterns Dec 14, 2023
@richtabor richtabor moved this to Needs development in Polish Dec 14, 2023
@richtabor
Copy link
Member

@youknowriad how would you see this best reconciling for patterns, related to the ongoing consolidation efforts in #57049

@youknowriad
Copy link
Contributor

I'm going to be working on the excerpt field soon to show it similarly in site and post editors. If the post type supports excerpts then it will show up.

@youknowriad
Copy link
Contributor

This PR #57096 adds the excerpt panel to the site editor. So if we enable excerpt support for wp_block post type as a follow-up, the panel will show up.

@richtabor
Copy link
Member

So if we enable excerpt support for wp_block post type as a follow-up, the panel will show up.

@carolinan do you mind taking that? 🙇

@carolinan carolinan self-assigned this Apr 8, 2024
@carolinan
Copy link
Contributor Author

Adding the excerpt support is easy enough, but I found a bug with the Site Editor Pattern screen. There is a regression where there is no way for a screen-reader to actually read out the description to the user, no matter if "grid" or "list" is selected.

@carolinan carolinan mentioned this issue Apr 8, 2024
Merged
@unscripted unscripted mentioned this issue Apr 17, 2024
Open
@richtabor
Copy link
Member

Noting that this is supported now. The UI could be much better (it's not quite discoverable).

CleanShot 2024-04-25 at 12 54 02

@github-project-automation github-project-automation bot moved this from Todo to Done in Patterns Apr 25, 2024
@github-project-automation github-project-automation bot moved this from Needs development to Done in Polish Apr 25, 2024
pento referenced this issue in WordPress/wordpress-develop May 23, 2024
@SergeyBiryukov
Editor: Add excerpt support to the wp_block post type.
5dc0cc0 
The purpose is to enable using the excerpt as a description for user-created patterns on the Site Editor Pattern screens.

This commit backports the original PR from Gutenberg repository:
* [[https://github.com/WordPress/gutenberg/pull/60549|#60549: [Data Views] User patterns: Use excerpt as description]]

Reference: [[https://github.com/WordPress/gutenberg/issues/55244|#55244: Patterns: Add descriptions to user-created patterns]].

Follow-up to [44146], [44150], [50835], [56030].

Props poena, ntsekouras, krupalpanchal.
Fixes #61250.

git-svn-id: https://develop.svn.wordpress.org/trunk@58184 602fd350-edb4-49c9-b593-d223f7449a82
markjaquith referenced this issue in markjaquith/WordPress May 23, 2024
@SergeyBiryukov
Editor: Add excerpt support to the wp_block post type.
0d6e7f3 
The purpose is to enable using the excerpt as a description for user-created patterns on the Site Editor Pattern screens.

This commit backports the original PR from Gutenberg repository:
* [[https://github.com/WordPress/gutenberg/pull/60549|#60549: [Data Views] User patterns: Use excerpt as description]]

Reference: [[https://github.com/WordPress/gutenberg/issues/55244|#55244: Patterns: Add descriptions to user-created patterns]].

Follow-up to [44146], [44150], [50835], [56030].

Props poena, ntsekouras, krupalpanchal.
Fixes #61250.
Built from https://develop.svn.wordpress.org/trunk@58184


git-svn-id: http://core.svn.wordpress.org/trunk@57647 1a063a9b-81f0-0310-95a4-ce76da25c4cd
github-actions bot referenced this issue in gilzow/wordpress-performance May 23, 2024
@SergeyBiryukov
Editor: Add excerpt support to the wp_block post type.
5eacb21 
The purpose is to enable using the excerpt as a description for user-created patterns on the Site Editor Pattern screens.

This commit backports the original PR from Gutenberg repository:
* [[https://github.com/WordPress/gutenberg/pull/60549|#60549: [Data Views] User patterns: Use excerpt as description]]

Reference: [[https://github.com/WordPress/gutenberg/issues/55244|#55244: Patterns: Add descriptions to user-created patterns]].

Follow-up to [44146], [44150], [50835], [56030].

Props poena, ntsekouras, krupalpanchal.
Fixes #61250.
Built from https://develop.svn.wordpress.org/trunk@58184


git-svn-id: https://core.svn.wordpress.org/trunk@57647 1a063a9b-81f0-0310-95a4-ce76da25c4cd
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@carolinan carolinan

Labels
[Feature] Patterns A collection of blocks that can be synced (previously reusable blocks) or unsynced [Type] Enhancement A suggestion for improvement.
Projects
Polish
Status: Done
Patterns
Status: Done
Milestone
No milestone
Development

No branches or pull requests
4 participants
@youknowriad @richtabor @jordesign @carolinan