Skip to content

快速上手

该文档提供快速安装并使用的步骤。

安装

sh
npm install birdpaper-icon
sh
yarn install birdpaper-icon
sh
pnpm add birdpaper-icon

引入

在你的 main.js 或者其他入口文件中引入。

js
import { createApp } from "vue";
import App from "./App.vue";

import BirdpaperIcon from "birdpaper-icon";
import "birdpaper-icon/dist/index.css";

const app = createApp(App);
app.use(BirdpaperIcon).mount("#app");

直接使用

vue
<template>
  <IconVuejsLine />
</template>

动态组件

vue
<template>
  <component :is="IconShareFill"></component>
</template>

<script setup lang="ts">
import { IconShareFill } from "birdpaper-icon";
</script>

Icon 属性

size图标尺寸
String
18px-
fill填充颜色
String
#595959-
spin是否持续旋转
Boolean
false-
rotate旋转角度
Number
--

附加

js
import { iconType, iconInfo, iconNumbers } from "birdpaper-icon";
iconType图标类型数组
String[]
--
iconInfo图标枚举
Array<{name:string, list:string[]}>
--
iconNumbers图标数量
Number
--