From 14e2933831f00267758318c8c1742b417c137b1c Mon Sep 17 00:00:00 2001 From: Frederik Bolding Date: Thu, 20 Jun 2024 14:33:21 +0200 Subject: [PATCH] Tweak docs --- .../snaps-sdk/src/jsx/components/form/Checkbox.ts | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-) diff --git a/packages/snaps-sdk/src/jsx/components/form/Checkbox.ts b/packages/snaps-sdk/src/jsx/components/form/Checkbox.ts index 591e9f7ca9..9023a4a51e 100644 --- a/packages/snaps-sdk/src/jsx/components/form/Checkbox.ts +++ b/packages/snaps-sdk/src/jsx/components/form/Checkbox.ts @@ -3,11 +3,9 @@ import { createSnapComponent } from '../../component'; /** * The props of the {@link Checkbox} component. * - * @property name - The name of the input field. This is used to identify the - * input field in the form data. - * @property type - The type of the input field. Defaults to `text`. - * @property value - The value of the input field. - * @property placeholder - The placeholder text of the input field. + * @property name - The name of the checkbox. This is used to identify the + * state in the form data. + * @property value - Whether the checkbox is checked or not. */ export type CheckboxProps = { name: string; @@ -20,10 +18,10 @@ const TYPE = 'Checkbox'; * A checkbox component, which is used to create a checkbox. * * @param props - The props of the component. - * @param props.name - The name of the checkboxd. This is used to identify the + * @param props.name - The name of the checkbox. This is used to identify the * state in the form data. - * @param props.value - The value of the input field. - * @returns An input element. + * @param props.value - Whether the checkbox is checked or not. + * @returns A checkbox element. * @example * */