Skip to content
API 风格:

Бейдж ​

LhBadge используется для отображения количества непрочитанных сообщений или статусной метки.

Базовое использование ​

Базовое использование
5
vue
<script setup lang="ts">
</script>

<template>
  <LhBadge :value="5">
    <div>Содержимое</div>
  </LhBadge>
</template>
vue
<script>
export default {}
</script>

<template>
  <LhBadge :value="5">
    <div>Содержимое</div>
  </LhBadge>
</template>

Свой максимум ​

Свой максимум
99+
vue
<script setup lang="ts">
</script>

<template>
  <LhBadge
    :value="100"
    :max="99"
  >
    <div>Содержимое</div>
  </LhBadge>
</template>
vue
<script>
export default {}
</script>

<template>
  <LhBadge
    :value="100"
    :max="99"
  >
    <div>Содержимое</div>
  </LhBadge>
</template>

Точка ​

is-dot показывает только маленькую точку без числового значения; подходит для подсказок вида «есть обновления», цвет можно изменить через type.

Точка
Сообщения
Задачи
vue
<script setup lang="ts">
</script>

<template>
  <!-- Точка -->
  <LhBadge is-dot>
    <div>Содержимое</div>
  </LhBadge>
  <!-- Точка (предупреждающий цвет) -->
  <LhBadge is-dot type="warning">
    <div>Содержимое</div>
  </LhBadge>
</template>
vue
<script>
export default {}
</script>

<template>
  <!-- Точка -->
  <LhBadge is-dot>
    <div>Содержимое</div>
  </LhBadge>
  <!-- Точка (предупреждающий цвет) -->
  <LhBadge is-dot type="warning">
    <div>Содержимое</div>
  </LhBadge>
</template>

Смещение, нулевое значение и пользовательское содержимое ​

offset точно настраивает позицию бейджа (смещение в пикселях [x, y]); show-zero показывает бейдж даже при нулевом значении; content заменяет число пользовательским текстом.

Смещение / ноль / своё содержимое
offset
5
show-zero
0
content
Нов
vue
<script setup lang="ts">
</script>

<template>
  <!-- Смещение -->
  <LhBadge :value="5" :offset="[6, 6]">
    <div>Содержимое</div>
  </LhBadge>
  <!-- Ноль тоже показывается -->
  <LhBadge :value="0" show-zero>
    <div>Содержимое</div>
  </LhBadge>
  <!-- Пользовательское содержимое -->
  <LhBadge value="Нов" content="Нов">
    <div>Содержимое</div>
  </LhBadge>
</template>
vue
<script>
export default {}
</script>

<template>
  <!-- Смещение -->
  <LhBadge :value="5" :offset="[6, 6]">
    <div>Содержимое</div>
  </LhBadge>
  <!-- Ноль тоже показывается -->
  <LhBadge :value="0" show-zero>
    <div>Содержимое</div>
  </LhBadge>
  <!-- Пользовательское содержимое -->
  <LhBadge value="Нов" content="Нов">
    <div>Содержимое</div>
  </LhBadge>
</template>
Точка
vue
<script setup lang="ts">
</script>

<template>
  <LhBadge is-dot>
    <div>Содержимое</div>
  </LhBadge>
</template>
vue
<script>
export default {}
</script>

<template>
  <LhBadge is-dot>
    <div>Содержимое</div>
  </LhBadge>
</template>

Тип ​

Тип
2
1
1
1
vue
<script setup lang="ts">
</script>

<template>
  <LhBadge
    type="primary"
    :value="2"
  >
    <div>Primary</div>
  </LhBadge>
  <LhBadge
    type="success"
    :value="1"
  >
    <div>Success</div>
  </LhBadge>
  <LhBadge
    type="warning"
    :value="1"
  >
    <div>Warning</div>
  </LhBadge>
  <LhBadge
    type="info"
    :value="1"
  >
    <div>Info</div>
  </LhBadge>
</template>
vue
<script>
export default {}
</script>

<template>
  <LhBadge
    type="primary"
    :value="2"
  >
    <div>Primary</div>
  </LhBadge>
  <LhBadge
    type="success"
    :value="1"
  >
    <div>Success</div>
  </LhBadge>
  <LhBadge
    type="warning"
    :value="1"
  >
    <div>Warning</div>
  </LhBadge>
  <LhBadge
    type="info"
    :value="1"
  >
    <div>Info</div>
  </LhBadge>
</template>

Размер ​

Размер
5
5
5
vue
<script setup lang="ts">
</script>

<template>
  <LhBadge
    size="small"
    :value="5"
  >
    <div>Small</div>
  </LhBadge>
  <LhBadge
    size="medium"
    :value="5"
  >
    <div>Medium</div>
  </LhBadge>
  <LhBadge
    size="large"
    :value="5"
  >
    <div>Large</div>
  </LhBadge>
</template>
vue
<script>
export default {}
</script>

<template>
  <LhBadge
    size="small"
    :value="5"
  >
    <div>Small</div>
  </LhBadge>
  <LhBadge
    size="medium"
    :value="5"
  >
    <div>Medium</div>
  </LhBadge>
  <LhBadge
    size="large"
    :value="5"
  >
    <div>Large</div>
  </LhBadge>
