Skip to content

Commit 16256ea

Browse files
authored
docs: prefer label attribute for checkbox and radio-button (#2944)
1 parent 228d4bc commit 16256ea

8 files changed

Lines changed: 20 additions & 20 deletions

File tree

‎packages/checkbox-group/src/vaadin-checkbox-group.d.ts‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,9 @@ export interface CheckboxGroupEventMap extends HTMLElementEventMap, CheckboxGrou
3232
*
3333
* ```html
3434
* <vaadin-checkbox-group label="Preferred language of contact:">
35-
* <vaadin-checkbox value="en">English</vaadin-checkbox>
36-
* <vaadin-checkbox value="fr">Français</vaadin-checkbox>
37-
* <vaadin-checkbox value="de">Deutsch</vaadin-checkbox>
35+
* <vaadin-checkbox value="en" label="English"></vaadin-checkbox>
36+
* <vaadin-checkbox value="fr" label="Français"></vaadin-checkbox>
37+
* <vaadin-checkbox value="de" label="Deutsch"></vaadin-checkbox>
3838
* </vaadin-checkbox-group>
3939
* ```
4040
*

‎packages/checkbox-group/src/vaadin-checkbox-group.js‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@ import { Checkbox } from '@vaadin/checkbox/src/vaadin-checkbox.js';
1717
*
1818
* ```html
1919
* <vaadin-checkbox-group label="Preferred language of contact:">
20-
* <vaadin-checkbox value="en">English</vaadin-checkbox>
21-
* <vaadin-checkbox value="fr">Français</vaadin-checkbox>
22-
* <vaadin-checkbox value="de">Deutsch</vaadin-checkbox>
20+
* <vaadin-checkbox value="en" label="English"></vaadin-checkbox>
21+
* <vaadin-checkbox value="fr" label="Français"></vaadin-checkbox>
22+
* <vaadin-checkbox value="de" label="Deutsch"></vaadin-checkbox>
2323
* </vaadin-checkbox-group>
2424
* ```
2525
*

‎packages/checkbox/src/vaadin-checkbox.d.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ export interface CheckboxEventMap extends HTMLElementEventMap, CheckboxCustomEve
3232
* `<vaadin-checkbox>` is an input field representing a binary choice.
3333
*
3434
* ```html
35-
* <vaadin-checkbox>I accept the terms and conditions</vaadin-checkbox>
35+
* <vaadin-checkbox label="I accept the terms and conditions"></vaadin-checkbox>
3636
* ```
3737
*
3838
* ### Styling

‎packages/checkbox/src/vaadin-checkbox.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ import { ThemableMixin } from '@vaadin/vaadin-themable-mixin/vaadin-themable-mix
1717
* `<vaadin-checkbox>` is an input field representing a binary choice.
1818
*
1919
* ```html
20-
* <vaadin-checkbox>I accept the terms and conditions</vaadin-checkbox>
20+
* <vaadin-checkbox label="I accept the terms and conditions"></vaadin-checkbox>
2121
* ```
2222
*
2323
* ### Styling

‎packages/radio-group/src/vaadin-radio-button.d.ts‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,9 @@ export interface RadioButtonEventMap extends HTMLElementEventMap, RadioButtonCus
2727
*
2828
* ```html
2929
* <vaadin-radio-group label="Travel class">
30-
* <vaadin-radio-button value="economy">Economy</vaadin-radio-button>
31-
* <vaadin-radio-button value="business">Business</vaadin-radio-button>
32-
* <vaadin-radio-button value="firstClass">First Class</vaadin-radio-button>
30+
* <vaadin-radio-button value="economy" label="Economy"></vaadin-radio-button>
31+
* <vaadin-radio-button value="business" label="Business"></vaadin-radio-button>
32+
* <vaadin-radio-button value="firstClass" label="First Class"></vaadin-radio-button>
3333
* </vaadin-radio-group>
3434
* ```
3535
*

‎packages/radio-group/src/vaadin-radio-button.js‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@ import { ThemableMixin } from '@vaadin/vaadin-themable-mixin/vaadin-themable-mix
1919
*
2020
* ```html
2121
* <vaadin-radio-group label="Travel class">
22-
* <vaadin-radio-button value="economy">Economy</vaadin-radio-button>
23-
* <vaadin-radio-button value="business">Business</vaadin-radio-button>
24-
* <vaadin-radio-button value="firstClass">First Class</vaadin-radio-button>
22+
* <vaadin-radio-button value="economy" label="Economy"></vaadin-radio-button>
23+
* <vaadin-radio-button value="business" label="Business"></vaadin-radio-button>
24+
* <vaadin-radio-button value="firstClass" label="First Class"></vaadin-radio-button>
2525
* </vaadin-radio-group>
2626
* ```
2727
*

‎packages/radio-group/src/vaadin-radio-group.d.ts‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,9 @@ export interface RadioGroupEventMap extends HTMLElementEventMap, RadioGroupCusto
3333
*
3434
* ```html
3535
* <vaadin-radio-group label="Travel class">
36-
* <vaadin-radio-button value="economy">Economy</vaadin-radio-button>
37-
* <vaadin-radio-button value="business">Business</vaadin-radio-button>
38-
* <vaadin-radio-button value="firstClass">First Class</vaadin-radio-button>
36+
* <vaadin-radio-button value="economy" label="Economy"></vaadin-radio-button>
37+
* <vaadin-radio-button value="business" label="Business"></vaadin-radio-button>
38+
* <vaadin-radio-button value="firstClass" label="First Class"></vaadin-radio-button>
3939
* </vaadin-radio-group>
4040
* ```
4141
*

‎packages/radio-group/src/vaadin-radio-group.js‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@ import { RadioButton } from './vaadin-radio-button.js';
1818
*
1919
* ```html
2020
* <vaadin-radio-group label="Travel class">
21-
* <vaadin-radio-button value="economy">Economy</vaadin-radio-button>
22-
* <vaadin-radio-button value="business">Business</vaadin-radio-button>
23-
* <vaadin-radio-button value="firstClass">First Class</vaadin-radio-button>
21+
* <vaadin-radio-button value="economy" label="Economy"></vaadin-radio-button>
22+
* <vaadin-radio-button value="business" label="Business"></vaadin-radio-button>
23+
* <vaadin-radio-button value="firstClass" label="First Class"></vaadin-radio-button>
2424
* </vaadin-radio-group>
2525
* ```
2626
*

0 commit comments

Comments
 (0)