DocsComponentsForms
Checkbox
React example follows below.
ts
import { Checkbox } from "@grassroot/ui-react"; const [agree, setAgree] = React.useState(true); <Checkbox label="New build" checked={agree} onChange={(e) => setAgree(e.target.checked)} /><Checkbox label="Rescue job" defaultChecked /><Checkbox label="Unavailable option" disabled />ts
<script setup lang="ts">import { ref } from "vue";import { Checkbox } from "@grassroot/ui-vue"; const agree = ref(true);</script> <template> <Checkbox label="New build" :checked="agree" @change="agree = e.target.checked" /> <Checkbox label="Rescue job" default-checked /> <Checkbox label="Unavailable option" disabled /></template>ts
import { Component, signal } from "@angular/core";import { GrassrootCheckbox } from "@grassroot/ui-angular"; @Component({ selector: "app-example", standalone: true, imports: [GrassrootCheckbox], template: ` <grassroot-checkbox label="New build" [checked]="agree()" (change)="agree.set(e.target.checked)" /> <grassroot-checkbox label="Rescue job" [defaultChecked]="true" /> <grassroot-checkbox label="Unavailable option" [disabled]="true" /> `,})export class ExampleComponent { readonly agree = signal(true);}ts
<script lang="ts"> import { Checkbox } from "@grassroot/ui-svelte"; let agree = $state(true);</script> <Checkbox label="New build" checked={agree} onChange={(e) => agree = e.target.checked}/><Checkbox label="Rescue job" defaultChecked /><Checkbox label="Unavailable option" disabled />ts
import { createSignal } from "solid-js";import { Checkbox } from "@grassroot/ui-solid"; export function Example() { const [agree, setAgree] = createSignal(true); return ( <> <Checkbox label="New build" checked={agree()} onChange={(e) => setAgree(e.target.checked)} /> <Checkbox label="Rescue job" defaultChecked /> <Checkbox label="Unavailable option" disabled /> </> );}Installation
bash
pnpm dlx grassroot add ui/checkboxbash
npx grassroot@latest add ui/checkboxbash
yarn dlx grassroot add ui/checkboxbash
bunx grassroot add ui/checkboxAPI Reference
| Prop | Type | Default |
|---|---|---|
label | React.ReactNode | — |
toneBrand colour of the checked fill. | Tone | undefined | "accent" |