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

Improvements to Header pattern category to better clarify and guide usage #40116

Closed
annezazu opened this issue Apr 6, 2022 · 6 comments · Fixed by #44203
Closed

Improvements to Header pattern category to better clarify and guide usage #40116

annezazu opened this issue Apr 6, 2022 · 6 comments · Fixed by #44203
Assignees
Labels
[Feature] Pattern Directory The Pattern Directory, a place to find patterns [Feature] Patterns A collection of blocks that can be synced (previously reusable blocks) or unsynced [Type] Discussion For issues that are high-level and not yet ready to implement. [Type] Enhancement A suggestion for improvement.

Comments

@annezazu
Copy link
Contributor

annezazu commented Apr 6, 2022

What problem does this address?

In a discussion in post status slack, Brin Wilson and I discussed the current categorization of Header Patterns in the Inserter, pattern directory, etc. It became clear that the current Header category including both items related to a Header for your site and something more akin to Headings proved confusing. In general, there are two problems:

  • Inconsistency in how patterns are prioritized in the Inserter based on editor. Site editor prioritizes patterns for site headers, post editor prioritizes more of a style of "heading" patterns, and template editor matches the post editor despite it likely needing to match the experience of the site editor in prioritizing header patterns.
  • Grouping together of both more classically thought of Headers for the top of a site and more "heading" style sections all within the same category. These serve different purposes so it feels odd to include both.

Here's a quick video discussing this:

patterns.mov

What is your proposed solution?

A few ideas!

  • Consider creating a new category for Headings to separate out patterns that don't carry the same meaning as Header. This will also help as patterns are integrated into the experience more. For example, I might have a more Heading like pattern that I don't want to show up when someone is looking for Headers when adding a new template part.
  • Create consistency in the Inserter experience by having the Template Editor match the Site Editor experience.

In my opinion, I think it makes sense to branch off a new category of patterns that reflects more of the Heading style patterns where you might want to draw attention to/differentiate a section. This seems like it will most set folks up for success in using these various patterns correctly as well as align nicely with how work is underway to integrate patterns into the experience of doing things like adding a new template part or creating a new template from scratch.

@annezazu annezazu added [Type] Enhancement A suggestion for improvement. [Feature] Patterns A collection of blocks that can be synced (previously reusable blocks) or unsynced [Type] Discussion For issues that are high-level and not yet ready to implement. [Feature] Pattern Directory The Pattern Directory, a place to find patterns labels Apr 6, 2022
@mtias
Copy link
Member

mtias commented Jul 8, 2022

Would "Titles" or "Headings & Titles" be better to disambiguate?

@annezazu
Copy link
Contributor Author

annezazu commented Sep 6, 2022

With the implementation of bundled Header and Footer patterns #43157, this issue becomes more important to address IMO. For example, right now the Header patterns are buried beneath the other patterns categorized also as "header" as pointed out by @beafialho in the original PR:

headers.mov

This isn't ideal and it's clear some category separation needs to happen.

@annezazu
Copy link
Contributor Author

annezazu commented Sep 8, 2022

As a next step to move this forward, I'm not sure what technically needs to be done here but essentially we want to end up with a new Titles category to house the current "header" patterns and for the "header" category to now contain truly header specific content like these bundled patterns #43157 We'll also need to update the pattern directory appropriately: https://wordpress.org/patterns/categories/header/

cc @mcsf @ryelle for technical thoughts and to see if either of you can help make this happen ahead of 6.1 :)

mcsf added a commit that referenced this issue Sep 15, 2022
Fixes #40116

With this new category, we can clariy the classification of patterns as
"Headers". Category "Headers" pertains to global patterns meant to sit
at the top of a page, while category "Headings & Titles" pertains to
typically visually distinctive elements that help structure the contents
of a page.
@github-actions github-actions bot added the [Status] In Progress Tracking issues with work in progress label Sep 15, 2022
@mcsf
Copy link
Contributor

mcsf commented Sep 15, 2022

cc @carolinan, who has also contributed in this area (e.g. adding a new category for Footer patterns in t56416).


I can't comment on the pattern directory parts. For the rest, we can easily add a pattern category, both here in Gutenberg in the compat layer and in Core. I opened #44203, have a look.

@ryelle
Copy link
Contributor

ryelle commented Sep 15, 2022

We can easily add a new "Headings & Titles" category to the Pattern Directory. It wouldn't change any existing patterns though, anything currently tagged "Header" would stay that way. If that's a problem, we could probably write a script to update them, it would just take a little more time.

@mtias
Copy link
Member

mtias commented Sep 15, 2022

I think we should create a Hero or Banners category and move everything we used to have into it and leave the actual new headers in Headers.

mcsf added a commit that referenced this issue Sep 16, 2022
Fixes #40116

With this new category, we can clariy the classification of patterns as
"Headers". Category "Headers" pertains to global patterns meant to sit
at the top of a page, while category "Headings & Titles" pertains to
typically visually distinctive elements that help structure the contents
of a page.
mcsf added a commit that referenced this issue Sep 19, 2022
* Block Patterns: Add category for Headings & Titles

Fixes #40116

With this new category, we can clariy the classification of patterns as
"Headers". Category "Headers" pertains to global patterns meant to sit
at the top of a page, while category "Headings & Titles" pertains to
typically visually distinctive elements that help structure the contents
of a page.

* Rename to "Banners"
ockham pushed a commit that referenced this issue Sep 19, 2022
* Block Patterns: Add category for Headings & Titles

Fixes #40116

With this new category, we can clariy the classification of patterns as
"Headers". Category "Headers" pertains to global patterns meant to sit
at the top of a page, while category "Headings & Titles" pertains to
typically visually distinctive elements that help structure the contents
of a page.

* Rename to "Banners"
@priethor priethor removed the [Status] In Progress Tracking issues with work in progress label May 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Feature] Pattern Directory The Pattern Directory, a place to find patterns [Feature] Patterns A collection of blocks that can be synced (previously reusable blocks) or unsynced [Type] Discussion For issues that are high-level and not yet ready to implement. [Type] Enhancement A suggestion for improvement.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants