Skip to content

xtf-icon

组件说明

xtf-icon 是图标组件,基于 Remix Icon 字体图标库。支持主题色、变体样式、预设尺寸、旋转动画和徽标,适用于导航图标、操作按钮图标和状态图标等场景。


基础用法

1. 基础用法

通过 name 指定图标名称:

vue
<template>
  <view style="display: flex; gap: 32rpx">
    <xtf-icon name="home" />
    <xtf-icon name="search" />
    <xtf-icon name="favorite" />
    <xtf-icon name="settings" />
  </view>
</template>

2. 主题与变体

通过 theme 设置主题色,通过 variant 设置变体样式:

vue
<template>
  <view style="display: flex; gap: 32rpx">
    <xtf-icon name="check_circle" theme="success" />
    <xtf-icon name="warning" theme="warning" />
    <xtf-icon name="error" theme="danger" />
    <xtf-icon name="info" theme="info" variant="soft" padding="16rpx" round />
  </view>
</template>

3. 尺寸与颜色

通过 size 设置尺寸,通过 color 自定义颜色:

vue
<template>
  <view style="display: flex; align-items: center; gap: 32rpx">
    <xtf-icon name="home" size="xs" />
    <xtf-icon name="home" size="sm" />
    <xtf-icon name="home" size="md" />
    <xtf-icon name="home" size="lg" />
    <xtf-icon name="home" size="xl" />
    <xtf-icon name="home" color="#ff6700" />
  </view>
</template>

4. 旋转与徽标

通过 spin 启用旋转动画,通过 badge 显示徽标:

vue
<template>
  <view style="display: flex; gap: 32rpx">
    <xtf-icon name="refresh" spin />
    <xtf-icon name="notifications" badge="5" />
    <xtf-icon name="shopping_cart" dot />
  </view>
</template>

全部属性

属性类型默认值作用描述适用范围
nameString''图标名称图标
sizeString | Number'md'尺寸(xs/sm/md/lg/xl 或自定义)尺寸
colorString''自定义颜色颜色
themeString'primary'主题色主题
variantString'plain'变体样式(plain/soft)样式
filledBooleanfalse是否填充风格风格
weightString | Number300字重样式
gradString | Number0字体可变轴 grad 值;当前实现仅接收属性,不改变渲染API 对齐
opszString | Number24字体可变轴 opsz 值;当前实现仅接收属性,不改变渲染API 对齐
bgString''背景色背景
paddingString | Number0内边距布局
radiusString | Number''圆角样式
roundBooleanfalse是否圆形形状
clickableBooleanfalse是否可点击交互
spinBooleanfalse是否旋转动画
pulseBooleanfalse是否脉冲动画
dotBooleanfalse是否显示圆点徽标
badgeString | Number''徽标内容徽标
badgeMaxString | Number99徽标最大值徽标
customClassString''自定义类名样式覆盖
customStyleString | Object''自定义样式动态样式覆盖

事件

事件名称触发时机回调参数参数说明
clickclickabletrue 时点击触发(event)原始点击事件对象

主题说明

  • 支持 primarysuccesswarningdangerinfosecondarydisabledinverse 主题色
  • variant="soft" 时自动使用对应主题色的浅色背景
  • 预设尺寸:xs(24rpx)、sm(32rpx)、md(40rpx)、lg(52rpx)、xl(68rpx)
  • 图标名称支持 Material Icons 和 Remix Icon 两种命名风格

如需全局调整主题,请在 xtf-config-provider 或主题配置中覆盖相关 CSS 变量。

MIT Licensed