Documentation

Checkbox

A control that allows the user to toggle between checked and not checked.

Examples

import { Checkbox } from 'kalki-design'

<Checkbox></Checkbox>

Installation

npx kalki-design add checkbox

Usage

import { Checkbox } from 'kalki-design'

export default function Example() {
  return <Checkbox />
}

API Reference

NameTypeDefaultDescription
NamelabelTypestringDefaultDescriptionLabel rendered next to the checkbox.
NamehelperTextTypestringDefaultDescriptionSupplementary text below the label.
NameerrorTypestring | booleanDefaultDescriptionError state message or styling.
NamedisabledTypebooleanDefaultfalseDescriptionPrevents interaction.