How feathericons/feather works
Feather is an icon collection and JavaScript API for using its SVGs. The main runtime workflow exposes named icons, turns an icon into SVG markup, and can replace browser elements marked with data-feather. The repository also includes asset-generation utilities for icon data, standalone SVGs, and SVG sprites. The README documents direct SVG and Figma use as additional distribution options; source excerpts do not show how those external offerings are produced. Some generator relationships are supported only by the source index.
Main entry points: icons.js Icon Catalog · index.js Public API · replace.js DOM Replacement · default-attrs.json Default Attributes
Components 21
Icon Assets
- Icon SVGs
icons - Default Attributes
src/default-attrs.json - Icon Tags
src/tags.json
JavaScript Runtime
- Icon Catalog
src/icons.js - Icon Model
src/icon.js - Public API
src/index.js - SVG Renderer
src/to-svg.js - DOM Replacement
src/replace.js
Asset Generators
- Icon JSON Builder
bin/build-icons-json.js - Icon Object Builder
bin/build-icons-object.js - Standalone SVG Builder
bin/build-svgs.js - Sprite Builder
bin/build-sprite.js - Sprite String Builder
bin/build-sprite-string.js - SVG Optimizer Runner
bin/optimize-svgs.js - SVG Optimizer
bin/optimize-svg.js
SVG Delivery
- Standalone SVGs
icons - SVG Sprite
bin/build-sprite.js - Direct SVG Use
- Figma Library
Other components
- Application User
- Browser DOM
Connections 22
- Icon JSON Builder → Icon SVGs: reads
bin/build-icons-json.js - Icon JSON Builder → Icon Object Builder: calls
bin/build-icons-json.js - Icon Catalog → Icon Model: instantiates
src/icons.js - Icon Catalog → Icon Tags: reads
src/icons.js - Icon Model → Default Attributes: uses
src/icon.js - Public API → Icon Catalog: exports
src/index.js - Public API → SVG Renderer: exports
src/index.js - Public API → DOM Replacement: exports
src/index.js - Application User → Public API: uses
README.md - SVG Renderer → Icon Catalog: reads
src/to-svg.js - DOM Replacement → Icon Catalog: reads
src/replace.js - DOM Replacement → Browser DOM: replaces elements
src/replace.js - Application User → DOM Replacement: requests replacement
README.md - Standalone SVG Builder → Icon Catalog: reads
bin/build-svgs.js - Standalone SVG Builder → Standalone SVGs: writes
bin/build-svgs.js - Sprite Builder → Sprite String Builder: calls
bin/build-sprite.js - Sprite String Builder → Default Attributes: uses
bin/build-sprite-string.js - Sprite Builder → SVG Sprite: writes
bin/build-sprite.js - SVG Optimizer Runner → SVG Optimizer: calls
bin/optimize-svgs.js - SVG Optimizer → Default Attributes: uses
bin/optimize-svg.js - Application User → Direct SVG Use: uses
README.md - Application User → Figma Library: uses
README.md