Browse Source

docs: add instructions for the use of the svg-icon

windyeasy 4 weeks ago
parent
commit
81992f758e
1 changed files with 17 additions and 7 deletions
  1. 17 7
      README.md

+ 17 - 7
README.md

@@ -16,13 +16,13 @@
 - node>=18
 - pnpm>=7.30
 
-- UnoCss https://alfred-skyblue.github.io/unocss-docs-cn/
-- uni-ui https://hellouniapp.dcloud.net.cn/pages/component/view/view
-- uv-ui https://www.uvui.cn/components/intro.html
-- wot-ui https://wot-design-uni.pages.dev/component/button
-- tmui https://tmui.design/
-- firstui https://doc.firstui.cn/docs/introduce.html
-- mockjs https://wll8.github.io/mockjs-examples/
+- UnoCss <https://alfred-skyblue.github.io/unocss-docs-cn/>
+- uni-ui <https://hellouniapp.dcloud.net.cn/pages/component/view/view>
+- uv-ui <https://www.uvui.cn/components/intro.html>
+- wot-ui <https://wot-design-uni.pages.dev/component/button>
+- tmui <https://tmui.design/>
+- firstui <https://doc.firstui.cn/docs/introduce.html>
+- mockjs <https://wll8.github.io/mockjs-examples/>
 
 ## &#x1F4C2; 快速开始
 
@@ -36,6 +36,16 @@
 - weixin 平台:`pnpm dev:mp-weixin` 然后打开微信开发者工具,导入本地文件夹,选择本项目的`dist/dev/mp-weixin` 文件。
 - APP 平台:`pnpm dev:app`, 然后打开 `HBuilderX`,导入刚刚生成的`dist/dev/app` 文件夹,选择运行到模拟器(开发时优先使用),或者运行的安卓/ios 基座。
 
+### `SVG`:使用了[zui-svg-icon](https://ext.dcloud.net.cn/plugin?id=13964)
+
+1. 将`SVG`文件放入到`/assets/svg-icons`文件夹下
+2. 执行`pnpm svg-icon`,生成图标库
+3. 使用图标组件传入`icon`属性即可,`icon`是图标的文件名不包含后缀名,可以传入`width, height, color`
+
+   ```vue
+   <zui-svg-icon icon="arrow-right" color="blue" />
+   ```
+
 ## 🔗 发布
 
 - web 平台: `pnpm build:h5`,打包后的文件在 `dist/build/h5`,可以放到 web 服务器,如 nginx 运行。如果最终不是放在根目录,可以在 `manifest.config.ts` 文件的 `h5.router.base` 属性进行修改。