Feather 开源项目使用教程

2026-01-17 08:54:57作者：贡沫苏Truman

Feather是一个精致优美的开源图标集，专为简洁、一致性和灵活性而设计。每个图标都精心布局在24x24网格上，支持多种网页集成方式：从客户端JavaScript到Node环境，甚至作为Figma组件库。只需简单几步，即可将数据属性转换成优雅的SVG图标，让您的项目瞬间提升美感。无需繁复配置，立刻体验 Feather 的魅力。快速开始：通过CodePen模板或HTML示例，在浏览器中轻松开始原型设计。安装npm包或直接引入脚本文件，调用`feather.replace()`方法，即刻替换页面元素为图标。更进一步，探索Feather的API与相关项目，丰富您的开发工具箱。

项目地址：https://gitcode.com/gh_mirrors/fea/feather

1. 项目的目录结构及介绍

Feather 项目的目录结构如下：

feather/
├── README.md
├── package.json
├── src/
│   ├── icons/
│   │   ├── activity.svg
│   │   ├── airplay.svg
│   │   └── ...
│   └── index.js
└── dist/
    ├── feather.js
    └── feather.min.js

目录介绍

README.md: 项目说明文档，包含项目的基本信息和使用方法。
package.json: 项目的配置文件，包含项目的依赖、脚本等信息。
src/: 源代码目录，包含所有图标的 SVG 文件和入口文件。
- icons/: 存放所有图标的 SVG 文件。
- index.js: 项目的入口文件，负责加载和处理图标。
dist/: 编译后的文件目录，包含用于生产环境的 JavaScript 文件。
- feather.js: 未压缩的 JavaScript 文件。
- feather.min.js: 压缩后的 JavaScript 文件。

2. 项目的启动文件介绍

项目的启动文件是 src/index.js，它负责加载和处理图标。以下是该文件的主要内容：

import icons from './icons';

const feather = {
  icons,
  ...
};

export default feather;

启动文件介绍

导入图标: 通过 import icons from './icons'; 导入所有图标。
创建 feather 对象: 创建一个包含所有图标的 feather 对象，并导出该对象供其他模块使用。

3. 项目的配置文件介绍

项目的配置文件是 package.json，它包含了项目的依赖、脚本等信息。以下是该文件的主要内容：

{
  "name": "feather",
  "version": "4.29.0",
  "description": "Simply beautiful open source icons",
  "main": "dist/feather.js",
  "module": "dist/feather.esm.js",
  "scripts": {
    "build": "rollup -c",
    "watch": "rollup -c -w",
    "test": "jest",
    "prepublishOnly": "npm run build"
  },
  "dependencies": {
    "object-assign": "^4.1.1"
  },
  "devDependencies": {
    "jest": "^26.6.3",
    "rollup": "^2.3.4",
    "rollup-plugin-terser": "^7.0.2"
  },
  "repository": {
    "type": "git",
    "url": "git+https://github.com/colebemis/feather.git"
  },
  "keywords": [
    "icons",
    "svg",
    "feather"
  ],
  "author": "Cole Bemis",
  "license": "MIT",
  "bugs": {
    "url": "https://github.com/colebemis/feather/issues"
  },
  "homepage": "https://github.com/colebemis/feather#readme"
}