Skip to content
API 风格:

Radio 單選鈕 ​

LhRadio 支援獨立單選值,LhRadioGroup 支援多個選項的單選分組。

獨立使用 ​

獨立使用
vue
<script setup lang="ts">
import { ref } from 'vue'
import { LhRadio } from '@lh-ui/vue3'

const gender = ref('male')
</script>

<template>
  <LhRadio v-model="gender" value="male" label="男" />
  <LhRadio v-model="gender" value="female" label="女" />
</template>
vue
<script>
import { LhRadio } from '@lh-ui/vue3'

export default {
  components: { LhRadio },
  data() {
    return {
      gender: 'male'
    }
  }
}
</script>

<template>
  <LhRadio v-model="gender" value="male" label="男" />
  <LhRadio v-model="gender" value="female" label="女" />
</template>

分組使用 ​

分組使用
vue
<script setup lang="ts">
import { ref } from 'vue'
import { LhRadio, LhRadioGroup } from '@lh-ui/vue3'

const selectedFramework = ref('vue')
</script>

<template>
  <LhRadioGroup v-model="selectedFramework" name="framework">
    <LhRadio value="vue" label="Vue" />
    <LhRadio value="react" label="React" />
    <LhRadio value="svelte" label="Svelte" />
  </LhRadioGroup>
</template>
vue
<script>
import { LhRadio, LhRadioGroup } from '@lh-ui/vue3'

export default {
  components: { LhRadio, LhRadioGroup },
  data() {
    return {
      selectedFramework: 'vue'
    }
  }
}
</script>

<template>
  <LhRadioGroup v-model="selectedFramework" name="framework">
    <LhRadio value="vue" label="Vue" />
    <LhRadio value="react" label="React" />
    <LhRadio value="svelte" label="Svelte" />
  </LhRadioGroup>
</template>

自訂主題 ​

為單選框套用自訂主題色。

青花瓷主題
vue
<script setup lang="ts">
import { ref } from 'vue'
import { LhConfigProvider, LhRadio, LhRadioGroup } from '@lh-ui/vue3'

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

<template>
  <!-- 青花瓷主題色 -->
  <LhConfigProvider :theme-vars="cerblueTheme">
    <LhRadioGroup v-model="selectedTheme">
      <LhRadio value="option1" label="选项一" />
      <LhRadio value="option2" label="选项二" />
      <LhRadio value="option3" label="选项三" />
    </LhRadioGroup>
  </LhConfigProvider>
</template>
vue
<script>
import { LhConfigProvider, LhRadio, LhRadioGroup } from '@lh-ui/vue3'

export default {
  components: { LhConfigProvider, LhRadio, LhRadioGroup },
  data() {
    return {
      selectedTheme: 'option1',
      cerblueTheme: {
        'primary-color': '#2B4C7C',
        'primary-color-hover': '#3D649E',
        'primary-color-bg': '#E8EDF3',
      },
    }
  },
}
</script>

<template>
  <!-- 青花瓷主題色 -->
  <LhConfigProvider :theme-vars="cerblueTheme">
    <LhRadioGroup v-model="selectedTheme">
      <LhRadio value="option1" label="选项一" />
      <LhRadio value="option2" label="选项二" />
      <LhRadio value="option3" label="选项三" />
    </LhRadioGroup>
  </LhConfigProvider>
</template>

更多主題請參考主題定製。

國際化 ​

單選框文字可以透過 LhConfigProvider 配合語言包實現國際化切換。

國際化
vue
<script setup lang="ts">
import { ref } from 'vue'
import { LhConfigProvider, LhRadio, LhRadioGroup, zhCN, enUS } from '@lh-ui/vue3'

const locale = ref('zh-CN')
const selected = ref('vue')
</script>

<template>
  <!-- 按當前語言注入語言包 -->
  <LhConfigProvider :locale="locale === 'zh-CN' ? zhCN : enUS">
    <LhRadioGroup v-model="selected">
      <!-- 文案隨語言切換 -->
      <LhRadio value="vue" :label="locale === 'zh-CN' ? 'Vue框架' : 'Vue Framework'" />
      <LhRadio value="react" :label="locale === 'zh-CN' ? 'React框架' : 'React Framework'" />
    </LhRadioGroup>
  </LhConfigProvider>
</template>
vue
<script>
import { LhConfigProvider, LhRadio, LhRadioGroup, zhCN, enUS } from '@lh-ui/vue3'

export default {
  components: { LhConfigProvider, LhRadio, LhRadioGroup },
  data() {
    return {
      locale: 'zh-CN',
      selected: 'vue',
      zhCN: zhCN,
      enUS: enUS,
    }
  },
}
</script>

<template>
  <!-- 按當前語言注入語言包 -->
  <LhConfigProvider :locale="locale === 'zh-CN' ? zhCN : enUS">
    <LhRadioGroup v-model="selected">
      <!-- 文案隨語言切換 -->
      <LhRadio value="vue" :label="locale === 'zh-CN' ? 'Vue框架' : 'Vue Framework'" />
      <LhRadio value="react" :label="locale === 'zh-CN' ? 'React框架' : 'React Framework'" />
    </LhRadioGroup>
  </LhConfigProvider>
