@loomidev/toggle

<loomi-toggle> — a themeable toggle/switch (a checkbox, spiced up). Form-associated: submits value (default "on") under name when checked.

npm install @loomidev/toggle lit

import "@loomidev/toggle";

Basic Usage

<loomi-toggle></loomi-toggle>

Labels

The label can sit on either side of the switch — default is left, flip it with label-position="right". Clicking the label toggles the component.

<loomi-toggle>Send me quarterly newsletters</loomi-toggle>
<loomi-toggle label-position="right">Send me quarterly newsletters</loomi-toggle>

By default the toggle is an inline element, so several can sit side by side. Set justified to make it fill its parent container, with the label and switch pushed to opposite ends.

<loomi-toggle justified>Send me quarterly newsletters</loomi-toggle>

Thin and Thicker Bars

Three bar thicknesses are available — thin (Android-style), thick (default), and thicker (iOS-style).

<loomi-toggle bar="thin">Thin</loomi-toggle>
<loomi-toggle bar="thick">Thick (default)</loomi-toggle>
<loomi-toggle bar="thicker">Thicker</loomi-toggle>

Checked and Disabled

<loomi-toggle checked>I am checked at birth</loomi-toggle>
<loomi-toggle disabled>I am disabled</loomi-toggle>
<loomi-toggle checked disabled>Checked and disabled</loomi-toggle>

Different Colors

Any loomi color works for the active/checked state: primary secondary info success error warning gray.

<loomi-toggle color="error" checked>Red</loomi-toggle>
<loomi-toggle color="info" checked>Info</loomi-toggle>
<loomi-toggle color="error" checked>Error</loomi-toggle>
<loomi-toggle color="warning" checked>Warning</loomi-toggle>
<loomi-toggle color="success" checked>Success</loomi-toggle>
<loomi-toggle color="warning" checked>Orange</loomi-toggle>

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) | Clickable label (or use the default slot). | | label-position | left | left | right | | checked | false | Checked state. (boolean, reflected) | | disabled | false | Disable the toggle. (boolean) | | justified | false | Spread label + switch to fill the parent. (boolean) | | bar | thick | thin | thick | thicker | | color | primary | Active color (any loomi color). | | no-clearing | false | Remove the default bottom margin. (boolean) |

Parts: track, knob.

Slots

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

Events

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

Full Example

<loomi-toggle
  name="subscribe"
  color="success"
  label-position="right"
  bar="thin"
>
  Send me quarterly newsletters
</loomi-toggle>

Framework integration

<loomi-toggle> 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/toggle unless you are editing LoomiUI itself.

cd /path/to/your-app
npm install @loomidev/toggle 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/toggle build
pnpm --filter @loomidev/toggle 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/toggle"></script>

<loomi-toggle name="notifications" label="Email notifications" checked></loomi-toggle>

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/toggle";

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/toggle lit
npm run dev

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

<loomi-toggle name="notifications" label="Email notifications" checked></loomi-toggle>

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/toggle";

export function LoomiExample() {
  return (
    <loomi-toggle name="notifications" label="Email notifications" checked></loomi-toggle>
  );
}

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/toggle";
</script>

<template>
  <loomi-toggle name="notifications" label="Email notifications" checked></loomi-toggle>
</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/toggle";

@Component({
  selector: "app-root",
  standalone: true,
  schemas: [CUSTOM_ELEMENTS_SCHEMA],
  template: `
    <loomi-toggle name="notifications" label="Email notifications" checked></loomi-toggle>
  `,
})
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/toggle";
</script>

<loomi-toggle name="notifications" label="Email notifications" checked></loomi-toggle>

---
import "@loomidev/toggle";
---

<loomi-toggle name="notifications" label="Email notifications" checked></loomi-toggle>

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