rename feature flag, update JSDoc

vaadin · Jan 20, 2025 · 4f653bd · 4f653bd
1 parent 17b7e4f
commit 4f653bd
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 12 deletions.
diff --git a/packages/menu-bar/src/vaadin-menu-bar-mixin.d.ts b/packages/menu-bar/src/vaadin-menu-bar-mixin.d.ts
@@ -103,16 +103,17 @@ export declare class MenuBarMixinClass {
    * #### Disabled items
    *
    * When an item is disabled, it prevents any user interaction with it, such as
-   * focusing, clicking, or opening a sub-menu.
+   * focusing, clicking, opening a sub-menu, etc. The item is also removed from the
+   * tab order, which may negatively impact accessibility.
    *
    * To improve accessibility, disabled root-level items (menu bar buttons) can be
    * made focusable so that screen readers can reach and properly announce them to
-   * users. Other interactions such as clicks remain disabled. This behavior is
-   * currently experimental and can be enabled with the feature flag:
+   * users, while still preventing clicks. This is currently available as an
+   * experimental enhancement that can be enabled with the following feature flag:
    *
    * ```
    * // Set before any menu bar is attached to the DOM.
-   * window.Vaadin.featureFlags.focusableDisabledComponents = true
+   * window.Vaadin.featureFlags.accessibleDisabledButtons = true;
    * ```
    */
   items: MenuBarItem[];

diff --git a/packages/menu-bar/src/vaadin-menu-bar-mixin.js b/packages/menu-bar/src/vaadin-menu-bar-mixin.js
@@ -81,16 +81,17 @@ export const MenuBarMixin = (superClass) =>
          * #### Disabled items
          *
          * When an item is disabled, it prevents any user interaction with it, such as
-         * focusing, clicking, or opening a sub-menu.
+         * focusing, clicking, opening a sub-menu, etc. The item is also removed from the
+         * tab order, which may negatively impact accessibility.
          *
          * To improve accessibility, disabled root-level items (menu bar buttons) can be
          * made focusable so that screen readers can reach and properly announce them to
-         * users. Other interactions such as clicks remain disabled. This behavior is
-         * currently experimental and can be enabled with the feature flag:
+         * users, while still preventing clicks. This is currently available as an
+         * experimental enhancement that can be enabled with the following feature flag:
          *
          * ```
          * // Set before any menu bar is attached to the DOM.
-         * window.Vaadin.featureFlags.focusableDisabledComponents = true
+         * window.Vaadin.featureFlags.accessibleDisabledButtons = true;
          * ```
          *
          * @type {!Array<!MenuBarItem>}

diff --git a/packages/menu-bar/test/focusable-disabled-buttons.common.js b/packages/menu-bar/test/focusable-disabled-buttons.common.js
@@ -7,11 +7,11 @@ describe('focusable disabled buttons', () => {
 
   before(() => {
     window.Vaadin.featureFlags ??= {};
-    window.Vaadin.featureFlags.focusableDisabledComponents = true;
+    window.Vaadin.featureFlags.accessibleDisabledButtons = true;
   });
 
   after(() => {
-    window.Vaadin.featureFlags.focusableDisabledComponents = false;
+    window.Vaadin.featureFlags.accessibleDisabledButtons = false;
   });
 
   beforeEach(async () => {

diff --git a/test/integration/menu-bar-tooltip.test.js b/test/integration/menu-bar-tooltip.test.js
@@ -355,11 +355,11 @@ describe('menu-bar with tooltip', () => {
   describe('focusable disabled button', () => {
     before(() => {
       window.Vaadin.featureFlags ??= {};
-      window.Vaadin.featureFlags.focusableDisabledComponents = true;
+      window.Vaadin.featureFlags.accessibleDisabledButtons = true;
     });
 
     after(() => {
-      window.Vaadin.featureFlags.focusableDisabledComponents = false;
+      window.Vaadin.featureFlags.accessibleDisabledButtons = false;
     });
 
     beforeEach(async () => {