</template>

停用與尺寸 ​

單選框透過 disabled 停用、size 調整尺寸;分組透過 disabled 停用整組、size 統一調整組內尺寸。

停用與尺寸
vue
<script setup lang="ts">
import { ref } from 'vue'
import { LhRadio, LhRadioGroup } from '@lh-ui/vue3'

const demoRadioDisabled = ref('')
const demoRadioDisabled2 = ref('1')
const demoRadioSmall = ref('1')
const demoRadioLarge = ref('1')
const demoRadioGroupDisabled = ref('a')
const demoRadioGroupSize = ref('a')
</script>

<template>
  <!-- 停用 -->
  <LhRadio v-model="demoRadioDisabled" value="1" disabled label="禁用选项" />
  <!-- 停用且選中 -->
  <LhRadio v-model="demoRadioDisabled2" value="1" disabled label="禁用且选中" />
  <!-- small 尺寸 -->
  <LhRadio v-model="demoRadioSmall" value="1" size="small" label="small" />
  <!-- large 尺寸 -->
  <LhRadio v-model="demoRadioLarge" value="1" size="large" label="large" />
  <!-- 整組停用 -->
  <LhRadioGroup v-model="demoRadioGroupDisabled" disabled>
    <LhRadio value="a" label="选项 A" />
    <LhRadio value="b" label="选项 B" />
  </LhRadioGroup>
  <!-- 組內統一 large 尺寸 -->
  <LhRadioGroup v-model="demoRadioGroupSize" size="large">
    <LhRadio value="a" label="选项 A" />
    <LhRadio value="b" label="选项 B" />
  </LhRadioGroup>
</template>
vue
<script>
import { LhRadio, LhRadioGroup } from '@lh-ui/vue3'

export default {
  components: { LhRadio, LhRadioGroup },
  data() {
    return {
      demoRadioDisabled: '',
      demoRadioDisabled2: '1',
      demoRadioSmall: '1',
      demoRadioLarge: '1',
      demoRadioGroupDisabled: 'a',
      demoRadioGroupSize: 'a',
    }
  },
}
</script>

<template>
  <!-- 停用 -->
  <LhRadio v-model="demoRadioDisabled" value="1" disabled label="禁用选项" />
  <!-- 停用且選中 -->
  <LhRadio v-model="demoRadioDisabled2" value="1" disabled label="禁用且选中" />
  <!-- small 尺寸 -->
  <LhRadio v-model="demoRadioSmall" value="1" size="small" label="small" />
  <!-- large 尺寸 -->
  <LhRadio v-model="demoRadioLarge" value="1" size="large" label="large" />
  <!-- 整組停用 -->
  <LhRadioGroup v-model="demoRadioGroupDisabled" disabled>
    <LhRadio value="a" label="选项 A" />
    <LhRadio value="b" label="选项 B" />
  </LhRadioGroup>
  <!-- 組內統一 large 尺寸 -->
  <LhRadioGroup v-model="demoRadioGroupSize" size="large">
    <LhRadio value="a" label="选项 A" />
    <LhRadio value="b" label="选项 B" />
  </LhRadioGroup>
</template>

Radio API ​

LhRadio Props ​

屬性名說明類型預設值
modelValue獨立模式的選中值unknown—
value提交的值unknown—
label標籤文字string—
disabled是否停用booleanfalse
name原生表單名稱string—
size尺寸"small" | "medium" | "large" | "mini" | "x-large"'medium'
sxsx 快速版面配置屬性LhSxProps—

LhRadioGroup Props ​

屬性名說明類型預設值
model-value獨立模式的選中值unknown—
disabled是否停用整個分組booleanfalse
name原生表單名稱string—
size分組內單選框尺寸'small' | 'medium' | 'large''medium'

Events ​

事件名說明回呼參數
update:modelValue值發生變化value: unknown
change選擇發生變化value: unknown

Slots ​

插槽名說明
default自訂內容

類型定義 ​

本元件對外匯出的 TypeScript 類型結構如下(自動提取自 packages/components/radio/src/types.ts 與 @lh-ui/share/core/* 原始碼,點選各條目展開檢視完整定義;屬性說明見上方 Props 表):

LhRadioSize
ts
export type LhRadioSize = typeof LH_SIZE_CONST[keyof typeof LH_SIZE_CONST]
LhRadioProps
ts
export interface LhRadioProps {
  modelValue?: unknown
  value?: unknown
  label?: string
  disabled?: boolean
  name?: string
  size?: LhRadioSize
  /** sx 快速版面配置屬性 */
  sx?: LhSxProps
}
LhRadioGroupProps
ts
export interface LhRadioGroupProps {
  modelValue?: unknown
  disabled?: boolean
  name?: string
  size?: LhRadioSize
}