@loomidev/checkbox

<loomi-checkbox> — a themeable checkbox available in the full loomi palette. Form-associated: submits value (default "on") under name when checked.

npm install @loomidev/checkbox lit

import "@loomidev/checkbox";

Basic Usage

<loomi-checkbox>I agree to the terms</loomi-checkbox>

Labels can include HTML, since the label is the default slot:

<loomi-checkbox>I agree to the <a href="/terms">terms and conditions</a></loomi-checkbox>

Checked and disabled, by default:

<loomi-checkbox checked>Checked by default</loomi-checkbox>
<loomi-checkbox disabled>Disabled</loomi-checkbox>
<loomi-checkbox checked disabled>Checked and disabled</loomi-checkbox>

Colored Checkboxes

Any loomi color works: primary secondary info success error warning gray success warning error primary.

<loomi-checkbox color="error" checked>Red</loomi-checkbox>
<loomi-checkbox color="yellow" checked>Yellow</loomi-checkbox>
<loomi-checkbox color="success" checked>Green</loomi-checkbox>
<loomi-checkbox color="error" checked>Error</loomi-checkbox>
<loomi-checkbox color="warning" checked>Warning</loomi-checkbox>
<loomi-checkbox color="success" checked>Success</loomi-checkbox>
<loomi-checkbox color="warning" checked>Orange</loomi-checkbox>
<loomi-checkbox color="success" checked>Violet</loomi-checkbox>
<loomi-checkbox color="primary" checked>Indigo</loomi-checkbox>
<loomi-checkbox color="error" checked>Fuchsia</loomi-checkbox>

The color is applied through a per-instance --loomi-accent property, so a global theme override (e.g. redefining --loomi-error-600 at :root) applies automatically — no need to touch the component.

Checkboxes and Forms

Give the checkbox a name and value so the right thing is submitted. If the box is left unchecked, its name is omitted from the form payload entirely (standard checkbox behavior).

<loomi-checkbox name="notify_me" value="1">Send me weekly newsletters</loomi-checkbox>

Accessibility

For the library-wide baseline, see Foundations — Accessibility.

Responsive behavior

For the shared container and viewport rules, see Foundations — Responsive behavior.

Dark mode

For theme activation, token overrides, and contrast guidance, see Foundations — Dark mode.

Attributes

| Attribute | Default | Description | | ------------- | --------- | ---------------------------------------------- | | name | (blank) | Submitted with the form when checked. | | value | on | Submitted value. | | label | (blank) | Label text (or use the default slot for HTML). | | checked | false | Checked state. (boolean, reflected) | | disabled | false | Disable the checkbox. (boolean) | | color | primary | Active color (any loomi color). | | no-clearing | false | Remove the default bottom margin. (boolean) |

Part: box.

Slots

| Slot | Description | | ----------- | ------------------------------------ | | (default) | Content placed inside the component. |

Events

| Event | Description | | -------- | --------------------------------------------- | | change | Fired when the value is committed or changed. |

Full Example

<loomi-checkbox
  name="tnc"
  value="yes"
  color="error"
  checked
>
  I agree to the terms and conditions
</loomi-checkbox>

Framework integration

<loomi-checkbox> is a standard custom element, so the browser can use it in plain HTML, Blade, React, Vue, Angular, Svelte, Astro, and most other frameworks. The important beginner rule is: install the package, import it once before the tag is rendered, then write the Loomi tag in your template.

Where to run commands

Run install commands from the app where you want to use this component. That means the folder that contains that app's package.json. Do not run these install commands from packages/checkbox unless you are editing LoomiUI itself.

cd /path/to/your-app
npm install @loomidev/checkbox lit

If you are contributing to LoomiUI itself, first move to the top-level components folder. That is where the main package.json for all packages lives, and pnpm --filter ... commands should be run from there:

cd /path/to/your-copy-of-loomiui/components
pnpm --filter @loomidev/checkbox build
pnpm --filter @loomidev/checkbox typecheck

Choose your framework

Use the CDN version for prototypes, documentation pages, or a quick reproduction. The import map tells the browser where to find Lit, which Loomi components use internally.

<script type="importmap">
  { "imports": { "lit": "https://esm.sh/[email protected]", "lit/": "https://esm.sh/[email protected]/" } }
</script>
<script type="module" src="https://esm.sh/@loomidev/checkbox"></script>

<loomi-checkbox name="terms" value="yes" label="I accept the terms"></loomi-checkbox>

In Vite, Webpack, Parcel, Rollup, or a framework build pipeline, install the package and import it once in your main app JavaScript file. After that, you can use the Loomi tag anywhere in your app.

import "@loomidev/checkbox";

Because this is a form-capable component, give it a name when it should submit with a native <form>. Read its value with new FormData(form).get("the-name") just like you would for a built-in input.

Run the install command from your Laravel project root, then import the component in resources/js/app.js. If your project uses Laravel Vite, npm run dev and npm run build should also be run from the Laravel project root.

cd /path/to/your-laravel-app
npm install @loomidev/checkbox lit
npm run dev

// resources/js/app.js
import "@loomidev/checkbox";

<loomi-checkbox name="terms" value="yes" label="I accept the terms"></loomi-checkbox>

React can render Loomi tags directly. If you are on React 18, or if you need to pass arrays, objects, or functions, use a ref and assign those values after the component mounts.

import "@loomidev/checkbox";

export function LoomiExample() {
  return (
    <loomi-checkbox name="terms" value="yes" label="I accept the terms"></loomi-checkbox>
  );
}

If TypeScript does not recognize the Loomi tag in JSX, add it to your app's JSX type declarations.

Import the package in the component that uses it, or once in your main Vue file. Vue templates can use Loomi tags directly. For arrays, objects, or functions, pass the value as a JavaScript property instead of as plain text.

<script setup>
import "@loomidev/checkbox";
</script>

<template>
  <loomi-checkbox name="terms" value="yes" label="I accept the terms"></loomi-checkbox>
</template>

If Vue warns that the tag is an unknown component, configure compilerOptions.isCustomElement for tags that start with loomi- in your Vite or Vue config.

Import the package once and tell Angular to allow custom HTML tags with CUSTOM_ELEMENTS_SCHEMA. For NgModule apps, add the schema to the module instead of the standalone component.

// app.component.ts
import { CUSTOM_ELEMENTS_SCHEMA, Component } from "@angular/core";
import "@loomidev/checkbox";

@Component({
  selector: "app-root",
  standalone: true,
  schemas: [CUSTOM_ELEMENTS_SCHEMA],
  template: `
    <loomi-checkbox name="terms" value="yes" label="I accept the terms"></loomi-checkbox>
  `,
})
export class AppComponent {}

Svelte can import the package inside a component script. Astro can import it in the frontmatter of the page or layout where the tag appears.

<script>
  import "@loomidev/checkbox";
</script>

<loomi-checkbox name="terms" value="yes" label="I accept the terms"></loomi-checkbox>

---
import "@loomidev/checkbox";
---

<loomi-checkbox name="terms" value="yes" label="I accept the terms"></loomi-checkbox>

Server-side rendering notes

Frameworks such as Next.js, Nuxt, SvelteKit, and Astro sometimes render HTML on the server before browser-only code runs. If your framework complains, move the Loomi import to client-side code. In Next.js, that usually means a component with "use client"; in Nuxt, it often means a .client.ts plugin.

Dependencies

• @loomidev/core
• @loomidev/theme