Toggle
押された状態または押されていない状態を持つボタンです。
ToggleはButton WAI-ARIAデザインパターンのトグルボタンバリアントに準拠しています。aria-pressedを持つネイティブの<button>をレンダリングします。
import { component$, useStyles$ } from '@builder.io/qwik';
import { Toggle } from '@leve-ui/toggle';
import { LuBold } from '@qwikest/icons/lucide';
import styles from './default.css?inline';
export default component$(() => {
useStyles$(styles);
return (
<Toggle.Root class="toggle-default" aria-label="Bold">
<LuBold class="toggle-default-icon" aria-hidden="true" />
</Toggle.Root>
);
});.toggle-default {
display: inline-flex;
align-items: center;
justify-content: center;
width: 36px;
height: 36px;
padding: 0;
border: 1px solid light-dark(#cbd5e1, #ffffff3d);
border-radius: 6px;
background: light-dark(#ffffff, #1b2045);
color: light-dark(#475569, #c9ddf0);
font-family: inherit;
cursor: pointer;
}
.toggle-default:hover {
background: light-dark(#f1f5f9, #ffffff14);
}
/* Pressed */
.toggle-default[data-state="on"] {
border-color: #009dfd;
background: light-dark(#daf0ff, #009dfd26);
color: light-dark(#006ce9, #4cb8ff);
}
.toggle-default:focus-visible {
outline: 2px solid #009dfd;
outline-offset: 2px;
}
.toggle-default[data-disabled] {
opacity: 0.5;
cursor: not-allowed;
}
.toggle-default-icon {
width: 16px;
height: 16px;
}インストール#
個別のパッケージをインストールするか、@leve-ui/coreを使用してすべてのコンポーネントを一度に取得します。
pnpm add @leve-ui/togglenpm install @leve-ui/toggleyarn add @leve-ui/togglebun add @leve-ui/togglepnpm add @leve-ui/corenpm install @leve-ui/coreyarn add @leve-ui/corebun add @leve-ui/core構造#
import { Toggle } from '@leve-ui/toggle'; // or '@leve-ui/core'
<Toggle.Root />
| パーツ | 要素 | 説明 |
|---|---|---|
Toggle.Root | <button> | トグルボタン。押下状態を保持します。 |
例#
Controlled#
bind:pressedはシグナルを使って押下状態を制御します。Toggleの外にあるResetボタンがそれを変更します。
Bold: off
import { component$, useSignal, useStyles$ } from '@builder.io/qwik';
import { Toggle } from '@leve-ui/toggle';
import { LuBold } from '@qwikest/icons/lucide';
import styles from './controlled.css?inline';
export default component$(() => {
useStyles$(styles);
const pressed = useSignal(false);
return (
<div class="toggle-controlled-container">
<div class="toggle-controlled-row">
<Toggle.Root class="toggle-controlled" aria-label="Bold" bind:pressed={pressed}>
<LuBold class="toggle-controlled-icon" aria-hidden="true" />
</Toggle.Root>
<button
type="button"
class="toggle-controlled-reset"
onClick$={() => {
pressed.value = false;
}}
>
Reset
</button>
</div>
<p class="toggle-controlled-status">Bold: {pressed.value ? 'on' : 'off'}</p>
</div>
);
});.toggle-controlled-container {
display: flex;
flex-direction: column;
gap: 12px;
font-family: inherit;
font-size: 14px;
}
.toggle-controlled-row {
display: flex;
align-items: center;
gap: 8px;
}
.toggle-controlled {
display: inline-flex;
align-items: center;
justify-content: center;
width: 36px;
height: 36px;
padding: 0;
border: 1px solid light-dark(#cbd5e1, #ffffff3d);
border-radius: 6px;
background: light-dark(#ffffff, #1b2045);
color: light-dark(#475569, #c9ddf0);
cursor: pointer;
}
.toggle-controlled:hover {
background: light-dark(#f1f5f9, #ffffff14);
}
/* Pressed */
.toggle-controlled[data-state="on"] {
border-color: #009dfd;
background: light-dark(#daf0ff, #009dfd26);
color: light-dark(#006ce9, #4cb8ff);
}
.toggle-controlled:focus-visible {
outline: 2px solid #009dfd;
outline-offset: 2px;
}
.toggle-controlled[data-disabled] {
opacity: 0.5;
cursor: not-allowed;
}
.toggle-controlled-icon {
width: 16px;
height: 16px;
}
/* Secondary button */
.toggle-controlled-reset {
height: 32px;
padding: 0 12px;
border: 1px solid light-dark(#cbd5e1, #ffffff3d);
border-radius: 6px;
background: light-dark(#ffffff, #1b2045);
color: light-dark(#0f172a, #ffffff);
font: inherit;
font-size: 13px;
font-weight: 500;
cursor: pointer;
}
.toggle-controlled-reset:hover {
background: light-dark(#f1f5f9, #ffffff14);
}
.toggle-controlled-reset:focus-visible {
outline: 2px solid #009dfd;
outline-offset: 2px;
}
.toggle-controlled-status {
margin: 0;
font-size: 13px;
color: light-dark(#475569, #c9ddf0);
}Disabled#
disabledはToggleを無効化します。
import { component$, useStyles$ } from '@builder.io/qwik';
import { Toggle } from '@leve-ui/toggle';
import { LuBold } from '@qwikest/icons/lucide';
import styles from './disabled.css?inline';
export default component$(() => {
useStyles$(styles);
return (
<Toggle.Root class="toggle-disabled" aria-label="Bold" disabled>
<LuBold class="toggle-disabled-icon" aria-hidden="true" />
</Toggle.Root>
);
});.toggle-disabled {
display: inline-flex;
align-items: center;
justify-content: center;
width: 36px;
height: 36px;
padding: 0;
border: 1px solid light-dark(#cbd5e1, #ffffff3d);
border-radius: 6px;
background: light-dark(#ffffff, #1b2045);
color: light-dark(#475569, #c9ddf0);
font-family: inherit;
cursor: pointer;
}
.toggle-disabled:hover {
background: light-dark(#f1f5f9, #ffffff14);
}
/* Pressed */
.toggle-disabled[data-state="on"] {
border-color: #009dfd;
background: light-dark(#daf0ff, #009dfd26);
color: light-dark(#006ce9, #4cb8ff);
}
.toggle-disabled:focus-visible {
outline: 2px solid #009dfd;
outline-offset: 2px;
}
.toggle-disabled[data-disabled] {
opacity: 0.5;
cursor: not-allowed;
}
.toggle-disabled-icon {
width: 16px;
height: 16px;
}Pressed#
defaultPressedにより、初期状態でToggleが押された状態になります。
import { component$, useStyles$ } from '@builder.io/qwik';
import { Toggle } from '@leve-ui/toggle';
import { LuBold } from '@qwikest/icons/lucide';
import styles from './pressed.css?inline';
export default component$(() => {
useStyles$(styles);
return (
<Toggle.Root class="toggle-pressed" aria-label="Bold" defaultPressed>
<LuBold class="toggle-pressed-icon" aria-hidden="true" />
</Toggle.Root>
);
});.toggle-pressed {
display: inline-flex;
align-items: center;
justify-content: center;
width: 36px;
height: 36px;
padding: 0;
border: 1px solid light-dark(#cbd5e1, #ffffff3d);
border-radius: 6px;
background: light-dark(#ffffff, #1b2045);
color: light-dark(#475569, #c9ddf0);
font-family: inherit;
cursor: pointer;
}
.toggle-pressed:hover {
background: light-dark(#f1f5f9, #ffffff14);
}
/* Pressed */
.toggle-pressed[data-state="on"] {
border-color: #009dfd;
background: light-dark(#daf0ff, #009dfd26);
color: light-dark(#006ce9, #4cb8ff);
}
.toggle-pressed:focus-visible {
outline: 2px solid #009dfd;
outline-offset: 2px;
}
.toggle-pressed[data-disabled] {
opacity: 0.5;
cursor: not-allowed;
}
.toggle-pressed-icon {
width: 16px;
height: 16px;
}APIリファレンス#
Root#
| Prop | デフォルト | 型 |
|---|---|---|
| defaultPressed | false | boolean トグルが初期状態で押されているかどうか(非制御)。 |
| bind:pressed | – | Signal<boolean> 押下状態を保持するシグナル(制御)。 |
| onPressedChange$ | – | QRL<(pressed: boolean) => void> ユーザーがトグルを押した、または離したときに呼び出されます。 |
すべての<button>属性も受け入れます。
| データ属性 | 値 |
|---|---|
data-leve-toggle | 常に存在 |
data-state | "on" | "off" |
data-disabled | 無効時に存在 |
押下状態はdefaultPressedで非制御、またはbind:pressedで制御できます。onPressedChange$はユーザーがToggleを押したとき、または解除したときに呼び出されます。disabledはネイティブのbutton属性です。
アクセシビリティ#
Button WAI-ARIAデザインパターン(トグルボタン)に準拠しています。
Toggle.Rootはaria-pressed("true"または"false")を持つ<button type="button">です。無効化されている場合はネイティブのdisabled属性を使用するため、フォーカスできません。- そのテキストコンテンツがアクセシブルな名前になります。アイコンのみのToggleの場合は、
aria-labelを渡し、アイコンをaria-hidden="true"で非表示にします。 - 状態に応じてラベルを変更しないでください(例えば、「Mute」のままにし、「Unmute」に切り替えないでください)。状態は
aria-pressedによって伝達されます。 - Toolbarの内部では、トグルはツールバーのroving tabindexに参加します。矢印キーでフォーカスが移動し、ツールバー内でタブストップとなるアイテムは1つだけになります。
キーボード操作#
| キー | 説明 |
|---|---|
Space | Toggleを押す、または解除します。 |
Enter | Toggleを押す、または解除します。 |