@softheon/armature 21.16.1 → 21.18.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@softheon/armature",
-  "version": "21.16.1",
+  "version": "21.18.0",
   "dependencies": {
     "tslib": "^2.8.1"
   },

package/types/softheon-armature.d.ts

@@ -1243,6 +1243,22 @@ interface NavPanelSubnode {
 interface NavNodeBadgeConfig {
     /** Badge type - 'notification' for red badges, 'status' for primary badges */
     type: 'notification' | 'status';
+    /**
+     * Accessible name for a 'notification' badge.
+     * @description Required for notification badges so the `role="status"` region has an accessible name.
+     * @note To interpolate the badge count use a translation key containing `{{count}}`,
+     * e.g. `'armature.badge.notification-aria'`. Literal strings are not interpolated.
+     * @example 'armature.badge.notification-aria'
+     * @example
+     * ```json
+     * "armature": {
+     *   "badge": {
+     *     "notification-aria": "{{count}} unread notifications"
+     *   }
+     * }
+     * ```
+     */
+    notificationAriaLabel?: string;
 }
 /**
  * Available badge data
@@ -3845,11 +3861,21 @@ declare class SofBadgeComponent implements OnInit {
     isNotificationType: boolean;
     /** The icon class- this should be a Phosphor Icons class, type bold */
     iconClass: string;
-    /** The badge aria label */
+    /**
+     * The badge aria label
+     * @description Required when `isNotificationType` is true, so the notification's
+     * `role="status"` region has an accessible name. Supports `{{count}}` interpolation
+     * of `badgeText` when the value is a translation key.
+     * @note Not used for standard badges, whose visible text is their accessible name.
+     */
     badgeAria: string;
-    /** The icon aria label */
+    /**
+     * The icon aria label
+     * @deprecated Not used. The badge icon is always decorative (`aria-hidden`).
+     * Name the badge via `badgeAria` instead.
+     */
     iconAria: string;
-    /** The icon aria label */
+    /** The badge tooltip data */
     tooltipData: BadgeTooltipData;
     /**
      * Any logic related to ag grid cell renderer data can be added here
@@ -3932,7 +3958,18 @@ interface ButtonBadgeConfig {
  * Removes role="menu" from Material Menu elements.
  * Removes role="menuitem" from Material Menu Item elements.
  * (per wcag audit)
-*/
+ *
+ * A panel stripped of `role` is no longer a menu, so the attributes that only
+ * make sense for a menu are removed with it:
+ * - the trigger's `aria-controls`, which then points at a role-less `div`;
+ *   axe reports `aria-controls` + `aria-haspopup` on such a target as an
+ *   invalid ARIA attribute value, even when the id resolves.
+ * - the panel's `aria-label` / `aria-labelledby`, which are prohibited on a
+ *   role-less element. The menu items carry their own text, so the panel
+ *   label is redundant once the menu role is gone.
+ *
+ * Shared by `sof-dropdown-button`, `sof-utility-button` and `sof-header`.
+ */
 declare const removeMenuRole: () => void;
 
 /**