Skip to content

Commit b423ae7

Browse files
feat(checkbox): change required prop description
1 parent 4af07f3 commit b423ae7

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
@@ -644,7 +644,7 @@ export namespace Components {
644644
*/
645645
"name": string;
646646
/**
647-
* If `true`, the user must fill in a value before submitting a form.
647+
* 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.
648648
*/
649649
"required": boolean;
650650
"setFocus": () => Promise<void>;
@@ -5440,7 +5440,7 @@ declare namespace LocalJSX {
54405440
*/
54415441
"onIonFocus"?: (event: IonCheckboxCustomEvent<void>) => void;
54425442
/**
5443-
* If `true`, the user must fill in a value before submitting a form.
5443+
* 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.
54445444
*/
54455445
"required"?: boolean;
54465446
/**

core/src/components/checkbox/checkbox.tsx

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

101101
/**
102-
* If `true`, the user must fill in a value before submitting a form.
102+
* If true, screen readers will announce it as a required field. This property
103+
* works only for accessibility purposes, it will not prevent the form from
104+
* submitting if the value is invalid.
103105
*/
104106
@Prop() required = false;
105107

0 commit comments

Comments
 (0)