ComponentsCheckbox

UI component

Checkbox

Checkbox handles simple binary choices with optional labels, helper copy, and validation messaging that fits naturally into forms.

Installation

Install the package in your app.

pnpm add @rapidset/rapidkit

Usage

Import components from the package entrypoint.

import { Checkbox } from '@rapidset/rapidkit';

Examples

Preview the component and copy the snippet.

I agree to the terms

API Reference

Commonly used props at a glance.

PropDescription
nameIdentifies the checkbox in change handlers and form payloads.
checkedKeeps the current state controlled from your form or page state.
onCheckChangeReceives the new boolean value with the field name.
label and titleAdds visible copy for the checkbox and supporting context when needed.
helperText and errorExplains expected input and shows validation feedback below the field.

Accessibility

Checkbox keeps native checkbox semantics and connects label text to the input so users can click or tap the visible copy.

Optional access rules

Optional access props let the field stay hidden or read only without coupling the component to any specific authorization system.