Insignia

LhBadge sirve para mostrar el recuento de mensajes no leídos o una marca de estado.

Uso básico

⁵

vue

<script setup lang="ts">
</script>

<template>
  <LhBadge :value="5">
    <div>Contenido de destino</div>
  </LhBadge>
</template>

vue

<script>
export default {}
</script>

<template>
  <LhBadge :value="5">
    <div>Contenido de destino</div>
  </LhBadge>
</template>

Máximo personalizado

⁹⁹⁺

vue

<script setup lang="ts">
</script>

<template>
  <LhBadge
    :value="100"
    :max="99"
  >
    <div>Contenido de destino</div>
  </LhBadge>
</template>

vue

<script>
export default {}
</script>

<template>
  <LhBadge
    :value="100"
    :max="99"
  >
    <div>Contenido de destino</div>
  </LhBadge>
</template>

Punto

is-dot muestra solo un pequeño punto, sin valor numérico; es ideal para avisos del tipo «hay novedades» y se puede recolorear con type.

Mensajes

Pendientes

vue

<script setup lang="ts">
</script>

<template>
  <!-- Punto -->
  <LhBadge is-dot>
    <div>Contenido de destino</div>
  </LhBadge>
  <!-- Punto (color de aviso) -->
  <LhBadge is-dot type="warning">
    <div>Contenido de destino</div>
  </LhBadge>
</template>

vue

<script>
export default {}
</script>

<template>
  <!-- Punto -->
  <LhBadge is-dot>
    <div>Contenido de destino</div>
  </LhBadge>
  <!-- Punto (color de aviso) -->
  <LhBadge is-dot type="warning">
    <div>Contenido de destino</div>
  </LhBadge>
</template>

Desplazamiento, valor cero y contenido personalizado

offset ajusta con precisión la posición de la insignia (desplazamiento en píxeles [x, y]); show-zero hace que también se muestre el valor cero; content sustituye el número por un texto personalizado.

offset

⁵

show-zero

⁰

content

^Nuevo

vue

<script setup lang="ts">
</script>

<template>
  <!-- Desplazamiento -->
  <LhBadge :value="5" :offset="[6, 6]">
    <div>Contenido de destino</div>
  </LhBadge>
  <!-- Mostrar también el valor cero -->
  <LhBadge :value="0" show-zero>
    <div>Contenido de destino</div>
  </LhBadge>
  <!-- Contenido personalizado -->
  <LhBadge value="Nuevo" content="Nuevo">
    <div>Contenido de destino</div>
  </LhBadge>
</template>

vue

<script>
export default {}
</script>

<template>
  <!-- Desplazamiento -->
  <LhBadge :value="5" :offset="[6, 6]">
    <div>Contenido de destino</div>
  </LhBadge>
  <!-- Mostrar también el valor cero -->
  <LhBadge :value="0" show-zero>
    <div>Contenido de destino</div>
  </LhBadge>
  <!-- Contenido personalizado -->
  <LhBadge value="Nuevo" content="Nuevo">
    <div>Contenido de destino</div>
  </LhBadge>
</template>

vue

<script setup lang="ts">
</script>

<template>
  <LhBadge is-dot>
    <div>Contenido de destino</div>
  </LhBadge>
</template>

vue

<script>
export default {}
</script>

<template>
  <LhBadge is-dot>
    <div>Contenido de destino</div>
  </LhBadge>
</template>

Tipo

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>

Tamaño

⁵

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>

Controlar mostrar y ocultar

¹⁰

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>Contenido de destino</div>
  </LhBadge>
  <LhButton @click="isHidden = !isHidden">
    {{ isHidden ? 'Mostrar' : 'Ocultar' }}
  </LhButton>
</template>

vue

<script>
import { ref } from 'vue'

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

<template>
  <LhBadge
    :value="badgeValue"
    :hidden="isHidden"
  >
    <div>Contenido de destino</div>
  </LhBadge>
  <LhButton @click="isHidden = !isHidden">
    {{ isHidden ? 'Mostrar' : 'Ocultar' }}
  </LhButton>
</template>

Definiciones de tipos

Las estructuras de tipos TypeScript exportadas por este componente (extraídas automáticamente de packages/components/badge/src/types.ts y de las fuentes @lh-ui/share/core/*; abre cada entrada para ver la definición completa; la descripción de los atributos está en la tabla de Props de arriba):

LhBadgeProps

export interface LhBadgeProps {
  type?: LhBadgeType
  value?: string | number
  size?: LhBadgeSize
  max?: number
  isDot?: boolean
  hidden?: boolean
  offset?: [number, number]
  showZero?: boolean
  content?: string
  /** Props de disposición rápida */
  sx?: LhSxProps
}

LhBadgeSize

export type LhBadgeSize = LhComponentSize

LhBadgeOffset

export type LhBadgeOffset = [number, number]

LhBadgeType _{(de @lh-ui/share/core/badge)}

export type LhBadgeType = 'primary' | 'success' | 'warning' | 'danger' | 'info' | 'default'

LhComponentSize _{(de @lh-ui/share/core/shared)}

export type LhComponentSize = (typeof LH_SIZE_CONST)[keyof typeof LH_SIZE_CONST]

Internacionalización

El texto de la insignia puede internacionalizarse con LhConfigProvider y un paquete de idioma.

消息

⁵

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>
  <!-- Cambio de paquete de idioma con 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>
  <!-- Cambio de paquete de idioma con 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

Prop	Descripción	Tipo	Predeterminado
type	Tipo de insignia	`"primary" \| "success" \| "warning" \| "danger" \| "info" \| "default"`	`'danger'`
value	Valor mostrado	`string \| number`	—
size	Tamaño	`"small" \| "medium" \| "large" \| "mini" \| "x-large"`	`'medium'`
max	Valor máximo	`number`	`99`
isDot	Modo punto	`boolean`	`false`
hidden	Si se oculta	`boolean`	`false`
offset	Desplazamiento	`[number, number]`	—
showZero	Si se muestra el 0	`boolean`	`false`
content	Contenido personalizado	`string`	—
sx	Props de disposición rápida (p. ej., `{ mt: 2, w: '50%' }`); se convierten a estilos en línea aplicados al elemento raíz	`LhSxProps`	—

Accesibilidad

La insignia en modo punto (is-dot) es puramente decorativa: se marca como aria-hidden y no entra en el árbol de accesibilidad
El modo numérico conserva el contenido textual, de modo que el lector de pantalla puede anunciar conteos como «99+»

Insignia ​

Uso básico ​

Máximo personalizado ​

Punto ​

Desplazamiento, valor cero y contenido personalizado ​

Tipo ​

Tamaño ​

Controlar mostrar y ocultar ​

Definiciones de tipos ​

Internacionalización ​

API ​

Accesibilidad ​