Checkbox チェックボックス

LhCheckbox は単独の boolean 値をサポートし、LhCheckboxGroup は複数オプションの配列値をサポートします。

単独で使用

読んで同意しました

vue

<script setup lang="ts">
import { ref } from 'vue'
import { LhCheckbox } from '@lh-ui/vue3'

const accepted = ref(false)
</script>

<template>
  <LhCheckbox v-model="accepted" label="読んで同意しました" />
</template>

vue

<script>
import { LhCheckbox } from '@lh-ui/vue3'

export default {
  components: { LhCheckbox },
  data() {
    return {
      accepted: false
    }
  }
}
</script>

<template>
  <LhCheckbox v-model="accepted" label="読んで同意しました" />
</template>

グループで使用

VueReactSvelte

vue

<script setup lang="ts">
import { ref } from 'vue'
import { LhCheckbox, LhCheckboxGroup } from '@lh-ui/vue3'

const selected = ref(['vue'])
</script>

<template>
  <LhCheckboxGroup v-model="selected" name="framework">
    <LhCheckbox value="vue" label="Vue" />
    <LhCheckbox value="react" label="React" />
    <LhCheckbox value="svelte" label="Svelte" />
  </LhCheckboxGroup>
</template>

vue

<script>
import { LhCheckbox, LhCheckboxGroup } from '@lh-ui/vue3'

export default {
  components: { LhCheckbox, LhCheckboxGroup },
  data() {
    return {
      selected: ['vue']
    }
  }
}
</script>

<template>
  <LhCheckboxGroup v-model="selected" name="framework">
    <LhCheckbox value="vue" label="Vue" />
    <LhCheckbox value="react" label="React" />
    <LhCheckbox value="svelte" label="Svelte" />
  </LhCheckboxGroup>
</template>

カスタムテーマ

チェックボックスにカスタムのテーマカラーを適用します。

オプション 1オプション 2

vue

<script setup lang="ts">
import { ref } from 'vue'
import { LhConfigProvider, LhCheckbox, LhCheckboxGroup } from '@lh-ui/vue3'

const selected = ref(['option1'])
const cerblueTheme = {
  'primary-color': '#2B4C7C',
  'primary-color-hover': '#3D649E',
  'primary-color-bg': '#E8EDF3',
}
</script>

<template>
  <LhConfigProvider :theme-vars="cerblueTheme">
    <LhCheckboxGroup v-model="selected">
      <LhCheckbox value="option1" label="オプション 1" />
      <LhCheckbox value="option2" label="オプション 2" />
    </LhCheckboxGroup>
  </LhConfigProvider>
</template>

vue

<script>
import { LhConfigProvider, LhCheckbox, LhCheckboxGroup } from '@lh-ui/vue3'

export default {
  components: { LhConfigProvider, LhCheckbox, LhCheckboxGroup },
  data() {
    return {
      selected: ['option1'],
      cerblueTheme: {
        'primary-color': '#2B4C7C',
        'primary-color-hover': '#3D649E',
        'primary-color-bg': '#E8EDF3',
      },
    }
  },
}
</script>

<template>
  <LhConfigProvider :theme-vars="cerblueTheme">
    <LhCheckboxGroup v-model="selected">
      <LhCheckbox value="option1" label="オプション 1" />
      <LhCheckbox value="option2" label="オプション 2" />
    </LhCheckboxGroup>
  </LhConfigProvider>
</template>

その他のテーマはテーマカスタマイズを参照してください。

国際化

チェックボックスのテキストは LhConfigProvider と言語パックを組み合わせることで国際化切り替えを実現できます。

Vue FrameworkReact Framework

vue

<script setup lang="ts">
import { ref } from 'vue'
import { LhConfigProvider, LhCheckbox, LhCheckboxGroup } from '@lh-ui/vue3'
import { jaJP } from '@lh-ui/vue3'
import { enUS } from '@lh-ui/vue3'

const locale = ref('ja-JP')
const selected = ref(['vue'])
</script>

<template>
  <!-- 言語パックの設定 -->
  <LhConfigProvider :locale="locale === 'zh-CN' ? zhCN : enUS">
    <LhCheckboxGroup v-model="selected">
      <LhCheckbox value="vue" :label="locale === 'zh-CN' ? 'Vue框架' : 'Vue Framework'" />
      <LhCheckbox value="react" :label="locale === 'zh-CN' ? 'React框架' : 'React Framework'" />
    </LhCheckboxGroup>
  </LhConfigProvider>
</template>

vue

<script>
import { LhConfigProvider, LhCheckbox, LhCheckboxGroup } from '@lh-ui/vue3'
import { jaJP } from '@lh-ui/vue3'
import { enUS } from '@lh-ui/vue3'

export default {
  components: { LhConfigProvider, LhCheckbox, LhCheckboxGroup },
  data() {
    return {
      locale: 'ja-JP',
      selected: ['vue'],
      jaJP: jaJP,
      enUS: enUS,
    }
  },
}
</script>

<template>
  <!-- 言語パックの設定 -->
  <LhConfigProvider :locale="locale === 'zh-CN' ? zhCN : enUS">
    <LhCheckboxGroup v-model="selected">
      <LhCheckbox value="vue" :label="locale === 'zh-CN' ? 'Vue框架' : 'Vue Framework'" />
      <LhCheckbox value="react" :label="locale === 'zh-CN' ? 'React框架' : 'React Framework'" />
    </LhCheckboxGroup>
  </LhConfigProvider>
