feather

feather

开源矢量图标库 简洁灵活易用

Feather开源图标库提供超过280个精心设计的SVG图标。采用24x24网格设计,确保视觉一致性。支持JavaScript、Node.js和SVG精灵图等多种使用方式,并可自定义属性。提供Figma组件库便于设计工作。Feather以简洁灵活著称,广泛应用于Web和移动应用界面设计。

Feather图标库SVG开源JavaScriptGithub开源项目

Feather

覆盖率 npm 下载量 npm 版本 CDNJS 版本

Feather 是什么?

Feather 是一个简洁优美的开源图标集合。每个图标都设计在 24x24 的网格上,强调简洁、一致性和灵活性。

https://feathericons.com

npm install feather-icons

目录

快速开始

使用这个 CodePen 模板 开始在浏览器中使用 Feather 进行原型设计。

或者将以下代码片段复制并粘贴到一个空白的 html 文件中。

<!DOCTYPE html> <html lang="zh"> <title></title> <script src="https://unpkg.com/feather-icons"></script> <body> <!-- 示例图标 --> <i data-feather="circle"></i> <script> feather.replace(); </script> </body> </html>

使用方法

Feather 的核心是一个 SVG 文件集合。这意味着你可以像使用 SVG 一样使用 Feather 图标(例如 imgbackground-imageinlineobjectembediframe)。这里有一篇有用的文章详细介绍了 SVG 在网络上的多种使用方式:SVG on the Web – Implementation Options

以下是使用 Feather 的其他方法。

客户端 JavaScript

1. 安装

[!注意] 如果你打算使用 CDN 来使用 Feather,可以跳过这个安装步骤。

使用 npm 安装。

npm install feather-icons --save

或者直接将 feather.jsfeather.min.js 复制到你的项目目录中。你不需要同时使用 feather.jsfeather.min.js

2. 引入

使用 <script> 标签引入 feather.jsfeather.min.js

<script src="path/to/dist/feather.js"></script>

[!注意] > feather.jsfeather.min.js 位于 npm 包的 dist 目录中。

或者从 CDN 提供商加载脚本:

<!-- 选择其中一个 --> <script src="https://unpkg.com/feather-icons"></script> <script src="https://cdn.jsdelivr.net/npm/feather-icons/dist/feather.min.js"></script>

引入脚本后,feather 将作为全局变量可用。

3. 使用

要在页面上使用图标,给元素添加一个带有图标名称的 data-feather 属性:

<i data-feather="circle"></i>

feathericons.com 查看完整的图标列表。

4. 替换

调用 feather.replace() 方法:

<script> feather.replace(); </script>

所有带有 data-feather 属性的元素都会被替换为与其 data-feather 属性值相对应的 SVG 标记。有关 feather.replace() 的更多信息,请参阅 API 参考

Node

1. 安装

使用 npm 安装:

npm install feather-icons --save

2. 引入

const feather = require('feather-icons');

3. 使用

feather.icons.x; // { // name: 'x', // contents: '<line ... /><line ... />`, // tags: ['cancel', 'close', 'delete', 'remove'], // attrs: { // class: 'feather feather-x', // xmlns: 'http://www.w3.org/2000/svg', // width: 24, // height: 24, // viewBox: '0 0 24 24', // fill: 'none', // stroke: 'currentColor', // 'stroke-width': 2, // 'stroke-linecap': 'round', // 'stroke-linejoin': 'round', // }, // toSvg: [Function], // } feather.icons.x.toSvg(); // <svg class="feather feather-x" ...><line ... /><line ... /></svg> feather.icons.x.toSvg({ class: 'foo bar', 'stroke-width': 1, color: 'red' }); // <svg class="feather feather-x foo bar" stroke-width="1" color="red" ...><line ... /><line ... /></svg>

有关 feather 对象的可用属性和方法的更多信息,请参阅 API 参考

SVG 精灵图

1. 安装

[!注意] 如果你打算使用 CDN 来使用 Feather,可以跳过这个安装步骤。

使用 npm 安装。

npm install feather-icons --save

或者直接将 feather-sprite.svg 复制到你的项目目录中。

2. 使用

使用以下标记在页面中包含一个图标:

<svg width="24" height="24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" > <use href="path/to/feather-sprite.svg#circle" /> </svg>

[!注意] > 上面示例中的 circle 可以替换为任何有效的图标名称。完整的图标名称列表请参见 feathericons.com

然而,可以使用一个简单的 CSS 类来简化这个标记,避免在图标之间重复 SVG 属性:

.feather { width: 24px; height: 24px; stroke: currentColor; stroke-width: 2; stroke-linecap: round; stroke-linejoin: round; fill: none; }
<svg class="feather"> <use href="path/to/dist/feather-sprite.svg#circle" /> </svg>

Figma

