Skip to content

Commit

Permalink
polish JSDoc
Browse files Browse the repository at this point in the history
  • Loading branch information
vursen committed Jan 17, 2025
1 parent 51648a2 commit 1610766
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 12 deletions.
11 changes: 5 additions & 6 deletions packages/button/src/vaadin-button.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -38,13 +38,12 @@ import { ButtonMixin } from './vaadin-button-mixin.js';
*/
declare class Button extends ButtonMixin(ElementMixin(ThemableMixin(ControllerMixin(HTMLElement)))) {
/**
* When true, disables all user interactions with the button such as
* clicking, focusing, etc.
* When set to true, prevents any user interaction with the button
* such as clicking, focusing, etc.
*
* However, for better accessibility, it's strongly recommended to keep
* disabled buttons focusable so that screen readers can reach and properly
* announce them to users. This behavior is currently available behind the
* feature flag:
* To improve accessibility, disabled buttons can be made focusable
* so that screen readers can reach and properly announce them to
* users. This behavior can be enabled with the feature flag:
*
* ```
* // Enable before any button is attached to the DOM.
Expand Down
11 changes: 5 additions & 6 deletions packages/button/src/vaadin-button.js
Original file line number Diff line number Diff line change
Expand Up @@ -53,13 +53,12 @@ class Button extends ButtonMixin(ElementMixin(ThemableMixin(ControllerMixin(Poly
static get properties() {
return {
/**
* When true, disables all user interactions with the button such as
* clicking, focusing, etc.
* When set to true, prevents any user interaction with the button
* such as clicking, focusing, etc.
*
* However, for better accessibility, it's strongly recommended to keep
* disabled buttons focusable so that screen readers can reach and properly
* announce them to users. This behavior is currently available behind the
* feature flag:
* To improve accessibility, disabled buttons can be made focusable
* so that screen readers can reach and properly announce them to
* users. This behavior can be enabled with the feature flag:
*
* ```
* // Enable before any button is attached to the DOM.
Expand Down

0 comments on commit 1610766

Please sign in to comment.