Skip to content

Commit 8ecb96e

Browse files
feat(toggle): change required prop description
1 parent 1cf303f commit 8ecb96e

File tree

2 files changed

+5
-3
lines changed

2 files changed

+5
-3
lines changed

core/src/components.d.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3281,7 +3281,7 @@ export namespace Components {
32813281
*/
32823282
"name": string;
32833283
/**
3284-
* If `true`, the user must fill in a value before submitting a form.
3284+
* If true, screen readers will announce it as a required field. This property works only for accessibility purposes, it will not prevent the form from submitting if the value is invalid.
32853285
*/
32863286
"required": boolean;
32873287
/**
@@ -8160,7 +8160,7 @@ declare namespace LocalJSX {
81608160
*/
81618161
"onIonFocus"?: (event: IonToggleCustomEvent<void>) => void;
81628162
/**
8163-
* If `true`, the user must fill in a value before submitting a form.
8163+
* If true, screen readers will announce it as a required field. This property works only for accessibility purposes, it will not prevent the form from submitting if the value is invalid.
81648164
*/
81658165
"required"?: boolean;
81668166
/**

core/src/components/toggle/toggle.tsx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,9 @@ export class Toggle implements ComponentInterface {
109109
@Prop() alignment?: 'start' | 'center';
110110

111111
/**
112-
* If `true`, the user must fill in a value before submitting a form.
112+
* If true, screen readers will announce it as a required field. This property
113+
* works only for accessibility purposes, it will not prevent the form from
114+
* submitting if the value is invalid.
113115
*/
114116
@Prop() required = false;
115117

0 commit comments

Comments
 (0)