{"id":18106705,"url":"https://github.com/waset/unplugin-iconify","last_synced_at":"2025-08-25T08:05:29.602Z","repository":{"id":258302800,"uuid":"874104006","full_name":"waset/unplugin-iconify","owner":"waset","description":"🔥 按目录解析 svg 文件并打包为 iconify json，通过 unplugin 开发，支持多个打包工具，适配 vscode、unocss 等","archived":false,"fork":false,"pushed_at":"2025-04-04T14:11:58.000Z","size":314,"stargazers_count":3,"open_issues_count":8,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-04-04T15:24:49.472Z","etag":null,"topics":["iconify","nuxt","unocss","unplugin","vite","vscode","webpack"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/@waset/unplugin-iconify","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/waset.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-10-17T09:02:43.000Z","updated_at":"2025-01-17T10:03:22.000Z","dependencies_parsed_at":"2024-11-15T19:31:32.309Z","dependency_job_id":"a5524139-608c-4eb3-b3d1-655b523eb936","html_url":"https://github.com/waset/unplugin-iconify","commit_stats":null,"previous_names":["waset/unplugin-iconify"],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/waset%2Funplugin-iconify","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/waset%2Funplugin-iconify/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/waset%2Funplugin-iconify/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/waset%2Funplugin-iconify/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/waset","download_url":"https://codeload.github.com/waset/unplugin-iconify/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248788866,"owners_count":21161726,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["iconify","nuxt","unocss","unplugin","vite","vscode","webpack"],"created_at":"2024-10-31T23:07:48.026Z","updated_at":"2025-04-13T21:41:38.161Z","avatar_url":"https://github.com/waset.png","language":"TypeScript","readme":"# unplugin-iconify\n\n[![NPM version](https://img.shields.io/npm/v/@waset/unplugin-iconify?color=blue)](https://www.npmjs.com/package/@waset/unplugin-iconify)\n\n## 安装\n\n```bash\npnpm i -D @waset/unplugin-iconify\n```\n\n## 使用\n\n```ts\nIconify({\n  /**\n   * 工作区路径\n   * @description 项目根目录\n   * @default process.cwd()\n   */\n  workspace: cwd(),\n  /**\n   * 图标转换配置\n   */\n  convert: {\n    // 直接导出目录\n    svg: 'assets/icons',\n    // 不导出颜色\n    icon: {\n      path: 'assets/icons',\n      noColor: true,\n    },\n    // 不导出颜色且添加后缀\n    suffix: {\n      path: 'assets/icons',\n      noColor: true,\n      suffix: 'color',\n    },\n  },\n\n  /**\n   * 输出目录\n   * @type string\n   * @default `path.join(process.cwd(), 'node_modules/.unplugin-iconify')`\n   */\n  output: 'dist/icons',\n\n  /**\n   * 是否适配 VSCode 插件 Iconify IntelliSense\n   * @type boolean | string\n   * @default false\n   */\n  iconifyIntelliSense: true,\n})\n```\n\n#### 补充\n\n- 如果开启 `iconifyIntelliSense`将自动创建/更新 `.vscode/settings.json` 文件，用于 VSCode 插件 [Iconify IntelliSense](https://marketplace.visualstudio.com/items?itemName=antfu.iconify)\n\n- 请查看 [`src/core/types.ts`](https://github.com/waset/unplugin-iconify/blob/main/src/core/types.ts) 获取更多类型信息。\n\n#### 用例\n\n\u003e 参照上述 `convert` 配置，如果拥有 `assets/icons/cat.svg`,将会生成以下 `iconify` 图标\n\n- `icon-cat` `icon:cat` `i-icon-cat`\n- `svg-cat` `svg:cat` `i-svg-cat`\n- `suffix-cat-color` `suffix:cat-color` `i-suffix-cat-color`\n\n## 配置\n\n\u003cdetails\u003e\n\u003csummary\u003eVite\u003c/summary\u003e\n\n```ts\n// vite.config.ts\nimport Iconify from '@waset/unplugin-iconify/vite'\n\nexport default defineConfig({\n  plugins: [\n    Iconify({\n      // ...\n    })\n  ],\n})\n```\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003eNuxt\u003c/summary\u003e\n\n```ts\n// nuxt.config.ts\nimport { defineNuxtConfig } from 'nuxt/config'\n\n// https://nuxt.com/docs/api/configuration/nuxt-config\nexport default defineNuxtConfig({\n  modules: [\n    // ...\n    '@waset/unplugin-iconify/nuxt'\n  ],\n  Iconify: {\n    // ...\n  },\n})\n```\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003eUnocss\u003c/summary\u003e\n\n```ts\n// uno.config.ts\nimport { UnocssLoader } from '@waset/unplugin-iconify/loader'\nimport { defineConfig, presetIcons } from 'unocss'\n\nexport default defineConfig({\n  presets: [\n    // ...\n    presetIcons({\n      scale: 1.2,\n      warn: true,\n      extraProperties: {\n        'display': 'inline-block',\n        'vertical-align': 'middle',\n      },\n      collections: {\n        ...UnocssLoader(/** output */),\n      },\n    }),\n  ],\n  // ...\n})\n```\n\u003c/details\u003e\n\n## 感谢\n\n- [unplugin](https://github.com/unjs/unplugin)\n- [unplugin/unplugin-icons](https://github.com/unplugin/unplugin-icons)\n- [unocss](https://unocss.dev/presets/icons)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwaset%2Funplugin-iconify","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwaset%2Funplugin-iconify","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwaset%2Funplugin-iconify/lists"}