Icône

Composant d'icône, fournissant un large éventail de ressources graphiques.

Utilisation de base

Utilisation de base

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

<template>
  <!-- Étoile -->
  <LhIcon name="star" />
  <!-- Rechercher -->
  <LhIcon name="search" />
  <!-- Coche -->
  <LhIcon name="check" />
  <!-- Fermer -->
  <LhIcon name="close" />
  <!-- Modifier -->
  <LhIcon name="edit" />
  <!-- Supprimer -->
  <LhIcon name="delete" />
  <!-- Chargement -->
  <LhIcon name="loading" />
  <!-- Flèche vers le haut -->
  <LhIcon name="arrow-up" />
  <!-- Flèche vers le bas -->
  <LhIcon name="arrow-down" />
  <!-- Flèche vers la gauche -->
  <LhIcon name="arrow-left" />
  <!-- Flèche vers la droite -->
  <LhIcon name="arrow-right" />
</template>

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

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

<template>
  <!-- Étoile -->
  <LhIcon name="star" />
  <!-- Rechercher -->
  <LhIcon name="search" />
  <!-- Coche -->
  <LhIcon name="check" />
  <!-- Fermer -->
  <LhIcon name="close" />
  <!-- Modifier -->
  <LhIcon name="edit" />
  <!-- Supprimer -->
  <LhIcon name="delete" />
  <!-- Chargement -->
  <LhIcon name="loading" />
  <!-- Flèche vers le haut -->
  <LhIcon name="arrow-up" />
  <!-- Flèche vers le bas -->
  <LhIcon name="arrow-down" />
  <!-- Flèche vers la gauche -->
  <LhIcon name="arrow-left" />
  <!-- Flèche vers la droite -->
  <LhIcon name="arrow-right" />
</template>

Tailles

Tailles

<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>

Couleur personnalisée

Couleur personnalisée

<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>

Internationalisation

Le composant d'icône ne comporte pas de texte en lui-même, mais les textes environnants peuvent être internationalisés au moyen de LhConfigProvider et des packs de langue.

Internationalisation

<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>
  <!-- Changement de langue -->
  <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>
  <!-- Changement de langue -->
  <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

Propriété	Description	Type	Valeur par défaut
name	Nom de l'icône	"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	Taille de l'icône	string | number	—
color	Couleur de l'icône	string	—
themeVars	Variables de thème au niveau du composant, surchargeant la configuration de ConfigProvider	{ [x: string]: string; }	—
bgPattern	Motif d'arrière-plan au niveau du composant, surchargeant la configuration de ConfigProvider	string	—

Slots

Slot	Description
default	Contenu d'icône personnalisé

Définitions de types

Les structures de types TypeScript exportées par ce composant sont présentées ci-dessous (extraction automatique à partir des sources packages/components/icon/src/types.ts et @lh-ui/share/core/* ; cliquez sur chaque entrée pour afficher la définition complète ; la description des propriétés se trouve dans le tableau Props ci-dessus) :

LhIconProps

/**
 * Props du composant Icon
 */
export interface LhIconProps {
  /** Nom de l'icône */
  name?: LhIconName
  /** Taille de l'icône */
  size?: string | number
  /** Couleur de l'icône */
  color?: string
  /** Variables de thème au niveau du composant, surchargeant la configuration de ConfigProvider */
  themeVars?: Record<string, string>
  /** Motif d'arrière-plan au niveau du composant, surchargeant la configuration de ConfigProvider */
  bgPattern?: string
}

LhIconSize

export type LhIconSize = string | number

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

export type LhIconName = keyof typeof LH_ICON_SVGS_CONST