Icono

Componente de icono que pone a disposición un amplio catálogo de iconos.

Uso básico

Uso básico

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

<template>
  <!-- Estrella -->
  <LhIcon name="star" />
  <!-- Buscar -->
  <LhIcon name="search" />
  <!-- Comprobación -->
  <LhIcon name="check" />
  <!-- Cerrar -->
  <LhIcon name="close" />
  <!-- Editar -->
  <LhIcon name="edit" />
  <!-- Eliminar -->
  <LhIcon name="delete" />
  <!-- Cargando -->
  <LhIcon name="loading" />
  <!-- Flecha hacia arriba -->
  <LhIcon name="arrow-up" />
  <!-- Flecha hacia abajo -->
  <LhIcon name="arrow-down" />
  <!-- Flecha hacia la izquierda -->
  <LhIcon name="arrow-left" />
  <!-- Flecha hacia la derecha -->
  <LhIcon name="arrow-right" />
</template>

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

export default {
  components: { LhIcon },
}
</script>

<template>
  <!-- Estrella -->
  <LhIcon name="star" />
  <!-- Buscar -->
  <LhIcon name="search" />
  <!-- Comprobación -->
  <LhIcon name="check" />
  <!-- Cerrar -->
  <LhIcon name="close" />
  <!-- Editar -->
  <LhIcon name="edit" />
  <!-- Eliminar -->
  <LhIcon name="delete" />
  <!-- Cargando -->
  <LhIcon name="loading" />
  <!-- Flecha hacia arriba -->
  <LhIcon name="arrow-up" />
  <!-- Flecha hacia abajo -->
  <LhIcon name="arrow-down" />
  <!-- Flecha hacia la izquierda -->
  <LhIcon name="arrow-left" />
  <!-- Flecha hacia la derecha -->
  <LhIcon name="arrow-right" />
</template>

Diferentes tamaños

Diferentes tamaños

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

<template>
  <LhIcon name="star" size="small" />
  <LhIcon name="star" size="default" />
  <LhIcon name="star" size="large" />
  <LhIcon name="star" size="x-large" />
</template>

<script>
export default {}
</script>

<template>
  <LhIcon name="star" size="small" />
  <LhIcon name="star" size="default" />
  <LhIcon name="star" size="large" />
  <LhIcon name="star" size="x-large" />
</template>

Color personalizado

Color personalizado

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

<template>
  <LhIcon name="star" color="#e6a23c" />
  <LhIcon name="search" color="#409eff" />
  <LhIcon name="check" color="#67c23a" />
  <LhIcon name="close" color="#f56c6c" />
</template>

<script>
export default {}
</script>

<template>
  <LhIcon name="star" color="#e6a23c" />
  <LhIcon name="search" color="#409eff" />
  <LhIcon name="check" color="#67c23a" />
  <LhIcon name="close" color="#f56c6c" />
</template>

Internacionalización

El componente de icono en sí no maneja textos, pero los textos circundantes pueden internacionalizarse mediante LhConfigProvider combinado con un paquete de idioma.

Internacionalización

<script setup lang="ts">
import { ref } from 'vue'
import { LhConfigProvider, LhIcon, 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 idioma -->
  <LhConfigProvider :locale="locale === 'zh-CN' ? zhCN : enUS">
    <LhIcon name="star" />
    <LhButton @click="locale = locale === 'zh-CN' ? 'en-US' : 'zh-CN'">
      {{ locale === 'zh-CN' ? '切换英文' : 'Switch to Chinese' }}
    </LhButton>
  </LhConfigProvider>
</template>

<script>
import { LhConfigProvider, LhIcon, LhButton } from '@lh-ui/vue3'
import { zhCN } from '@lh-ui/vue3'
import { enUS } from '@lh-ui/vue3'

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

<template>
  <!-- Cambio de idioma -->
  <LhConfigProvider :locale="locale === 'zh-CN' ? zhCN : enUS">
    <LhIcon name="star" />
    <LhButton @click="locale = locale === 'zh-CN' ? 'en-US' : 'zh-CN'">
      {{ locale === 'zh-CN' ? '切换英文' : 'Switch to Chinese' }}
    </LhButton>
  </LhConfigProvider>
</template>

Icon API

Props

Prop	Descripción	Tipo	Predeterminado
name	Nombre del icono	"star" | "search" | "check" | "close" | "arrow-up" | "arrow-down" | "arrow-left" | "arrow-right" | "warning" | "error" | "info" | "loading" | "plus" | "minus" | "edit" | "delete" | "setting" | "user" | "home" | "menu" | "more" | "download" | "upload" | "refresh" | "folder" | "file" | "date" | "clock" | "email" | "phone" | "location" | "image" | "share" | "bell" | "filter" | "eye" | "link"	—
size	Tamaño del icono	string | number	—
color	Color del icono	string	—
themeVars	Variables de tema a nivel de componente; sobrescribe la configuración del ConfigProvider	{ [x: string]: string; }	—
bgPattern	Patrón de fondo a nivel de componente; sobrescribe la configuración del ConfigProvider	string	—

Slots

Slot	Descripción
default	Contenido personalizado del icono

Definiciones de tipos

Las estructuras de tipos TypeScript exportadas por este componente (extraídas automáticamente de packages/components/icon/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):

LhIconProps

export interface LhIconProps {
  /** Nombre del icono */
  name?: LhIconName
  /** Tamaño del icono */
  size?: string | number
  /** Color del icono */
  color?: string
  /** Variables de tema a nivel de componente; sobrescribe la configuración del ConfigProvider */
  themeVars?: Record<string, string>
  /** Patrón de fondo a nivel de componente; sobrescribe la configuración del ConfigProvider */
  bgPattern?: string
}

LhIconSize

export type LhIconSize = string | number

LhIconName _{(de @lh-ui/share/core/icon (svgs.ts))}

export type LhIconName = keyof typeof LH_ICON_SVGS_CONST