Значок
Компонент значков с обширным набором иконок.
Базовое использование
Базовое использование
vue
<script setup lang="ts">
import { LhIcon } from '@lh-ui/vue3'
</script>
<template>
<!-- Звезда -->
<LhIcon name="star" />
<!-- Поиск -->
<LhIcon name="search" />
<!-- Галочка -->
<LhIcon name="check" />
<!-- Закрыть -->
<LhIcon name="close" />
<!-- Редактировать -->
<LhIcon name="edit" />
<!-- Удалить -->
<LhIcon name="delete" />
<!-- Загрузка -->
<LhIcon name="loading" />
<!-- Стрелка вверх -->
<LhIcon name="arrow-up" />
<!-- Стрелка вниз -->
<LhIcon name="arrow-down" />
<!-- Стрелка влево -->
<LhIcon name="arrow-left" />
<!-- Стрелка вправо -->
<LhIcon name="arrow-right" />
</template>vue
<script>
import { LhIcon } from '@lh-ui/vue3'
export default {
components: { LhIcon },
}
</script>
<template>
<!-- Звезда -->
<LhIcon name="star" />
<!-- Поиск -->
<LhIcon name="search" />
<!-- Галочка -->
<LhIcon name="check" />
<!-- Закрыть -->
<LhIcon name="close" />
<!-- Редактировать -->
<LhIcon name="edit" />
<!-- Удалить -->
<LhIcon name="delete" />
<!-- Загрузка -->
<LhIcon name="loading" />
<!-- Стрелка вверх -->
<LhIcon name="arrow-up" />
<!-- Стрелка вниз -->
<LhIcon name="arrow-down" />
<!-- Стрелка влево -->
<LhIcon name="arrow-left" />
<!-- Стрелка вправо -->
<LhIcon name="arrow-right" />
</template>Различные размеры
Различные размеры
vue
<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>vue
<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>Пользовательский цвет
Пользовательский цвет
vue
<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>vue
<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>Интернационализация
Сам компонент значка не содержит текстов, но окружающие его надписи можно интернационализировать через LhConfigProvider в сочетании с языковыми пакетами.
Интернационализация
vue
<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>
<!-- Переключение языкового стандарта -->
<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>vue
<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>
<!-- Переключение языкового стандарта -->
<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
| Свойство | Описание | Тип | По умолчанию |
|---|---|---|---|
| name | Название значка | "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 | Размер значка | string | number | — |
| color | Цвет значка | string | — |
| themeVars | Тематические переменные уровня компонента, переопределяют конфигурацию ConfigProvider | { [x: string]: string; } | — |
| bgPattern | Фоновый узор уровня компонента, переопределяет конфигурацию ConfigProvider | string | — |
Slots
| Слот | Описание |
|---|---|
| default | Пользовательское содержимое значка |
Типы
Структура открытых TypeScript-типов этого компонента (автоматически извлечено из packages/components/icon/src/types.ts и исходников @lh-ui/share/core/*; раскройте каждый пункт, чтобы увидеть полное определение; описания свойств — в таблице Props выше):
LhIconProps
ts
/**
* Props компонента Icon
*/
export interface LhIconProps {
/** Название значка */
name?: LhIconName
/** Размер значка */
size?: string | number
/** Цвет значка */
color?: string
/** Тематические переменные уровня компонента, переопределяют конфигурацию ConfigProvider */
themeVars?: Record<string, string>
/** Фоновый узор уровня компонента, переопределяет конфигурацию ConfigProvider */
bgPattern?: string
}LhIconSize
ts
export type LhIconSize = string | numberLhIconName (из @lh-ui/share/core/icon (svgs.ts))
ts
export type LhIconName = keyof typeof LH_ICON_SVGS_CONST