Skip to content

Installation

Package Manager

bash
pnpm add @fuxishi/svg-icon
bash
npm install @fuxishi/svg-icon
bash
yarn add @fuxishi/svg-icon

Peer Dependencies

@fuxishi/svg-icon requires the following peer dependency:

DependencyVersionRequired
vue^3.5.33Yes
bash
pnpm add vue

Optional Dependencies

The following UI frameworks are optional. Installing them automatically enables the corresponding icon selector preset:

DependencyPurpose
element-plusElement Plus preset
naive-uiNaive UI preset
antdv-nextAntDv Next preset
tdesign-vue-nextTDesign preset

After installing a UI framework, FxIconSelect will automatically detect and load the corresponding preset component without manual configuration.

Icon Collection Packages

To use Iconify icon collections, install the corresponding @iconify-json packages:

bash
# Element Plus icons
pnpm add -D @iconify-json/ep

# Ant Design icons
pnpm add -D @iconify-json/ant-design

# Material Design Icons
pnpm add -D @iconify-json/mdi

You can find all available icon sets at Iconify Icon Sets.

Full Installation Example

For an Element Plus project:

bash
pnpm add @fuxishi/svg-icon element-plus @element-plus/icons-vue @iconify-json/ep