fix(types): default checkbox value prop type to boolean closes #144

formwerkjs · Mar 2, 2025 · bb01448 · bb01448
1 parent c6e1853
commit bb01448
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 3 deletions.
diff --git a/.changeset/strange-shoes-compete.md b/.changeset/strange-shoes-compete.md
@@ -0,0 +1,5 @@
+---
+'@formwerk/core': patch
+---
+
+fix(types): default checkbox value prop type to boolean
diff --git a/packages/core/src/useCheckbox/useCheckbox.spec.ts b/packages/core/src/useCheckbox/useCheckbox.spec.ts
@@ -24,7 +24,7 @@ const CustomBase: string = `
   </div>
 `;
 
-const createCheckbox = (props: CheckboxProps, template = InputBase): Component => {
+function createCheckbox<TValue = boolean>(props: CheckboxProps<TValue>, template = InputBase): Component {
   return defineComponent({
     template,
     inheritAttrs: false,
@@ -37,7 +37,7 @@ const createCheckbox = (props: CheckboxProps, template = InputBase): Component =
       };
     },
   });
-};
+}
 
 describe('has no a11y violations', () => {
   test('with input as base element', async () => {

diff --git a/packages/core/src/useCheckbox/useCheckbox.ts b/packages/core/src/useCheckbox/useCheckbox.ts
@@ -15,7 +15,7 @@ import { useFormField, exposeField, FormField } from '../useFormField';
 import { FieldTypePrefixes } from '../constants';
 import { useInputValidity } from '../validation';
 
-export interface CheckboxProps<TValue = string> {
+export interface CheckboxProps<TValue = boolean> {
   /**
    * The name/path of the checkbox field.
    */