Feather 可作为 Figma 组件库 使用。要使用这些组件,请登录你的 Figma 账户并将文件复制到你的草稿中。

API 参考

feather.icons

包含每个图标数据的对象。

用法

feather.icons.x; // { // name: 'x', // contents: '<line ... /><line ... />', // tags: ['cancel', 'close', 'delete', 'remove'], // attrs: { // class: 'feather feather-x', // xmlns: 'http://www.w3.org/2000/svg', // width: 24, // height: 24, // viewBox: '0 0 24 24', // fill: 'none', // stroke: 'currentColor', // 'stroke-width': 2, // 'stroke-linecap': 'round', // 'stroke-linejoin': 'round', // }, // toSvg: [Function], // } feather.icons.x.toString(); // '<line ... /><line ... />'

[!注意] > 上面示例中的 x 可以替换为任何有效的图标名称。完整的图标名称列表请参见 feathericons.com。多词名称的图标(如 arrow-right不能使用点notation访问(如 feather.icons.x)。请改用方括号notation(如 feather.icons['arrow-right'])。

查看源码


feather.icons[name].toSvg([attrs])

返回一个 SVG 字符串。

参数

名称类型描述
attrs (可选的)Objectattrs 对象中的键值对会被映射到 <svg> 标签上的 HTML 属性(例如 { foo: 'bar' } 映射为 foo="bar")。<svg> 标签上的所有默认属性都可以通过 attrs 对象覆盖。

[!注意] 你可能会发现这些 SVG 属性对于操作图标很有帮助:

用法

feather.icons.circle.toSvg(); // '<svg class="feather feather-circle" xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><circle cx="12" cy="12" r="10"></circle></svg>' feather.icons.circle.toSvg({ 'stroke-width': 1 }); // '<svg class="feather feather-circle" xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1" stroke-linecap="round" stroke-linejoin="round"><circle cx="12" cy="12" r="10"></circle></svg>' feather.icons.circle.toSvg({ class: 'foo bar' }); // '<svg class="feather feather-circle foo bar" xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><circle cx="12" cy="12" r="10"></circle></svg>'

查看源码


feather.replace([attrs])

将所有具有 data-feather 属性的元素替换为与元素的 data-feather 属性值相对应的 SVG 标记。

参数

名称类型描述
attrs (可选的)Objectattrs 对象中的键值对会被映射到 <svg> 标签上的 HTML 属性(例如 { foo: 'bar' } 映射为 foo="bar")。<svg> 标签上的所有默认属性都可以通过 attrs 对象覆盖。

用法

[!重要] > feather.replace() 只在浏览器环境中工作。

简单用法:

<i data-feather="circle"></i> <!-- <i> 将被替换为: <svg class="feather feather-circle" xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><circle cx="12" cy="12" r="10"></circle></svg> --> <script> feather.replace(); </script>

你可以给 feather.replace() 传递一个 attrs 对象:

<i data-feather="circle"></i> <!-- <i> 将被替换为: <svg class="feather feather-circle foo bar" xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1" stroke-linecap="round" stroke-linejoin="round"><circle cx="12" cy="12" r="10"></circle></svg> --> <script> feather.replace({ class: 'foo bar', 'stroke-width': 1 }); </script>

占位元素(即 <i>)上的所有属性都将被复制到 <svg> 标签上:

<i data-feather="circle" id="my-circle" class="foo bar" stroke-width="1"></i> <!-- <i> 将被替换为: <svg id="my-circle" class="feather feather-circle foo bar" xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1" stroke-linecap="round" stroke-linejoin="round"><circle cx="12" cy="12" r="10"></circle></svg> --> <script> feather.replace(); </script>

查看源码


feather.toSvg(name, [attrs]) (已废弃)

[!警告] > feather.toSvg() 已被废弃。请使用 feather.icons[name].toSvg() 代替。

返回一个SVG字符串。

参数

名称类型描述
name字符串图标名称
attrs (可选)对象attrs 对象中的键值对将被映射到 <svg> 标签上的HTML属性(例如 { foo: 'bar' } 映射为 foo="bar")。<svg> 标签上的所有默认属性都可以通过 attrs 对象覆盖。

用法

feather.toSvg('circle'); // '<svg class="feather feather-circle" xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><circle cx="12" cy="12" r="10"></circle></svg>' feather.toSvg('circle', { 'stroke-width': 1 }); // '<svg class="feather feather-circle" xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1" stroke-linecap="round" stroke-linejoin="round"><circle cx="12" cy="12" r="10"></circle></svg>' feather.toSvg('circle', { class: 'foo bar' }); // '<svg class="feather feather-circle foo bar" xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><circle cx="12" cy="12" r="10"></circle></svg>'

查看源码

贡献

关于如何贡献的更多信息,请参阅贡献指南

发现错误或想为文档做贡献?在Github上编辑此页面

相关项目

许可证

Feather 采用 MIT 许可证授权。

编辑推荐精选

Trae

Trae

字节跳动发布的AI编程神器IDE

Trae是一种自适应的集成开发环境(IDE),通过自动化和多元协作改变开发流程。利用Trae,团队能够更快速、精确地编写和部署代码,从而提高编程效率和项目交付速度。Trae具备上下文感知和代码自动完成功能,是提升开发效率的理想工具。

AI工具TraeAI IDE协作生产力转型热门
问小白

问小白

全能AI智能助手,随时解答生活与工作的多样问题

问小白,由元石科技研发的AI智能助手,快速准确地解答各种生活和工作问题,包括但不限于搜索、规划和社交互动,帮助用户在日常生活中提高效率,轻松管理个人事务。

热门AI助手AI对话AI工具聊天机器人
Transly

Transly

实时语音翻译/同声传译工具

Transly是一个多场景的AI大语言模型驱动的同声传译、专业翻译助手,它拥有超精准的音频识别翻译能力,几乎零延迟的使用体验和支持多国语言可以让你带它走遍全球,无论你是留学生、商务人士、韩剧美剧爱好者,还是出国游玩、多国会议、跨国追星等等,都可以满足你所有需要同传的场景需求,线上线下通用,扫除语言障碍,让全世界的语言交流不再有国界。

讯飞智文

讯飞智文

一键生成PPT和Word,让学习生活更轻松

讯飞智文是一个利用 AI 技术的项目,能够帮助用户生成 PPT 以及各类文档。无论是商业领域的市场分析报告、年度目标制定,还是学生群体的职业生涯规划、实习避坑指南,亦或是活动策划、旅游攻略等内容,它都能提供支持,帮助用户精准表达,轻松呈现各种信息。

AI办公办公工具AI工具讯飞智文AI在线生成PPTAI撰写助手多语种文档生成AI自动配图热门
讯飞星火

讯飞星火

深度推理能力全新升级,全面对标OpenAI o1

科大讯飞的星火大模型,支持语言理解、知识问答和文本创作等多功能,适用于多种文件和业务场景,提升办公和日常生活的效率。讯飞星火是一个提供丰富智能服务的平台,涵盖科技资讯、图像创作、写作辅助、编程解答、科研文献解读等功能,能为不同需求的用户提供便捷高效的帮助,助力用户轻松获取信息、解决问题,满足多样化使用场景。

热门AI开发模型训练AI工具讯飞星火大模型智能问答内容创作多语种支持智慧生活
Spark-TTS

Spark-TTS

一种基于大语言模型的高效单流解耦语音令牌文本到语音合成模型

Spark-TTS 是一个基于 PyTorch 的开源文本到语音合成项目,由多个知名机构联合参与。该项目提供了高效的 LLM(大语言模型)驱动的语音合成方案,支持语音克隆和语音创建功能,可通过命令行界面(CLI)和 Web UI 两种方式使用。用户可以根据需求调整语音的性别、音高、速度等参数,生成高质量的语音。该项目适用于多种场景,如有声读物制作、智能语音助手开发等。

咔片PPT

咔片PPT

AI助力,做PPT更简单!

咔片是一款轻量化在线演示设计工具,借助 AI 技术,实现从内容生成到智能设计的一站式 PPT 制作服务。支持多种文档格式导入生成 PPT,提供海量模板、智能美化、素材替换等功能,适用于销售、教师、学生等各类人群,能高效制作出高品质 PPT,满足不同场景演示需求。

讯飞绘文

讯飞绘文

选题、配图、成文,一站式创作,让内容运营更高效

讯飞绘文,一个AI集成平台,支持写作、选题、配图、排版和发布。高效生成适用于各类媒体的定制内容,加速品牌传播,提升内容营销效果。

热门AI辅助写作AI工具讯飞绘文内容运营AI创作个性化文章多平台分发AI助手
材料星

材料星

专业的AI公文写作平台,公文写作神器

AI 材料星,专业的 AI 公文写作辅助平台,为体制内工作人员提供高效的公文写作解决方案。拥有海量公文文库、9 大核心 AI 功能,支持 30 + 文稿类型生成,助力快速完成领导讲话、工作总结、述职报告等材料,提升办公效率,是体制打工人的得力写作神器。

openai-agents-python

openai-agents-python

OpenAI Agents SDK,助力开发者便捷使用 OpenAI 相关功能。

openai-agents-python 是 OpenAI 推出的一款强大 Python SDK,它为开发者提供了与 OpenAI 模型交互的高效工具,支持工具调用、结果处理、追踪等功能,涵盖多种应用场景,如研究助手、财务研究等,能显著提升开发效率,让开发者更轻松地利用 OpenAI 的技术优势。

下拉加载更多