Skip to content

feat: add icon-only button position - #9

Open
rsanchez-beapi wants to merge 7 commits into
BeAPI:developfrom
rsanchez-beapi:feature/button-icon-only
Open

rsanchez-beapi wants to merge 7 commits into
BeAPI:developfrom
rsanchez-beapi:feature/button-icon-only

Conversation

@rsanchez-beapi

@rsanchez-beapi rsanchez-beapi commented Nov 18, 2026 •

Copy link
Copy Markdown

Summary

Adds a third icon position, Icon only, as specified in the OMNES design system (Redmine #92801).

  • Editor: a new "Icon only" option in the Icon panel. In this mode the label is removed from the canvas and edited from a required "Label (screen readers)" field in the sidebar; an error notice shows when it is empty.
  • Front end: the wrapper gets blockparty-button-icon--only; the .wp-block-button__label span stays in the markup and is visually hidden, so the link/button keeps an accessible name.
  • Accessibility: icons rendered inside buttons now get aria-hidden="true" (all positions), since the text label always provides the accessible name. A contributor-set icon aria-label is therefore no longer announced inside buttons.
  • Backward compatibility: saved markup for existing buttons (no icon, left, right) is byte-identical to v1.0.0, so no deprecated entry is needed. An E2E test loads v1.0.0 markup and asserts no invalid block.
  • Shared class logic in get-button-icon-class-names.js (used by edit and save), label plain-text helpers in button-label-plain-text.js.
  • French translations, README, readme.txt and CHANGELOG updated.

Test plan

  • npm run test:unit:js (28 passed)
  • npm run test:php (21 passed, 1 pre-existing skip)
  • npm run test:e2e (6 passed, including icon-only editor/front and v1.0.0 markup validity)
  • npm run lint:css, wp-scripts lint-js src (no errors; the jest is not defined errors in tests/js/ pre-exist on main)
  • Manual: switch a button left → icon only → right, save, reload, no block validation error
  • Manual: VoiceOver announces "link, " on an icon-only button

🤖 Generated with Claude Code


Note

Medium Risk
Changes editor UX, saved block classes, front-end HTML/ARIA for buttons, and relies on required sidebar labels for icon-only accessibility.

Overview
Adds a third icon layout, Icon only, so editors can show just the icon while the button link still has an accessible name from the label text.

In the block editor, Icon only joins Left/Right in the Icon panel. The visible label is no longer edited in the canvas; a required Label (screen readers) field in the sidebar drives text, with validation when it is empty. Clicking the nested icon keeps core/button selected (pointer-events: none on the inner icon block in the editor). Class names for edit and save are centralized in get-button-icon-class-names.js (including blockparty-button-icon--only).

On the front end, icon-only buttons keep .wp-block-button__label in the markup and hide it visually via style.scss. IconBlockRenderer now sets aria-hidden="true" on .wp-block-icon inside buttons so icons are decorative and the label is the sole announced name.

Docs, French strings, and unit/E2E coverage (icon-only editor/frontend, legacy v1.0.0 markup validity, plain-text label helpers) are updated.

Reviewed by Cursor Bugbot for commit 29fe793. Bugbot is set up for automated code reviews on this repo. Configure here.

firestar300 and others added 6 commits October 20, 2026 17:31
Add a third icon position, "Icon only": the label stays in the markup,
visually hidden, so links and buttons keep an accessible name. In the
editor the label is hidden from the canvas and edited from a required
sidebar field, with an error notice when it is empty.

Icons rendered inside buttons now get aria-hidden="true" since the text
label always provides the accessible name.

Saved markup for existing buttons (no icon, left, right) is unchanged,
so no deprecation is needed; an E2E test loads v1.0.0 markup to check it.

Refs Redmine #92801

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Cursor Bugbot has reviewed your changes and found 1 potential issue.

Fix All in Cursor

❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.

Reviewed by Cursor Bugbot for commit 834fc58. Configure here.

Comment thread src/extend-core-button/edit.jsx Resolved
- Ensure clicking the icon in the icon-only button keeps the core/button selected, allowing access to the Icon panel and required screen-reader label.
- Update styles to prevent pointer events on icon-only buttons.
- Adjust editor behavior to correctly render the label for screen readers while keeping it visually hidden.

This enhances the usability and accessibility of the icon-only button feature.

@cedric07 cedric07 left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Salut Raphaël 👋

Belle PR : le périmètre est propre, la rétrocompatibilité du markup v1.0.0 est couverte par un test E2E, la logique de classes est mutualisée entre edit et save, et le label masqué reste bien dans le DOM. Le point remonté par Bugbot (clic qui sélectionnait l'icône interne) est traité par le pointer-events: none du 2e commit.

J'ai quelques retours, détaillés en commentaires inline :

À corriger avant merge

  1. Régression possible sur les contenus existants : le aria-hidden="true" est ajouté côté serveur au rendu, donc il s'applique immédiatement à tous les boutons déjà publiés. En v1.0.0, la seule façon de faire un bouton « icône seule » était de laisser le libellé vide et de renseigner l'aria-label de l'icône. Ces boutons vont perdre leur nom accessible (lien vide, RGAA 6.2). Je propose de ne masquer l'icône que si le libellé du bouton contient du texte.

À discuter / améliorer
2. Focus clavier perdu dans l'éditeur en mode icône seule : après fermeture du popover de lien, richTextRef.current vaut null et le focus repart sur body.
3. Libellé vide enregistrable : la notice d'erreur ne bloque rien. Ça peut suffire, mais un lockPostSaving (ou au minimum le fallback PHP du point 1) éviterait de publier un bouton sans nom.
4. Perte de mise en forme : passer par le TextControl écrase le rich text (gras, et surtout un éventuel <span lang>, utile pour le RGAA 8.7). Si c'est voulu, une mention dans le README suffit.
5. pointer-events: none sur l'icône : ça règle la sélection, mais l'icône n'est plus atteignable qu'au clavier ou par la vue en liste. Et son aria-label reste éditable dans son inspecteur alors qu'il est désormais ignoré dans un bouton : ça mériterait une help ou de masquer le champ dans ce contexte.

Détails

  • Les deux cases « Manual » du test plan (switch gauche → icône seule → droite, VoiceOver) ne sont pas cochées. Ça vaut le coup de les faire avant merge, surtout la VoiceOver.
  • Le nom de branche suit feature/… alors que la convention agence est feat/… (ou issue/92801 puisqu'il y a un ticket Redmine). Ça ne bloque pas la PR, c'est juste pour les prochaines.

Generated by Claude Code

return $html;
}

$processor->set_attribute( 'aria-hidden', 'true' );

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Régression sur les boutons v1.0.0 sans libellé

Ce filtre tourne au rendu, donc sur tout le contenu déjà publié, sans réenregistrement. Un bouton v1.0.0 avec icône + libellé vide + aria-label sur l'icône (le seul moyen de faire une icône seule avant cette PR) devient un lien sans nom accessible.

Suggestion : ne poser aria-hidden que si le libellé a du texte. Le plus simple est probablement de le faire dans leave_button_with_icon_context() (le filtre render_block_core/button), où tu as le HTML complet du bouton : tu vérifies que .wp-block-button__label n'est pas vide (par exemple avec trim( wp_strip_all_tags( … ) ) sur le contenu du span, ou avec WP_HTML_Processor), puis tu poses aria-hidden sur .wp-block-icon. Sinon, tu laisses l'icône telle quelle. Ça règle aussi le cas « icône seule + libellé vide » (point 3 de la review).

Un test PHPUnit sur ce cas serait bienvenu.


Generated by Claude Code

/>
);

const isIconOnly = iconPosition === ICON_POSITION_ONLY;

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

En mode icône seule, le RichText n'est pas monté, donc richTextRef.current vaut null dans les onClose et onRemove du popover de lien (l. 283 et 313). Le ?. évite l'erreur, mais le focus clavier repart sur body après la fermeture du popover.

Proposition : un fallback sur le wrapper du bloc, par exemple ( richTextRef.current ?? popoverAnchor )?.focus(). popoverAnchor est déjà l'élément de useBlockProps, et il est focusable.


Generated by Claude Code

__nextHasNoMarginBottom
onChange={ ( value ) => {
setAttributes( {
text: plainTextToButtonLabel(

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Note : chaque frappe remplace text par du texte brut échappé. Toute la mise en forme existante est donc perdue dès la première modification (gras, italique, mais surtout un <span lang="en">, qui compte pour le RGAA 8.7). Ça se comprend vu le besoin, mais il faudrait au moins le documenter (README) pour que ce ne soit pas une surprise quand on repasse en gauche ou droite.


Generated by Claude Code

} }
/>
{ isLabelMissing && (
<Notice

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

La notice signale l'erreur mais n'empêche pas d'enregistrer. Si on veut une vraie contrainte, on peut passer par lockPostSaving( 'blockparty-button-icon-label' ) / unlockPostSaving de core/editor, avec une clé unique par clientId. Attention dans ce cas à l'éditeur de site, où core/editor se comporte différemment.

Ce n'est pas bloquant pour moi si on ajoute le fallback PHP (pas de aria-hidden quand le libellé est vide) : au pire, l'aria-label de l'icône prend le relais.


Generated by Claude Code

Comment thread src/editor.scss
}

&.blockparty-button-icon--only .block-editor-block-list__block {
pointer-events: none;

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Ça corrige bien le point Bugbot 👍. Effets de bord à garder en tête :

  • l'icône interne n'est plus sélectionnable à la souris, seulement par la vue en liste ou au clavier ;
  • son inspecteur expose toujours un aria-label qui est maintenant ignoré au front, dans toutes les positions, à cause du aria-hidden. Un contributeur peut le remplir sans effet.

On pourrait ajouter un texte d'aide, ou masquer ce champ via un filtre editor.BlockEdit quand le core/icon a pour parent un core/button avec hasIcon. Pense aussi à répondre au thread Bugbot et à le résoudre.


Generated by Claude Code

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants