48 lines
712 B
Markdown
48 lines
712 B
Markdown
# `@vuepress-plume/plugin-iconify`
|
|
|
|
添加 `iconify` 图标库支持。并注入全局组件 `<Iconify>`
|
|
|
|
## Install
|
|
|
|
```sh
|
|
npm install @vuepress-plume/plugin-iconify
|
|
# or
|
|
pnpm add @vuepress-plume/plugin-iconify
|
|
# or
|
|
yarn add @vuepress-plume/plugin-iconify
|
|
```
|
|
|
|
## Usage
|
|
|
|
``` js
|
|
// .vuepress/config.[jt]s
|
|
import { iconifyPlugin } from '@vuepress-plume/plugin-iconify'
|
|
|
|
export default {
|
|
// ...
|
|
plugins: [
|
|
iconifyPlugin()
|
|
]
|
|
// ...
|
|
}
|
|
```
|
|
|
|
## Options
|
|
|
|
```ts
|
|
interface IconifyOptions {
|
|
/**
|
|
* 组件名， 默认 `Iconify`
|
|
*/
|
|
componentName?: string
|
|
color?: string
|
|
size?: string | number
|
|
}
|
|
```
|
|
|
|
## Component
|
|
|
|
```vue
|
|
<Iconify name="material-symbols:home" color="currentColor" size="1em" />
|
|
```
|