</template>

無効化・不確定状態・サイズ

単独のチェックボックスは disabled で無効化し、indeterminate で不確定状態（半選）を表示し、size でサイズを調整します。グループでは disabled でグループ全体を無効化し、size でグループ内のサイズを統一します。

vue

<script setup lang="ts">
import { ref } from 'vue'

const demoCbDisabled = ref(true)
const demoCbIndeterminate = ref(false)
const demoIndeterminate = ref(true)
const demoCbSmall = ref(false)
const demoCbLarge = ref(false)
const demoCbGroupDisabled = ref<string[]>([])
const demoCbGroupSize = ref<string[]>([])
</script>

<template>
  <!-- 無効化 -->
  <LhCheckbox v-model="demoCbDisabled" disabled label="無効状態" />
  <!-- 不確定状態 -->
  <LhCheckbox v-model="demoCbIndeterminate" :indeterminate="demoIndeterminate" label="不確定状態" />
  <!-- 小サイズ -->
  <LhCheckbox v-model="demoCbSmall" size="small" label="small" />
  <!-- 大サイズ -->
  <LhCheckbox v-model="demoCbLarge" size="large" label="large" />
  <!-- グループ全体を無効化 -->
  <LhCheckboxGroup v-model="demoCbGroupDisabled" disabled>
    <LhCheckbox value="a" label="オプション A" />
    <LhCheckbox value="b" label="オプション B" />
  </LhCheckboxGroup>
  <!-- グループ内で大サイズに統一 -->
  <LhCheckboxGroup v-model="demoCbGroupSize" size="large">
    <LhCheckbox value="a" label="オプション A" />
    <LhCheckbox value="b" label="オプション B" />
  </LhCheckboxGroup>
</template>

vue

<script>
export default {
  data() {
    return {
      demoCbDisabled: true,
      demoCbIndeterminate: false,
      demoIndeterminate: true,
      demoCbSmall: false,
      demoCbLarge: false,
      demoCbGroupDisabled: [],
      demoCbGroupSize: [],
    }
  },
}
</script>

<template>
  <!-- 無効化 -->
  <LhCheckbox v-model="demoCbDisabled" disabled label="無効状態" />
  <!-- 不確定状態 -->
  <LhCheckbox v-model="demoCbIndeterminate" :indeterminate="demoIndeterminate" label="不確定状態" />
  <!-- 小サイズ -->
  <LhCheckbox v-model="demoCbSmall" size="small" label="small" />
  <!-- 大サイズ -->
  <LhCheckbox v-model="demoCbLarge" size="large" label="large" />
  <!-- グループ全体を無効化 -->
  <LhCheckboxGroup v-model="demoCbGroupDisabled" disabled>
    <LhCheckbox value="a" label="オプション A" />
    <LhCheckbox value="b" label="オプション B" />
  </LhCheckboxGroup>
  <!-- グループ内で大サイズに統一 -->
  <LhCheckboxGroup v-model="demoCbGroupSize" size="large">
    <LhCheckbox value="a" label="オプション A" />
    <LhCheckbox value="b" label="オプション B" />
  </LhCheckboxGroup>
</template>

Checkbox API

LhCheckbox Props

プロパティ	説明	型	デフォルト値
modelValue	単独モードの選択状態	`boolean`	`false`
value	グループモードで送信される値	`unknown`	—
label	ラベルテキスト	`string`	—
disabled	無効にするかどうか	`boolean`	`false`
indeterminate	不確定状態（半選）にするかどうか	`boolean`	`false`
name	—	`string`	—
size	サイズ	`"small" \| "medium" \| "large"`	`'medium'`
sx	sx クイックレイアウトプロパティ	`LhSxProps`	—

LhCheckboxGroup Props

プロパティ	説明	型	デフォルト値
model-value	選択された値の配列	`unknown[]`	`[]`
disabled	グループ全体を無効にするかどうか	`boolean`	`false`
name	ネイティブフォーム名	`string`	—
size	グループ内チェックボックスのサイズ	`'small' \| 'medium' \| 'large'`	`'medium'`

Events

イベント	説明	パラメータ
update:modelValue	値が変化しました	`value: boolean` または `value[]`
change	選択が変化しました	`value`

Slots

スロット名	説明
default	カスタム内容

型定義

このコンポーネントが外部にエクスポートする TypeScript の型構造を以下に示します（packages/components/checkbox/src/types.ts および @lh-ui/share/core/* のソースから自動抽出。各エントリーをクリックすると完全な定義が表示されます。プロパティの説明は上の Props 表を参照してください）：

LhCheckboxSize

export type LhCheckboxSize = 'small' | 'medium' | 'large'

LhCheckboxProps

export interface LhCheckboxProps {
  modelValue?: boolean
  value?: unknown
  label?: string
  disabled?: boolean
  indeterminate?: boolean
  name?: string
  size?: LhCheckboxSize
  /** sx クイックレイアウトプロパティ */
  sx?: LhSxProps
}

LhCheckboxGroupProps

export interface LhCheckboxGroupProps {
  modelValue?: unknown[]
  disabled?: boolean
  name?: string
  size?: LhCheckboxSize
}

Checkbox チェックボックス ​

単独で使用 ​

グループで使用 ​

カスタムテーマ ​

国際化 ​

無効化・不確定状態・サイズ ​

Checkbox API ​

LhCheckbox Props ​

LhCheckboxGroup Props ​

Events ​

Slots ​

型定義 ​