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

docs: remove mentions of 'experimental' from JSDoc #8549

Merged
merged 1 commit into from
Jan 22, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions packages/button/src/vaadin-button.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -38,16 +38,16 @@ import { ButtonMixin } from './vaadin-button-mixin.js';
*/
declare class Button extends ButtonMixin(ElementMixin(ThemableMixin(ControllerMixin(HTMLElement)))) {
/**
* When set to true, prevents all user interactions with the button such as
* clicking or hovering, and removes the button from the tab order, which
* makes it unreachable via the keyboard navigation.
* When disabled, the button is rendered as "dimmed" and prevents all
* user interactions (mouse and keyboard).
*
* While the default behavior effectively prevents accidental interactions,
* it has an accessibility drawback: screen readers skip disabled buttons
* entirely, and users can't see tooltips that might explain why the button
* is disabled. To address this, an experimental enhancement allows disabled
* buttons to receive focus and show tooltips, while still preventing other
* interactions. This feature can be enabled with the following feature flag:
* Since disabled buttons are not focusable and cannot react to hover
* events by default, it can cause accessibility issues by making them
* entirely invisible to assistive technologies, and prevents the use
* of Tooltips to explain why the action is not available. This can be
* addressed by enabling the feature flag `accessibleDisabledButtons`,
* which makes disabled buttons focusable and hoverable, while still
* preventing them from being triggered:
*
* ```
* // Set before any button is attached to the DOM.
Expand Down
18 changes: 9 additions & 9 deletions packages/button/src/vaadin-button.js
Original file line number Diff line number Diff line change
Expand Up @@ -53,16 +53,16 @@ class Button extends ButtonMixin(ElementMixin(ThemableMixin(ControllerMixin(Poly
static get properties() {
return {
/**
* When set to true, prevents all user interactions with the button such as
* clicking or hovering, and removes the button from the tab order, which
* makes it unreachable via the keyboard navigation.
* When disabled, the button is rendered as "dimmed" and prevents all
* user interactions (mouse and keyboard).
*
* While the default behavior effectively prevents accidental interactions,
* it has an accessibility drawback: screen readers skip disabled buttons
* entirely, and users can't see tooltips that might explain why the button
* is disabled. To address this, an experimental enhancement allows disabled
* buttons to receive focus and show tooltips, while still preventing other
* interactions. This feature can be enabled with the following feature flag:
* Since disabled buttons are not focusable and cannot react to hover
* events by default, it can cause accessibility issues by making them
* entirely invisible to assistive technologies, and prevents the use
* of Tooltips to explain why the action is not available. This can be
* addressed by enabling the feature flag `accessibleDisabledButtons`,
* which makes disabled buttons focusable and hoverable, while still
* preventing them from being triggered:
*
* ```
* // Set before any button is attached to the DOM.
Expand Down
20 changes: 9 additions & 11 deletions packages/menu-bar/src/vaadin-menu-bar-mixin.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -102,18 +102,16 @@ export declare class MenuBarMixinClass {
*
* #### Disabled buttons
*
* When a root-level item (menu bar button) is disabled, it prevents all user
* interactions with it, such as focusing, clicking, opening a sub-menu, etc.
* The button is also removed from tab order, which makes it unreachable via
* the keyboard navigation.
* When disabled, menu bar buttons (root-level items) are rendered
* as "dimmed" and prevent all user interactions (mouse and keyboard).
*
* While the default behavior effectively prevents accidental interactions,
* it has an accessibility drawback: screen readers skip disabled buttons
* entirely, and users can't see tooltips that might explain why the button
* is disabled. To address this, an experimental enhancement allows disabled
* menu bar buttons to receive focus and show tooltips, while still preventing
* other interactions. This feature can be enabled with the following feature
* flag:
* Since disabled buttons are not focusable and cannot react to hover
* events by default, it can cause accessibility issues by making them
* entirely invisible to assistive technologies, and prevents the use
* of Tooltips to explain why the action is not available. This can be
* addressed by enabling the feature flag `accessibleDisabledButtons`,
* which makes disabled buttons focusable and hoverable, while still
* preventing them from being triggered:
*
* ```
* // Set before any menu bar is attached to the DOM.
Expand Down
25 changes: 14 additions & 11 deletions packages/menu-bar/src/vaadin-menu-bar-mixin.js
Original file line number Diff line number Diff line change
Expand Up @@ -80,18 +80,21 @@ export const MenuBarMixin = (superClass) =>
*
* #### Disabled buttons
*
* When a root-level item (menu bar button) is disabled, it prevents all user
* interactions with it, such as focusing, clicking, opening a sub-menu, etc.
* The button is also removed from tab order, which makes it unreachable via
* the keyboard navigation.
* When disabled, menu bar buttons (root-level items) are rendered
* as "dimmed" and prevent all user interactions (mouse and keyboard).
*
* While the default behavior effectively prevents accidental interactions,
* it has an accessibility drawback: screen readers skip disabled buttons
* entirely, and users can't see tooltips that might explain why the button
* is disabled. To address this, an experimental enhancement allows disabled
* menu bar buttons to receive focus and show tooltips, while still preventing
* other interactions. This feature can be enabled with the following feature
* flag:
* Since disabled buttons are not focusable and cannot react to hover
* events by default, it can cause accessibility issues by making them
* entirely invisible to assistive technologies, and prevents the use
* of Tooltips to explain why the action is not available. This can be
* addressed by enabling the feature flag `accessibleDisabledButtons`,
* which makes disabled buttons focusable and hoverable, while still
* preventing them from being triggered:
*
* ```
* // Set before any menu bar is attached to the DOM.
* window.Vaadin.featureFlags.accessibleDisabledButtons = true;
* ```
*
* ```
* // Set before any menu bar is attached to the DOM.
Expand Down