Skip to content

docs(Checkbox): fix isChecked description (#202) #229

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.

Sign up for GitHub

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

Open
Kaustubh0505 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs(Checkbox): fix isChecked description (#202) #229

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 5 additions & 1 deletion ui/elements/Form/Checkbox/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,11 @@ export interface CheckboxProps {
onChange?: (event: React.ChangeEvent<HTMLInputElement>) => void;

/**
* Indicates if the checkbox is checked initially.
* Controls the current checked state of the checkbox.
*
* This is a controlled prop. You must manage this value in the parent component,
* and update it based on user interaction via the `onChange` callback.
Comment on lines +61 to +64

@MihirSachdeva MihirSachdeva May 22, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

need not be too verbose here

Suggested change
* Controls the current checked state of the checkbox.
*
* This is a controlled prop. You must manage this value in the parent component,
* and update it based on user interaction via the `onChange` callback.
* Controls the current checked state of the checkbox.
*

*
* @default false
*/
isChecked?: boolean;
Expand Down