</template>

Управление показом и скрытием ​

Управление показом и скрытием
10
vue
<script setup lang="ts">
import { ref } from 'vue'

const badgeValue = ref(10)
const isHidden = ref(false)
</script>

<template>
  <LhBadge
    :value="badgeValue"
    :hidden="isHidden"
  >
    <div>Содержимое</div>
  </LhBadge>
  <LhButton @click="isHidden = !isHidden">
    {{ isHidden ? 'Показать' : 'Скрыть' }}
  </LhButton>
</template>
vue
<script>
import { ref } from 'vue'

const badgeValue = ref(10)
const isHidden = ref(false)
</script>

<template>
  <LhBadge
    :value="badgeValue"
    :hidden="isHidden"
  >
    <div>Содержимое</div>
  </LhBadge>
  <LhButton @click="isHidden = !isHidden">
    {{ isHidden ? 'Показать' : 'Скрыть' }}
  </LhButton>
</template>

Типы ​

TypeScript-типы, экспортируемые этим компонентом (извлечены автоматически из packages/components/badge/src/types.ts и исходников @lh-ui/share/core/*; раскройте нужный пункт, чтобы увидеть полное определение; описания свойств — в таблице Props выше):

LhBadgeProps
ts
export interface LhBadgeProps {
  type?: LhBadgeType
  value?: string | number
  size?: LhBadgeSize
  max?: number
  isDot?: boolean
  hidden?: boolean
  offset?: [number, number]
  showZero?: boolean
  content?: string
  /** Сокращённые свойства компоновки sx */
  sx?: LhSxProps
}
LhBadgeSize
ts
export type LhBadgeSize = LhComponentSize
LhBadgeOffset
ts
export type LhBadgeOffset = [number, number]
LhBadgeType (из @lh-ui/share/core/badge)
ts
export type LhBadgeType = 'primary' | 'success' | 'warning' | 'danger' | 'info' | 'default'
LhComponentSize (из @lh-ui/share/core/shared)
ts
export type LhComponentSize = (typeof LH_SIZE_CONST)[keyof typeof LH_SIZE_CONST]

Интернационализация ​

Текст бейджа можно интернационализировать через LhConfigProvider с языковыми пакетами.

Интернационализация
消息
5
vue
<script setup lang="ts">
import { ref } from 'vue'
import { LhConfigProvider, LhBadge, LhButton } from '@lh-ui/vue3'
import { zhCN } from '@lh-ui/vue3'
import { enUS } from '@lh-ui/vue3'

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

<template>
  <!-- Переключение языкового пакета через ConfigProvider -->
  <LhConfigProvider :locale="locale === 'zh-CN' ? zhCN : enUS">
    <LhBadge :value="5">
      <div>{{ locale === 'zh-CN' ? '消息' : 'Messages' }}</div>
    </LhBadge>
    <LhButton @click="locale = locale === 'zh-CN' ? 'en-US' : 'zh-CN'">
      {{ locale === 'zh-CN' ? '切换英文' : 'Switch to Chinese' }}
    </LhButton>
  </LhConfigProvider>
</template>
vue
<script>
import { LhConfigProvider, LhBadge, LhButton } from '@lh-ui/vue3'
import { zhCN } from '@lh-ui/vue3'
import { enUS } from '@lh-ui/vue3'

export default {
  components: { LhConfigProvider, LhBadge, LhButton },
  data() {
    return {
      locale: 'zh-CN',
      zhCN: zhCN,
      enUS: enUS,
    }
  },
}
</script>

<template>
  <!-- Переключение языкового пакета через ConfigProvider -->
  <LhConfigProvider :locale="locale === 'zh-CN' ? zhCN : enUS">
    <LhBadge :value="5">
      <div>{{ locale === 'zh-CN' ? '消息' : 'Messages' }}</div>
    </LhBadge>
    <LhButton @click="locale = locale === 'zh-CN' ? 'en-US' : 'zh-CN'">
      {{ locale === 'zh-CN' ? '切换英文' : 'Switch to Chinese' }}
    </LhButton>
  </LhConfigProvider>
</template>

API ​

СвойствоОписаниеТипПо умолчанию
typeТип бейджа"primary" | "success" | "warning" | "danger" | "info" | "default"'danger'
valueОтображаемое значениеstring | number—
sizeРазмер"small" | "medium" | "large" | "mini" | "x-large"'medium'
maxМаксимальное значениеnumber99
isDotРежим точкиbooleanfalse
hiddenСкрыть ли бейджbooleanfalse
offsetСмещение[number, number]—
showZeroПоказывать ли 0booleanfalse
contentПользовательское содержимоеstring—
sxСокращённые свойства компоновки (например { mt: 2, w: '50%' }), преобразуются в инлайн-стили и применяются к корневому элементуLhSxProps—

Доступность ​

  • Бейдж в режиме точки (is-dot) чисто декоративный: помечается aria-hidden и не попадает в дерево доступности
  • В числовом режиме текстовое содержимое сохраняется, и скринридер может озвучить счётчик вида «99+»

Красота традиций — основа кода