@app-studio/components

Checkbox

A customizable checkbox form element with optional label and various views.

Import

import { Checkbox } from '@app-studio/components';

New to the library? Complete installation and provider setup first.

Interactive examples

Try the component, then open Code to copy the complete example.

Loading preview…

import React, { useState } from 'react';
import { Checkbox } from '@app-studio/components';
import { Text, Vertical } from 'app-studio';

export function CheckboxExample() {
  const [selected, setSelected] = useState(false);
  return (
    <Vertical gap={12}>
      <Checkbox
        label="Include release notes"
        isChecked={selected}
        onChange={setSelected}
      />
      <Text role="status">
        Release notes {selected ? 'included' : 'excluded'}.
      </Text>
    </Vertical>
  );
}

Props

Required props are marked below. A dash indicates an unspecified default. Design system configuration can override implementation defaults.

Scroll horizontally to see every column.

Checkbox
Prop	Type	Default	Description
`id`	`string`	`—`	See the type and source declaration for this property.Source
`icon`	View type `string \| number \| bigint \| boolean \| React.ReactElement<unknown, string \| React.JSXElementConstructor<any>> \| Iterable<React.ReactNode> \| React.ReactPortal \| Promise<string \| number \| bigint \| boolean \| React.ReactPortal \| React.ReactElement<unknown, string \| React.JSXElementConstructor<any>> \| Iterable<React.ReactNode> \| null \| undefined> \| null`	`—`	Icon rendered alongside the content.Source
`error`	`any`	`false`	Error state — usually a string for the error message, or a boolean toggle.Source
`name`	`string`	`—`	Field name used by forms and Formik bindings.Source
`label`	`string`	`—`	Visible label rendered alongside the input. Form-library wrappers (Switch, TextField, Checkbox, …) consume this. Not a native HTML attribute on <input>, but conventionally part of the form-control prop surface.Source
`isChecked`	`boolean`	`—`	Current checked state. Update it from the onChange callback to keep the control controlled.Source
`defaultIsSelected`	`boolean`	`false`	Initial checked state when uncontrolled.Source
`isReadOnly`	`boolean`	`false`	Keeps the value visible without allowing edits.Source
`isDisabled`	`boolean`	`false`	Disables user interaction.Source
`isIndeterminate`	`boolean`	`false`	See the type and source declaration for this property.Source
`labelPosition`	`"left" \| "right"` `"left""right"`	`'right'`	Position of the visible label relative to the control.Source
`onChange`	`((checked: boolean) => void)`	`—`	Called with the new field value. Check the signature for the exact payload.Source
`onValueChange`	`((checked: boolean) => void)`	`—`	Called when the selected value changes.Source
`views`	`CheckboxStyles`	`{ checkbox: {}, label: {} }`	Style overrides for the named internal parts.Source
`size`	`Size` `"sm""md""lg""xs""xl"`	`'md'`	Size preset for the component.Source
`shadow`	`ViewProps \| Shadow \| Elevation`	`{}`	Shadow or elevation styling.Source
`infoText`	`string`	`—`	Additional explanatory text displayed with the control.Source

Common inherited styling props (7)

Scroll horizontally to see every column.

Checkbox inherited
Prop	Type	Default	Description
`onClick`	`any`	`—`	Called when the user activates the component.
`media`	`Record<string, CssProps>`	`—`	See the type and source declaration for this property.
`as`	`keyof JSX.IntrinsicElements` `"symbol""object""slot""style""title""pattern""form""animate""clipPath""filter""marker""mask""a""abbr""address""area""article""aside""audio""b""base""bdi""bdo""big""blockquote""body""br""button""canvas""caption""center""cite""code""col""colgroup""data""datalist""dd""del""details""dfn""dialog""div""dl""dt""em""embed""fieldset""figcaption""figure""footer""h1""h2""h3""h4""h5""h6""head""header""hgroup""hr""html""i""iframe""img""input""ins""kbd""keygen""label""legend""li""link""main""map""mark""menu""menuitem""meta""meter""nav""noindex""noscript""ol""optgroup""option""output""p""param""picture""pre""progress""q""rp""rt""ruby""s""samp""search""script""section""select""small""source""span""strong""sub""summary""sup""table""template""tbody""td""textarea""tfoot""th""thead""time""tr""track""u""ul""var""video""wbr""webview""svg""animateMotion""animateTransform""circle""defs""desc""ellipse""feBlend""feColorMatrix""feComponentTransfer""feComposite""feConvolveMatrix""feDiffuseLighting""feDisplacementMap""feDistantLight""feDropShadow""feFlood""feFuncA""feFuncB""feFuncG""feFuncR""feGaussianBlur""feImage""feMerge""feMergeNode""feMorphology""feOffset""fePointLight""feSpecularLighting""feSpotLight""feTile""feTurbulence""foreignObject""g""image""line""linearGradient""metadata""mpath""path""polygon""polyline""radialGradient""rect""set""stop""switch""text""textPath""tspan""use""view"`	`—`	See the type and source declaration for this property.
`themeMode`	`"light" \| "dark"` `"light""dark"`	`—`	See the type and source declaration for this property.
`_hover`	`string \| CssProps`	`—`	See the type and source declaration for this property.
`_active`	`string \| CssProps`	`—`	See the type and source declaration for this property.
`_focus`	`string \| CssProps`	`—`	See the type and source declaration for this property.

For shared layout, color, and responsive properties, read Styling & composition and Responsive layouts. Additional native element attributes depend on the target platform.

Usage guidance

Give controls a visible label or an accessible name, and verify keyboard interaction. See Accessibility.
For controlled inputs, update the value from the callback shown in the props table. Keep application state in your component or form library.
These previews run in the browser. Check React Native setup for platform requirements and differences.