[ { "path": ".babelrc", "content": "{\n \"presets\": [\n [\n \"env\",\n {\n \"targets\": {\n \"browsers\": [\"last 2 versions\"]\n }\n }\n ],\n \"stage-2\"\n ]\n}\n" }, { "path": ".changeset/README.md", "content": "# Changesets\n\nHello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works with mono-repos or single package repos to help you version and release your code. You can find the full documentation for it [in our repository](https://github.com/changesets/changesets)\n\nWe have a quick list of common questions to get you started engaging with this project in [our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)\n" }, { "path": ".changeset/config.json", "content": "{\n \"$schema\": \"https://unpkg.com/@changesets/config@2.3.1/schema.json\",\n \"changelog\": [\n \"@changesets/changelog-github\",\n { \"repo\": \"feathericons/feather\" }\n ],\n \"commit\": false,\n \"fixed\": [],\n \"linked\": [],\n \"access\": \"public\",\n \"baseBranch\": \"main\",\n \"updateInternalDependencies\": \"patch\",\n \"ignore\": []\n}\n" }, { "path": ".eslintignore", "content": "dist\ncoverage" }, { "path": ".eslintrc.js", "content": "module.exports = {\n env: {\n browser: true,\n es2021: true,\n node: true,\n },\n extends: 'eslint:recommended',\n overrides: [\n {\n env: {\n node: true,\n },\n files: ['.eslintrc.{js,cjs}'],\n parserOptions: {\n sourceType: 'script',\n },\n },\n ],\n parserOptions: {\n ecmaVersion: 'latest',\n sourceType: 'module',\n },\n rules: {},\n};\n" }, { "path": ".github/CODEOWNERS", "content": "* @colebemis\n" }, { "path": ".github/ISSUE_TEMPLATE/01-icon-request.yml", "content": "name: πŸ™ Icon request\ndescription: Request a new icon\ntitle: 'Icon request: '\nlabels: ['icon request']\nprojects: ['feathericons/1']\nbody:\n - type: input\n id: icon-name\n attributes:\n label: Icon name\n placeholder: e.g. star\n validations:\n required: true\n - type: textarea\n id: use-case\n attributes:\n label: Use case\n description: Please describe your use case for the requested icon.\n placeholder: e.g. I need a star icon to use in my rating system.\n validations:\n required: true\n - type: textarea\n id: screenshots\n attributes:\n label: Screenshots of similar icons\n description: Please attach screenshots of similar icons from other icon sets to help us visualize your request.\n placeholder: e.g. ![Screenshot of similar icon](https://example.com/screenshot.png)\n validations:\n required: true\n - type: checkboxes\n id: checklist\n attributes:\n label: Checklist\n description: Please check the following items before submitting your request.\n options:\n - label: I have searched the existing icons to make sure this icon does not already exist.\n required: true\n - label: I have searched the existing issues to make sure this icon has not already been requested.\n required: true\n - label: This icon is not a logo.\n required: true\n" }, { "path": ".github/ISSUE_TEMPLATE/02-bug-report.yml", "content": "name: πŸ› Bug report\ndescription: Report a bug\ntitle: 'Bug: '\nlabels: ['bug']\nprojects: ['feathericons/1']\nbody:\n - type: textarea\n id: description\n attributes:\n label: Description\n description: \"Tell us more about the problem that you're running into.\"\n placeholder: 'e.g. When I try to do X, Y happens instead of Z'\n validations:\n required: true\n - type: textarea\n id: reproduce\n attributes:\n label: Steps to reproduce\n description: 'How can we reproduce the error you described above? Please provide a link to a live example, or steps to reproduce locally.'\n placeholder: |\n 1. Go to '...'\n 2. Click on '....'\n 3. Scroll down to '....'\n 4. See error\n validations:\n required: true\n - type: input\n id: version\n attributes:\n label: Version\n description: 'What version of `feather-icons` are you using?'\n placeholder: e.g. v4.29.0\n validations:\n required: false\n - type: dropdown\n id: browser\n attributes:\n label: Browser\n description: In which browser(s) are you experiencing the issue?\n multiple: true\n options:\n - Chrome\n - Safari\n - Firefox\n - Edge\n - iOS Safari\n - Other\n validations:\n required: false\n - type: dropdown\n id: os\n attributes:\n label: Operating system\n description: On which operating system(s) are you experiencing the issue?\n multiple: true\n options:\n - macOS\n - Windows\n - Linux\n - iOS\n - Android\n - Other\n validations:\n required: false\n - type: checkboxes\n id: checklist\n attributes:\n label: Checklist\n description: Please check the following items before submitting your issue.\n options:\n - label: I have searched the existing issues to make sure this bug has not already been reported.\n required: true\n" }, { "path": ".github/workflows/ci.yml", "content": "name: CI\n\non: push\n\njobs:\n ci:\n name: CI\n runs-on: ubuntu-latest\n steps:\n - name: Checkout repository\n uses: actions/checkout@v3\n\n - name: Setup Node.js 16.x\n uses: actions/setup-node@v3\n with:\n node-version: 16.x\n cache: 'npm'\n\n - name: Install dependencies\n run: npm ci --legacy-peer-deps\n\n - name: Build\n run: npm run build\n\n - name: Test\n run: npm run test:coverage\n\n - name: Lint\n run: npm run lint\n\n - name: Optimize SVGs\n run: |\n npm run optimize-svgs\n if git diff --quiet; then\n echo \"All SVGs are optimized βœ”οΈŽ\"\n else\n echo \"The following SVGs are not optimized:\"\n git diff --name-only\n echo\n echo \"Please run 'npm run optimize-svgs' and commit the changes\"\n exit 1\n fi\n" }, { "path": ".github/workflows/release.yml", "content": "name: Release\n\non:\n push:\n branches:\n - main\n\nconcurrency: ${{ github.workflow }}-${{ github.ref }}\n\njobs:\n release:\n name: Release\n runs-on: ubuntu-latest\n steps:\n - name: Checkout repository\n uses: actions/checkout@v3\n\n - name: Setup Node.js 16.x\n uses: actions/setup-node@v3\n with:\n node-version: 16.x\n cache: 'npm'\n\n - name: Install dependencies\n run: npm ci --legacy-peer-deps\n\n - name: Create release pull request or publish to npm\n id: changesets\n uses: changesets/action@v1\n with:\n title: 'Release'\n publish: npm run release\n env:\n GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n NPM_TOKEN: ${{ secrets.NPM_TOKEN }}\n" }, { "path": ".gitignore", "content": ".DS_Store\nnode_modules\ndist\nsandbox\nstash\ncoverage" }, { "path": ".lintstagedrc", "content": "{\n \"*.js\": \"eslint\"\n}\n" }, { "path": ".prettierignore", "content": "dist\ncoverage\n" }, { "path": "CHANGELOG.md", "content": "# feather-icons\n\n## 4.29.2\n\n### Patch Changes\n\n- [#1241](https://github.com/feathericons/feather/pull/1241) [`6e449d4`](https://github.com/feathericons/feather/commit/6e449d481e7ec7568103289eb4494999843b68ce) Thanks [@braden-godley](https://github.com/braden-godley)! - Feather no longer breaks when trying to replace an icon using an invalid name\n\n## 4.29.1\n\n### Patch Changes\n\n- [#1213](https://github.com/feathericons/feather/pull/1213) [`8f0cc0e`](https://github.com/feathericons/feather/commit/8f0cc0e6667e88b7de391ccaf75820a6e57f4f13) Thanks [@colebemis](https://github.com/colebemis)! - Test [changesets](https://github.com/changesets/changesets) release\n" }, { "path": "CODE_OF_CONDUCT.md", "content": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as\ncontributors and maintainers pledge to making participation in our project and\nour community a harassment-free experience for everyone, regardless of age, body\nsize, disability, ethnicity, gender identity and expression, level of experience,\nnationality, personal appearance, race, religion, or sexual identity and\norientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment\ninclude:\n\n- Using welcoming and inclusive language\n- Being respectful of differing viewpoints and experiences\n- Gracefully accepting constructive criticism\n- Focusing on what is best for the community\n- Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n- The use of sexualized language or imagery and unwelcome sexual attention or\n advances\n- Trolling, insulting/derogatory comments, and personal or political attacks\n- Public or private harassment\n- Publishing others' private information, such as a physical or electronic\n address, without explicit permission\n- Other conduct which could reasonably be considered inappropriate in a\n professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable\nbehavior and are expected to take appropriate and fair corrective action in\nresponse to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or\nreject comments, commits, code, wiki edits, issues, and other contributions\nthat are not aligned to this Code of Conduct, or to ban temporarily or\npermanently any contributor for other behaviors that they deem inappropriate,\nthreatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces\nwhen an individual is representing the project or its community. Examples of\nrepresenting a project or community include using an official project e-mail\naddress, posting via an official social media account, or acting as an appointed\nrepresentative at an online or offline event. Representation of a project may be\nfurther defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be\nreported by contacting the project team at cole@colebemis.com. All\ncomplaints will be reviewed and investigated and will result in a response that\nis deemed necessary and appropriate to the circumstances. The project team is\nobligated to maintain confidentiality with regard to the reporter of an incident.\nFurther details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good\nfaith may face temporary or permanent repercussions as determined by other\nmembers of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,\navailable at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n" }, { "path": "CONTRIBUTING.md", "content": "# Contribution guidelines\n\nFirst off, thanks for taking the time to contribute!\n\nThe following is a set of guidelines for contributing to Feather. Feel free to propose changes to this document in a pull request.\n\n## Pull requests\n\n> [!IMPORTANT]\n> We are not accepting pull requests containing **icons**. If you want to add a new icon, please create an [icon request](#icon-requests).\n\nPull requests for bug fixes and improvements are welcome. If you’re not sure if something is worth doing, please open an issue first.\n\n**Working on your first Pull Request?** You can learn how from this _free_ series\n[How to Contribute to an Open Source Project on GitHub](https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github).\n\nHere are a few things you can do that will increase the likelihood of your pull request being accepted:\n\n- **Make your commit messages as descriptive as possible.** Include as much information as you can. Explain anything that might be unclear.\n- **Document your pull request**. Explain your changes, link to the relevant issue, and add screenshots when applicable.\n- **Include only related work**. If you have unrelated changes, please split them into separate pull requests.\n\n## Icon requests\n\nTo request a new icon, please fill out the [icon request form](https://github.com/feathericons/feather/issues/new?template=01-icon-request.yml).\n\n## Bug reports\n\nTo report a bug, please fill out the [bug report form](https://github.com/feathericons/feather/issues/new?template=02-bug-report.yml).\n\n## Local development\n\nFollow these steps to set up Feather for local development:\n\n```shell\n# 1. Clone the repository\ngit clone https://github.com/feathericons/feather.git\ncd feather\n\n# 2. Run setup script\nnpm run setup\n```\n" }, { "path": "LICENSE", "content": "The MIT License (MIT)\n\nCopyright (c) 2013-2023 Cole Bemis\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n" }, { "path": "README.md", "content": "# Feather\n\n[![Coverage](https://img.shields.io/codecov/c/github/feathericons/feather/master.svg?style=flat-square)](https://codecov.io/gh/feathericons/feather)\n[![npm downloads](https://img.shields.io/npm/dm/feather-icons.svg?style=flat-square)](https://www.npmjs.com/package/feather-icons)\n[![npm version](https://img.shields.io/npm/v/feather-icons.svg?style=flat-square)](https://www.npmjs.com/package/feather-icons)\n[![CDNJS version](https://img.shields.io/cdnjs/v/feather-icons.svg?style=flat-square)](https://cdnjs.com/libraries/feather-icons)\n\n## What is Feather?\n\nFeather is a collection of simply beautiful open-source icons. Each icon is designed on a 24x24 grid with an emphasis on simplicity, consistency, and flexibility.\n\nhttps://feathericons.com\n\n```shell\nnpm install feather-icons\n```\n\n## Table of contents\n\n- [Quick start](#quick-start)\n- [Usage](#usage)\n - [Client-side JavaScript](#client-side-javascript)\n - [Node](#node)\n - [SVG sprite](#svg-sprite)\n - [Figma](#figma)\n- [API reference](#api-reference)\n - [`feather.icons`](#feathericons)\n - [`feather.icons[name].toSvg()`](#feathericonsnametosvgattrs)\n - [`feather.replace()`](#featherreplaceattrs)\n - [`feather.toSvg()` (DEPRECATED) ](#feathertosvgname-attrs-deprecated)\n- [Contributing](#contributing)\n- [Related projects](#related-projects)\n- [License](#license)\n\n## Quick start\n\nStart with this [CodePen Template](https://codepen.io/pen?template=WOJZdM) to begin prototyping with Feather in the browser.\n\nOr copy and paste the following code snippet into a blank `html` file.\n\n```html\n\n\n \n \n \n \n \n\n \n \n\n```\n\n## Usage\n\nAt its core, Feather is a collection of [SVG](https://svgontheweb.com/#svg) files. This means that you can use Feather icons in all the same ways you can use SVGs (e.g. `img`, `background-image`, `inline`, `object`, `embed`, `iframe`). Here's a helpful article detailing the many ways SVGs can be used on the web: [SVG on the Web – Implementation Options](https://svgontheweb.com/#implementation)\n\nThe following are additional ways you can use Feather.\n\n### Client-side JavaScript\n\n#### 1. Install\n\n> [!NOTE]\n> If you intend to use Feather with a CDN, you can skip this installation step.\n\nInstall with [npm](https://docs.npmjs.com/getting-started/what-is-npm).\n\n```shell\nnpm install feather-icons --save\n```\n\nOr just copy [`feather.js`](https://unpkg.com/feather-icons/dist/feather.js) or [`feather.min.js`](https://unpkg.com/feather-icons/dist/feather.min.js) into your project directory. You don't need both `feather.js` and `feather.min.js`.\n\n#### 2. Include\n\nInclude `feather.js` or `feather.min.js` with a `\n```\n\n> [!NOTE]\n> `feather.js` and `feather.min.js` are located in the `dist` directory of the npm package.\n\nOr load the script from a CDN provider:\n\n```html\n\n\n\n```\n\nAfter including the script, `feather` will be available as a global variable.\n\n#### 3. Use\n\nTo use an icon on your page, add a `data-feather` attribute with the icon name to an element:\n\n```html\n\n```\n\nSee the complete list of icons at [feathericons.com](https://feathericons.com).\n\n#### 4. Replace\n\nCall the `feather.replace()` method:\n\n```html\n\n```\n\nAll elements that have a `data-feather` attribute will be replaced with SVG markup corresponding to their `data-feather` attribute value. See the [API Reference](#api-reference) for more information about `feather.replace()`.\n\n### Node\n\n#### 1. Install\n\nInstall with [npm](https://docs.npmjs.com/getting-started/what-is-npm):\n\n```shell\nnpm install feather-icons --save\n```\n\n#### 2. Require\n\n```js\nconst feather = require('feather-icons');\n```\n\n#### 3. Use\n\n```js\nfeather.icons.x;\n// {\n// name: 'x',\n// contents: '`,\n// tags: ['cancel', 'close', 'delete', 'remove'],\n// attrs: {\n// class: 'feather feather-x',\n// xmlns: 'http://www.w3.org/2000/svg',\n// width: 24,\n// height: 24,\n// viewBox: '0 0 24 24',\n// fill: 'none',\n// stroke: 'currentColor',\n// 'stroke-width': 2,\n// 'stroke-linecap': 'round',\n// 'stroke-linejoin': 'round',\n// },\n// toSvg: [Function],\n// }\n\nfeather.icons.x.toSvg();\n// \n\nfeather.icons.x.toSvg({ class: 'foo bar', 'stroke-width': 1, color: 'red' });\n// \n```\n\nSee the [API Reference](#api-reference) for more information about the available properties and methods of the `feather` object.\n\n### SVG sprite\n\n#### 1. Install\n\n> [!NOTE]\n> If you intend to use Feather with a CDN, you can skip this installation step.\n\nInstall with [npm](https://docs.npmjs.com/getting-started/what-is-npm).\n\n```shell\nnpm install feather-icons --save\n```\n\nOr just copy [`feather-sprite.svg`](https://unpkg.com/feather-icons/dist/feather-sprite.svg) into your project directory.\n\n#### 2. Use\n\nInclude an icon on your page with the following markup:\n\n```html\n\n \n\n```\n\n> [!NOTE]\n> `circle` in the above example can be replaced with any valid icon name. See the complete list of icon names at [feathericons.com](https://feathericons.com).\n\nHowever, this markup can be simplified using a simple CSS class to avoid repetition of SVG attributes between icons:\n\n```css\n.feather {\n width: 24px;\n height: 24px;\n stroke: currentColor;\n stroke-width: 2;\n stroke-linecap: round;\n stroke-linejoin: round;\n fill: none;\n}\n```\n\n```html\n\n \n\n```\n\n### Figma\n\nFeather is available as a [Figma component library](https://www.figma.com/file/dyJRSFTIajik4cdkcXN8yA3K/Feather-Component-Library). To use the components, log in to your Figma account and **duplicate** the file to your drafts.\n\n## API reference\n\n### `feather.icons`\n\nAn object with data about every icon.\n\n#### Usage\n\n```js\nfeather.icons.x;\n// {\n// name: 'x',\n// contents: '',\n// tags: ['cancel', 'close', 'delete', 'remove'],\n// attrs: {\n// class: 'feather feather-x',\n// xmlns: 'http://www.w3.org/2000/svg',\n// width: 24,\n// height: 24,\n// viewBox: '0 0 24 24',\n// fill: 'none',\n// stroke: 'currentColor',\n// 'stroke-width': 2,\n// 'stroke-linecap': 'round',\n// 'stroke-linejoin': 'round',\n// },\n// toSvg: [Function],\n// }\n\nfeather.icons.x.toString();\n// ''\n```\n\n> [!NOTE]\n> `x` in the above example can be replaced with any valid icon name. See the complete list of icon names at [feathericons.com](https://feathericons.com). Icons with multi-word names (e.g. `arrow-right`) **cannot** be accessed using dot notation (e.g. `feather.icons.x`). Instead, use bracket notation (e.g. `feather.icons['arrow-right']`).\n\n[View Source](https://github.com/feathericons/feather/blob/master/src/icons.js)\n\n---\n\n### `feather.icons[name].toSvg([attrs])`\n\nReturns an SVG string.\n\n#### Parameters\n\n| Name | Type | Description |\n| ------------------ | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `attrs` (optional) | Object | Key-value pairs in the `attrs` object will be mapped to HTML attributes on the `` tag (e.g. `{ foo: 'bar' }` maps to `foo=\"bar\"`). All default attributes on the `` tag can be overridden with the `attrs` object. |\n\n> [!NOTE]\n> You might find these SVG attributes helpful for manipulating icons:\n>\n> - [`color`](https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/color)\n> - [`width`](https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/width)\n> - [`height`](https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/height)\n> - [`stroke-width`](https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-width)\n> - [`stroke-linecap`](https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-linecap)\n> - [`stroke-linejoin`](https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-linejoin)\n\n#### Usage\n\n```js\nfeather.icons.circle.toSvg();\n// ''\n\nfeather.icons.circle.toSvg({ 'stroke-width': 1 });\n// ''\n\nfeather.icons.circle.toSvg({ class: 'foo bar' });\n// ''\n```\n\n[View Source](https://github.com/feathericons/feather/blob/master/src/icon.js)\n\n---\n\n### `feather.replace([attrs])`\n\nReplaces all elements that have a `data-feather` attribute with SVG markup corresponding to the element's `data-feather` attribute value.\n\n#### Parameters\n\n| Name | Type | Description |\n| ------------------ | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `attrs` (optional) | Object | Key-value pairs in the `attrs` object will be mapped to HTML attributes on the `` tag (e.g. `{ foo: 'bar' }` maps to `foo=\"bar\"`). All default attributes on the `` tag can be overridden with the `attrs` object. |\n\n#### Usage\n\n> [!IMPORTANT]\n> `feather.replace()` only works in a browser environment.\n\nSimple usage:\n\n```html\n\n\n\n\n```\n\nYou can pass `feather.replace()` an `attrs` object:\n\n```html\n\n\n\n\n```\n\nAll attributes on the placeholder element (i.e. ``) will be copied to the `` tag:\n\n```html\n\n\n\n\n```\n\n[View Source](https://github.com/feathericons/feather/blob/master/src/replace.js)\n\n---\n\n### `feather.toSvg(name, [attrs])` (DEPRECATED)\n\n> [!WARNING]\n> `feather.toSvg()` is deprecated. Please use `feather.icons[name].toSvg()` instead.\n\nReturns an SVG string.\n\n#### Parameters\n\n| Name | Type | Description |\n| ------------------ | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `name` | string | Icon name |\n| `attrs` (optional) | Object | Key-value pairs in the `attrs` object will be mapped to HTML attributes on the `` tag (e.g. `{ foo: 'bar' }` maps to `foo=\"bar\"`). All default attributes on the `` tag can be overridden with the `attrs` object. |\n\n#### Usage\n\n```js\nfeather.toSvg('circle');\n// ''\n\nfeather.toSvg('circle', { 'stroke-width': 1 });\n// ''\n\nfeather.toSvg('circle', { class: 'foo bar' });\n// ''\n```\n\n[View Source](https://github.com/feathericons/feather/blob/master/src/to-svg.js)\n\n## Contributing\n\nFor more info on how to contribute please see the [contribution guidelines](https://github.com/feathericons/feather/blob/master/CONTRIBUTING.md).\n\nCaught a mistake or want to contribute to the documentation? [Edit this page on Github](https://github.com/feathericons/feather/blob/master/README.md)\n\n## Related projects\n\n- [feathericons.dev](http://feathericons.dev) - Feather viewer featuring [30+ brand icons](https://feathericons.dev/?iconset=brands) and [40+ payment services icons](https://feathericons.dev/?iconset=payments)\n- [angular-feather](https://github.com/michaelbazos/angular-feather) - Feather icons for Angular applications\n- [elm-feather](https://github.com/1602/elm-feather) - Feather icons for Elm applications\n- [react-feather](https://github.com/carmelopullara/react-feather) - Feather icons as React components\n- [sketch-feather](https://github.com/odmln/sketch-feather) - Feather icons as a Sketch library\n- [vue-feather-icons](https://github.com/egoist/vue-feather-icons) - Feather icons as Vue components\n- [php-feather](https://github.com/Pixelrobin/php-feather) - Feather icons as a PHP Library\n- [hyva-feather](https://github.com/Siteation/magento2-hyva-icons-feather) - Feather icons as a Magento 2 Hyva template tag\n- [wp-php-feather](https://github.com/reatlat/wp-php-feather) - Feather icons as a WordPress template tag\n- [django-feather](https://pypi.org/project/django-feather/) - Feather icons as Django Template Tag\n- [svelte-feather-icons](https://github.com/dylanblokhuis/svelte-feather-icons) - Feather icons as Svelte components\n- [gulp-feather](https://github.com/oToToT/gulp-feather) - Feather icons rendering using gulp\n- [astro-feather](https://github.com/gabrlyg/astro-feather) - Feather icons as Astro components\n- [qwik-feather-icons](https://github.com/yeyon/qwik-feather-icons) - Feather icons for Qwik, the Resumable Framework\n- [figma-feather](https://github.com/kevintoepfer/figma-feather) – Feather icons as a Figma component\n- [delphi-feather-icons](https://github.com/shaunroselt/Delphi-Feather-Icons) - Feather icons as a Delphi Library\n- [eleventy-plugin-feathericons](https://github.com/reatlat/eleventy-plugin-feathericons) - Feather icons as a plugin for [11ty](https://github.com/11ty/eleventy)\n\n## License\n\nFeather is licensed under the [MIT License](https://github.com/feathericons/feather/blob/master/LICENSE).\n" }, { "path": "bin/.eslintrc.json", "content": "{\n \"rules\": {\n \"import/no-extraneous-dependencies\": \"off\",\n \"no-console\": \"off\"\n }\n}\n" }, { "path": "bin/__tests__/__snapshots__/build-icons-object.test.js.snap", "content": "// Jest Snapshot v1, https://goo.gl/fbAQLP\n\nexports[`builds object correctly 1`] = `\nObject {\n \"icon1\": \"\",\n \"icon2\": \"\",\n}\n`;\n" }, { "path": "bin/__tests__/__snapshots__/build-sprite-string.test.js.snap", "content": "// Jest Snapshot v1, https://goo.gl/fbAQLP\n\nexports[`builds sprite correctly 1`] = `\"\"`;\n" }, { "path": "bin/__tests__/__snapshots__/optimize-svg.test.js.snap", "content": "// Jest Snapshot v1, https://goo.gl/fbAQLP\n\nexports[`optimizes SVG correctly 1`] = `\"\"`;\n\nexports[`rejects when passed unparsable SVG string 1`] = `\n[Error: Error in parsing SVG: Unclosed root tag\nLine: 0\nColumn: 10\nChar: ]\n`;\n" }, { "path": "bin/__tests__/build-icons-object.test.js", "content": "/* eslint-env jest */\nimport buildIconsObject from '../build-icons-object';\n\nconst SVG_FILES = {\n 'icon1.svg':\n '\\n \\n \\n',\n 'icon2.svg':\n '\\n \\n',\n};\n\nfunction getSvg(svgFile) {\n return SVG_FILES[svgFile];\n}\n\ntest('builds object correctly', () => {\n expect(buildIconsObject(Object.keys(SVG_FILES), getSvg)).toMatchSnapshot();\n});\n" }, { "path": "bin/__tests__/build-sprite-string.test.js", "content": "/* eslint-env jest */\nimport buildSpriteString from '../build-sprite-string';\n\nconst icons = {\n icon1:\n '',\n icon2: '',\n};\n\ntest('builds sprite correctly', () => {\n expect(buildSpriteString(icons)).toMatchSnapshot();\n});\n" }, { "path": "bin/__tests__/optimize-svg.test.js", "content": "/* eslint-env jest */\nimport optimizeSvg from '../optimize-svg';\n\ntest('optimizes SVG correctly', () => {\n const SVG =\n 'Title';\n\n expect(optimizeSvg(SVG)).resolves.toMatchSnapshot();\n});\n\ntest('rejects when passed unparsable SVG string', () => {\n const UNPARSABLE_SVG = ' path.extname(file) === '.svg');\n\nconst getSvg = svgFile => fs.readFileSync(path.join(IN_DIR, svgFile));\n\nconst icons = buildIconsObject(svgFiles, getSvg);\n\nfs.writeFileSync(OUT_FILE, JSON.stringify(icons));\n" }, { "path": "bin/build-icons-object.js", "content": "import path from 'path';\nimport cheerio from 'cheerio';\nimport { minify } from 'html-minifier';\n\n/**\n * Build an object in the format: `{ : }`.\n * @param {string[]} svgFiles - A list of filenames.\n * @param {Function} getSvg - A function that returns the contents of an SVG file given a filename.\n * @returns {Object}\n */\nfunction buildIconsObject(svgFiles, getSvg) {\n return svgFiles\n .map(svgFile => {\n const name = path.basename(svgFile, '.svg');\n const svg = getSvg(svgFile);\n const contents = getSvgContents(svg);\n return { name, contents };\n })\n .reduce((icons, icon) => {\n icons[icon.name] = icon.contents;\n return icons;\n }, {});\n}\n\n/**\n * Get contents between opening and closing `` tags.\n * @param {string} svg\n * @returns {string}\n */\nfunction getSvgContents(svg) {\n const $ = cheerio.load(svg);\n return minify($('svg').html(), { collapseWhitespace: true });\n}\n\nexport default buildIconsObject;\n" }, { "path": "bin/build-sprite-string.js", "content": "import DEFAULT_ATTRS from '../src/default-attrs.json';\n\n/**\n * Build an SVG sprite string containing SVG symbols.\n * @param {Object} icons\n * @returns {string}\n */\nfunction buildSpriteString(icons) {\n const symbols = Object.keys(icons)\n .map(icon => toSvgSymbol(icon, icons[icon]))\n .join('');\n\n return `${symbols}`;\n}\n\n/**\n * Create an SVG symbol string.\n * @param {string} name - Icon name\n * @param {string} contents - SVG contents\n * @returns {string}\n */\nfunction toSvgSymbol(name, contents) {\n return `${contents}`;\n}\n\nexport default buildSpriteString;\n" }, { "path": "bin/build-sprite.js", "content": "import fs from 'fs';\nimport path from 'path';\nimport icons from '../dist/icons.json';\nimport buildSpriteString from './build-sprite-string';\n\nconst OUT_FILE = path.resolve(__dirname, '../dist/feather-sprite.svg');\n\nconsole.log(`Building ${OUT_FILE}...`);\n\nfs.writeFileSync(OUT_FILE, buildSpriteString(icons));\n" }, { "path": "bin/build-svgs.js", "content": "import fs from 'fs';\nimport path from 'path';\nimport icons from '../src/icons';\n\nconst OUT_DIR = path.resolve(__dirname, '../dist/icons');\n\nconsole.log(`Building SVGs in ${OUT_DIR}...`);\n\nObject.keys(icons).forEach(name => {\n const svg = icons[name].toSvg();\n\n fs.writeFileSync(path.join(OUT_DIR, `${name}.svg`), svg);\n});\n" }, { "path": "bin/build.sh", "content": "#!/bin/bash\n\n# Create dist directory\nnpx rimraf dist\nmkdir dist\n\n# Build icons.json\nnpx babel-node bin/build-icons-json.js\n\n# Build SVG sprite\nnpx babel-node bin/build-sprite.js\n\n# Create dist/icons directory\nnpx rimraf dist/icons\nmkdir dist/icons\n\n# Build SVG icons\nnpx babel-node bin/build-svgs.js\n\n# Build JavaScript library\nnpx webpack --output-filename feather.js --mode development\nnpx webpack --output-filename feather.min.js --mode production\n" }, { "path": "bin/optimize-svg.js", "content": "import Svgo from 'svgo';\nimport cheerio from 'cheerio';\n\nimport DEFAULT_ATTRS from '../src/default-attrs.json';\n\n/**\n * Optimize SVG string.\n * @param {string} svg - An SVG string.\n * @returns {Promise}\n */\nfunction optimizeSvg(svg) {\n return svgo(svg).then(setAttrs);\n}\n\n/**\n * Run SVGO on SVG string.\n * @param {string} svg - An SVG string.\n * @returns {Promise}\n */\nfunction svgo(svg) {\n const s = new Svgo({\n plugins: [\n { convertShapeToPath: false },\n { mergePaths: false },\n { removeAttrs: { attrs: '(fill|stroke.*)' } },\n { removeTitle: true },\n ],\n });\n\n return new Promise(resolve => {\n s.optimize(svg, ({ data }) => resolve(data));\n });\n}\n\n/**\n * Set default attributes on SVG.\n * @param {string} svg - An SVG string.\n * @returns {string}\n */\nfunction setAttrs(svg) {\n const $ = cheerio.load(svg);\n\n Object.keys(DEFAULT_ATTRS).forEach(key =>\n $('svg').attr(key, DEFAULT_ATTRS[key]),\n );\n\n return $('body').html();\n}\n\nexport default optimizeSvg;\n" }, { "path": "bin/optimize-svgs.js", "content": "import fs from 'fs';\nimport path from 'path';\n\nimport optimizeSvg from './optimize-svg';\n\nconst IN_DIR = path.resolve(__dirname, '../icons');\n\nconsole.log(`Optimizing SVGs in ${IN_DIR}...`);\n\nfs.readdirSync(IN_DIR)\n .filter(file => path.extname(file) === '.svg')\n .forEach(svgFile => {\n const svg = fs.readFileSync(path.join(IN_DIR, svgFile));\n optimizeSvg(svg).then(svg =>\n fs.writeFileSync(path.join(IN_DIR, svgFile), svg),\n );\n });\n" }, { "path": "bin/setup.sh", "content": "#!/bin/bash\n\nnpm install --legacy-peer-deps\nnpm run build\nnpm run test:coverage\nnpm run lint\n" }, { "path": "commitlint.config.js", "content": "module.exports = {\n extends: ['@commitlint/config-conventional'],\n rules: {\n 'scope-case': [0],\n 'subject-case': [2, 'always', 'sentence-case'],\n 'header-max-length': [0],\n },\n};\n" }, { "path": "examples/index.html", "content": "\n\n \n \n Feather\n \n \n \n \n \n\n \n \n \n\n" }, { "path": "package.json", "content": "{\n \"name\": \"feather-icons\",\n \"version\": \"4.29.2\",\n \"description\": \"Simply beautiful open source icons\",\n \"repository\": {\n \"type\": \"git\",\n \"url\": \"https://github.com/feathericons/feather.git\"\n },\n \"author\": \"Cole Bemis (https://colebemis.com)\",\n \"license\": \"MIT\",\n \"main\": \"dist/feather.js\",\n \"unpkg\": \"dist/feather.min.js\",\n \"files\": [\n \"dist\"\n ],\n \"scripts\": {\n \"setup\": \"./bin/setup.sh\",\n \"build\": \"./bin/build.sh\",\n \"test\": \"jest\",\n \"test:watch\": \"jest --watch\",\n \"test:coverage\": \"jest --coverage\",\n \"lint\": \"eslint .\",\n \"format\": \"prettier --write .\",\n \"optimize-svgs\": \"babel-node bin/optimize-svgs.js\",\n \"release\": \"yarn build && changeset publish\"\n },\n \"jest\": {\n \"collectCoverageFrom\": [\n \"src/**/*.js\"\n ]\n },\n \"dependencies\": {\n \"classnames\": \"^2.2.5\",\n \"core-js\": \"^3.1.3\"\n },\n \"devDependencies\": {\n \"@changesets/changelog-github\": \"^0.4.8\",\n \"@changesets/cli\": \"^2.26.2\",\n \"babel-cli\": \"^6.24.1\",\n \"babel-loader\": \"^7.1.1\",\n \"babel-preset-env\": \"^1.7.0\",\n \"babel-preset-stage-2\": \"^6.24.1\",\n \"cheerio\": \"^1.0.0-rc.2\",\n \"eslint\": \"^8.47.0\",\n \"html-minifier\": \"^3.5.8\",\n \"jest\": \"^22.4.4\",\n \"prettier\": \"^2.8.8\",\n \"svgo\": \"^0.7.2\",\n \"webpack\": \"^4.8.3\",\n \"webpack-cli\": \"^2.1.3\"\n },\n \"prettier\": {\n \"singleQuote\": true,\n \"trailingComma\": \"all\",\n \"arrowParens\": \"avoid\"\n }\n}\n" }, { "path": "src/__tests__/__snapshots__/icon.test.js.snap", "content": "// Jest Snapshot v1, https://goo.gl/fbAQLP\n\nexports[`constructs icon object correctly 1`] = `\nIcon {\n \"attrs\": Object {\n \"class\": \"feather feather-test\",\n \"fill\": \"none\",\n \"height\": 24,\n \"stroke\": \"currentColor\",\n \"stroke-linecap\": \"round\",\n \"stroke-linejoin\": \"round\",\n \"stroke-width\": 2,\n \"viewBox\": \"0 0 24 24\",\n \"width\": 24,\n \"xmlns\": \"http://www.w3.org/2000/svg\",\n },\n \"contents\": \"\",\n \"name\": \"test\",\n \"tags\": Array [\n \"hello\",\n \"world\",\n \"foo\",\n \"bar\",\n ],\n}\n`;\n\nexports[`constructs icon object correctly 2`] = `\nIcon {\n \"attrs\": Object {\n \"class\": \"feather feather-test\",\n \"fill\": \"none\",\n \"height\": 24,\n \"stroke\": \"currentColor\",\n \"stroke-linecap\": \"round\",\n \"stroke-linejoin\": \"round\",\n \"stroke-width\": 2,\n \"viewBox\": \"0 0 24 24\",\n \"width\": 24,\n \"xmlns\": \"http://www.w3.org/2000/svg\",\n },\n \"contents\": \"\",\n \"name\": \"test\",\n \"tags\": Array [],\n}\n`;\n\nexports[`toString() returns correct string 1`] = `\"\"`;\n\nexports[`toSvg() returns correct string 1`] = `\"\"`;\n\nexports[`toSvg() returns correct string 2`] = `\"\"`;\n\nexports[`toSvg() returns correct string 3`] = `\"\"`;\n" }, { "path": "src/__tests__/__snapshots__/icons.test.js.snap", "content": "// Jest Snapshot v1, https://goo.gl/fbAQLP\n\nexports[`exports correct object 1`] = `\nObject {\n \"icon1\": Icon {\n \"attrs\": Object {\n \"class\": \"feather feather-icon1\",\n \"fill\": \"none\",\n \"height\": 24,\n \"stroke\": \"currentColor\",\n \"stroke-linecap\": \"round\",\n \"stroke-linejoin\": \"round\",\n \"stroke-width\": 2,\n \"viewBox\": \"0 0 24 24\",\n \"width\": 24,\n \"xmlns\": \"http://www.w3.org/2000/svg\",\n },\n \"contents\": \"\",\n \"name\": \"icon1\",\n \"tags\": Array [\n \"foo\",\n \"bar\",\n \"hello\",\n \"world\",\n ],\n },\n \"icon2\": Icon {\n \"attrs\": Object {\n \"class\": \"feather feather-icon2\",\n \"fill\": \"none\",\n \"height\": 24,\n \"stroke\": \"currentColor\",\n \"stroke-linecap\": \"round\",\n \"stroke-linejoin\": \"round\",\n \"stroke-width\": 2,\n \"viewBox\": \"0 0 24 24\",\n \"width\": 24,\n \"xmlns\": \"http://www.w3.org/2000/svg\",\n },\n \"contents\": \"\",\n \"name\": \"icon2\",\n \"tags\": Array [],\n },\n}\n`;\n" }, { "path": "src/__tests__/__snapshots__/replace.node.test.js.snap", "content": "// Jest Snapshot v1, https://goo.gl/fbAQLP\n\nexports[`throws an error when run in node environment 1`] = `\"\\`feather.replace()\\` only works in a browser environment.\"`;\n" }, { "path": "src/__tests__/__snapshots__/replace.test.js.snap", "content": "// Jest Snapshot v1, https://goo.gl/fbAQLP\n\nexports[`copies placeholder element attributes to tag 1`] = `\"\"`;\n\nexports[`copies placeholder element attributes to tag 2`] = `\"\"`;\n\nexports[`replaces [data-feather] elements with SVG markup 1`] = `\"\"`;\n\nexports[`replaces [data-feather] elements with SVG markup 2`] = `\"\"`;\n\nexports[`sets attributes passed as parameters 1`] = `\"\"`;\n\nexports[`sets attributes passed as parameters 2`] = `\"\"`;\n" }, { "path": "src/__tests__/__snapshots__/to-svg.test.js.snap", "content": "// Jest Snapshot v1, https://goo.gl/fbAQLP\n\nexports[`returns correct string 1`] = `\"\"`;\n\nexports[`returns correct string 2`] = `\"\"`;\n\nexports[`returns correct string 3`] = `\"\"`;\n" }, { "path": "src/__tests__/icon.test.js", "content": "/* eslint-env jest */\nimport Icon from '../icon';\n\nconst icon1 = new Icon(\n 'test',\n '',\n ['hello', 'world', 'foo', 'bar'],\n);\n\nconst icon2 = new Icon(\n 'test',\n '',\n);\n\ntest('constructs icon object correctly', () => {\n expect(icon1).toMatchSnapshot();\n expect(icon2).toMatchSnapshot();\n});\n\ntest('toSvg() returns correct string', () => {\n expect(icon1.toSvg()).toMatchSnapshot();\n expect(icon1.toSvg({ 'stroke-width': 1, color: 'red' })).toMatchSnapshot();\n expect(icon1.toSvg({ class: 'foo bar', color: 'red' })).toMatchSnapshot();\n});\n\ntest('toString() returns correct string', () => {\n expect(icon1.toString()).toMatchSnapshot();\n});\n" }, { "path": "src/__tests__/icons.test.js", "content": "/* eslint-env jest */\nimport icons from '../icons';\n\njest.mock('../../dist/icons.json', () => ({\n icon1:\n '',\n icon2: '',\n}));\n\njest.mock('../tags.json', () => ({\n icon1: ['foo', 'bar', 'hello', 'world'],\n}));\n\ntest('exports correct object', () => {\n expect(icons).toMatchSnapshot();\n});\n" }, { "path": "src/__tests__/index.test.js", "content": "/* eslint-env jest */\nimport feather from '../index';\n\ntest('has correct properties', () => {\n expect(feather).toHaveProperty('icons');\n expect(feather).toHaveProperty('toSvg');\n expect(feather).toHaveProperty('replace');\n});\n" }, { "path": "src/__tests__/replace.node.test.js", "content": "/**\n * @jest-environment node\n */\n\n/* eslint-env jest */\nimport replace from '../replace';\n\ntest('throws an error when run in node environment', () => {\n expect(replace).toThrowErrorMatchingSnapshot();\n});\n" }, { "path": "src/__tests__/replace.test.js", "content": "/* eslint-env jest, browser */\nimport replace from '../replace';\n\njest.mock('../../dist/icons.json', () => ({\n icon1:\n '',\n icon2: '',\n}));\n\ntest('replaces [data-feather] elements with SVG markup', () => {\n document.body.innerHTML =\n '';\n expect(document.body.innerHTML).toMatchSnapshot();\n replace();\n expect(document.body.innerHTML).toMatchSnapshot();\n});\n\ntest('copies placeholder element attributes to tag', () => {\n document.body.innerHTML =\n '';\n expect(document.body.innerHTML).toMatchSnapshot();\n replace();\n expect(document.body.innerHTML).toMatchSnapshot();\n});\n\ntest('sets attributes passed as parameters', () => {\n document.body.innerHTML =\n '';\n expect(document.body.innerHTML).toMatchSnapshot();\n replace({ class: 'foo bar hello', 'stroke-width': 1.5, color: 'salmon' });\n expect(document.body.innerHTML).toMatchSnapshot();\n});\n" }, { "path": "src/__tests__/to-svg.test.js", "content": "/* eslint-env jest */\nimport toSvg from '../to-svg';\n\njest.mock('../../dist/icons.json', () => ({\n icon1:\n '',\n}));\n\ntest('returns correct string', () => {\n expect(toSvg('icon1')).toMatchSnapshot();\n expect(toSvg('icon1', { 'stroke-width': 1, color: 'red' })).toMatchSnapshot();\n expect(toSvg('icon1', { class: 'foo bar', color: 'red' })).toMatchSnapshot();\n});\n\ntest('throws error when `name` parameter is undefined', () => {\n expect(() => toSvg()).toThrow();\n});\n\ntest('throws error when passed unknown icon name', () => {\n expect(() => toSvg('foo')).toThrow();\n});\n" }, { "path": "src/default-attrs.json", "content": "{\n \"xmlns\": \"http://www.w3.org/2000/svg\",\n \"width\": 24,\n \"height\": 24,\n \"viewBox\": \"0 0 24 24\",\n \"fill\": \"none\",\n \"stroke\": \"currentColor\",\n \"stroke-width\": 2,\n \"stroke-linecap\": \"round\",\n \"stroke-linejoin\": \"round\"\n}\n" }, { "path": "src/icon.js", "content": "import classnames from 'classnames/dedupe';\n\nimport DEFAULT_ATTRS from './default-attrs.json';\n\nclass Icon {\n constructor(name, contents, tags = []) {\n this.name = name;\n this.contents = contents;\n this.tags = tags;\n this.attrs = {\n ...DEFAULT_ATTRS,\n ...{ class: `feather feather-${name}` },\n };\n }\n\n /**\n * Create an SVG string.\n * @param {Object} attrs\n * @returns {string}\n */\n toSvg(attrs = {}) {\n const combinedAttrs = {\n ...this.attrs,\n ...attrs,\n ...{ class: classnames(this.attrs.class, attrs.class) },\n };\n\n return `${this.contents}`;\n }\n\n /**\n * Return string representation of an `Icon`.\n *\n * Added for backward compatibility. If old code expects `feather.icons.`\n * to be a string, `toString()` will get implicitly called.\n *\n * @returns {string}\n */\n toString() {\n return this.contents;\n }\n}\n\n/**\n * Convert attributes object to string of HTML attributes.\n * @param {Object} attrs\n * @returns {string}\n */\nfunction attrsToString(attrs) {\n return Object.keys(attrs)\n .map(key => `${key}=\"${attrs[key]}\"`)\n .join(' ');\n}\n\nexport default Icon;\n" }, { "path": "src/icons.js", "content": "import Icon from './icon';\nimport icons from '../dist/icons.json';\nimport tags from './tags.json';\n\nexport default Object.keys(icons)\n .map(key => new Icon(key, icons[key], tags[key]))\n .reduce((object, icon) => {\n object[icon.name] = icon;\n return object;\n }, {});\n" }, { "path": "src/index.js", "content": "import icons from './icons';\nimport toSvg from './to-svg';\nimport replace from './replace';\n\nmodule.exports = { icons, toSvg, replace };\n" }, { "path": "src/replace.js", "content": "/* eslint-env browser */\nimport classnames from 'classnames/dedupe';\n\nimport icons from './icons';\n\n/**\n * Replace all HTML elements that have a `data-feather` attribute with SVG markup\n * corresponding to the element's `data-feather` attribute value.\n * @param {Object} attrs\n */\nfunction replace(attrs = {}) {\n if (typeof document === 'undefined') {\n throw new Error('`feather.replace()` only works in a browser environment.');\n }\n\n const elementsToReplace = document.querySelectorAll('[data-feather]');\n\n Array.from(elementsToReplace).forEach(element =>\n replaceElement(element, attrs),\n );\n}\n\n/**\n * Replace a single HTML element with SVG markup\n * corresponding to the element's `data-feather` attribute value.\n * @param {HTMLElement} element\n * @param {Object} attrs\n */\nfunction replaceElement(element, attrs = {}) {\n const elementAttrs = getAttrs(element);\n const name = elementAttrs['data-feather'];\n delete elementAttrs['data-feather'];\n\n if (icons[name] === undefined) {\n console.warn(`feather: '${name}' is not a valid icon`);\n return;\n }\n\n const svgString = icons[name].toSvg({\n ...attrs,\n ...elementAttrs,\n ...{ class: classnames(attrs.class, elementAttrs.class) },\n });\n const svgDocument = new DOMParser().parseFromString(\n svgString,\n 'image/svg+xml',\n );\n const svgElement = svgDocument.querySelector('svg');\n\n element.parentNode.replaceChild(svgElement, element);\n}\n\n/**\n * Get the attributes of an HTML element.\n * @param {HTMLElement} element\n * @returns {Object}\n */\nfunction getAttrs(element) {\n return Array.from(element.attributes).reduce((attrs, attr) => {\n attrs[attr.name] = attr.value;\n return attrs;\n }, {});\n}\n\nexport default replace;\n" }, { "path": "src/tags.json", "content": "{\n \"activity\": [\"pulse\", \"health\", \"action\", \"motion\"],\n \"airplay\": [\"stream\", \"cast\", \"mirroring\"],\n \"alert-circle\": [\"warning\", \"alert\", \"danger\"],\n \"alert-octagon\": [\"warning\", \"alert\", \"danger\"],\n \"alert-triangle\": [\"warning\", \"alert\", \"danger\"],\n \"align-center\": [\"text alignment\", \"center\"],\n \"align-justify\": [\"text alignment\", \"justified\"],\n \"align-left\": [\"text alignment\", \"left\"],\n \"align-right\": [\"text alignment\", \"right\"],\n \"anchor\": [],\n \"archive\": [\"index\", \"box\"],\n \"at-sign\": [\"mention\", \"at\", \"email\", \"message\"],\n \"award\": [\"achievement\", \"badge\"],\n \"aperture\": [\"camera\", \"photo\"],\n \"bar-chart\": [\"statistics\", \"diagram\", \"graph\"],\n \"bar-chart-2\": [\"statistics\", \"diagram\", \"graph\"],\n \"battery\": [\"power\", \"electricity\"],\n \"battery-charging\": [\"power\", \"electricity\"],\n \"bell\": [\"alarm\", \"notification\", \"sound\"],\n \"bell-off\": [\"alarm\", \"notification\", \"silent\"],\n \"bluetooth\": [\"wireless\"],\n \"book-open\": [\"read\", \"library\"],\n \"book\": [\"read\", \"dictionary\", \"booklet\", \"magazine\", \"library\"],\n \"bookmark\": [\"read\", \"clip\", \"marker\", \"tag\"],\n \"box\": [\"cube\"],\n \"briefcase\": [\"work\", \"bag\", \"baggage\", \"folder\"],\n \"calendar\": [\"date\"],\n \"camera\": [\"photo\"],\n \"cast\": [\"chromecast\", \"airplay\"],\n \"chevron-down\": [\"expand\"],\n \"chevron-up\": [\"collapse\"],\n \"circle\": [\"off\", \"zero\", \"record\"],\n \"clipboard\": [\"copy\"],\n \"clock\": [\"time\", \"watch\", \"alarm\"],\n \"cloud-drizzle\": [\"weather\", \"shower\"],\n \"cloud-lightning\": [\"weather\", \"bolt\"],\n \"cloud-rain\": [\"weather\"],\n \"cloud-snow\": [\"weather\", \"blizzard\"],\n \"cloud\": [\"weather\"],\n \"codepen\": [\"logo\"],\n \"codesandbox\": [\"logo\"],\n \"code\": [\"source\", \"programming\"],\n \"coffee\": [\"drink\", \"cup\", \"mug\", \"tea\", \"cafe\", \"hot\", \"beverage\"],\n \"columns\": [\"layout\"],\n \"command\": [\"keyboard\", \"cmd\", \"terminal\", \"prompt\"],\n \"compass\": [\"navigation\", \"safari\", \"travel\", \"direction\"],\n \"copy\": [\"clone\", \"duplicate\"],\n \"corner-down-left\": [\"arrow\", \"return\"],\n \"corner-down-right\": [\"arrow\"],\n \"corner-left-down\": [\"arrow\"],\n \"corner-left-up\": [\"arrow\"],\n \"corner-right-down\": [\"arrow\"],\n \"corner-right-up\": [\"arrow\"],\n \"corner-up-left\": [\"arrow\"],\n \"corner-up-right\": [\"arrow\"],\n \"cpu\": [\"processor\", \"technology\"],\n \"credit-card\": [\"purchase\", \"payment\", \"cc\"],\n \"crop\": [\"photo\", \"image\"],\n \"crosshair\": [\"aim\", \"target\"],\n \"database\": [\"storage\", \"memory\"],\n \"delete\": [\"remove\"],\n \"disc\": [\"album\", \"cd\", \"dvd\", \"music\"],\n \"dollar-sign\": [\"currency\", \"money\", \"payment\"],\n \"droplet\": [\"water\"],\n \"edit\": [\"pencil\", \"change\"],\n \"edit-2\": [\"pencil\", \"change\"],\n \"edit-3\": [\"pencil\", \"change\"],\n \"eye\": [\"view\", \"watch\"],\n \"eye-off\": [\"view\", \"watch\", \"hide\", \"hidden\"],\n \"external-link\": [\"outbound\"],\n \"facebook\": [\"logo\", \"social\"],\n \"fast-forward\": [\"music\"],\n \"figma\": [\"logo\", \"design\", \"tool\"],\n \"file-minus\": [\"delete\", \"remove\", \"erase\"],\n \"file-plus\": [\"add\", \"create\", \"new\"],\n \"file-text\": [\"data\", \"txt\", \"pdf\"],\n \"film\": [\"movie\", \"video\"],\n \"filter\": [\"funnel\", \"hopper\"],\n \"flag\": [\"report\"],\n \"folder-minus\": [\"directory\"],\n \"folder-plus\": [\"directory\"],\n \"folder\": [\"directory\"],\n \"framer\": [\"logo\", \"design\", \"tool\"],\n \"frown\": [\"emoji\", \"face\", \"bad\", \"sad\", \"emotion\"],\n \"gift\": [\"present\", \"box\", \"birthday\", \"party\"],\n \"git-branch\": [\"code\", \"version control\"],\n \"git-commit\": [\"code\", \"version control\"],\n \"git-merge\": [\"code\", \"version control\"],\n \"git-pull-request\": [\"code\", \"version control\"],\n \"github\": [\"logo\", \"version control\"],\n \"gitlab\": [\"logo\", \"version control\"],\n \"globe\": [\"world\", \"browser\", \"language\", \"translate\"],\n \"hard-drive\": [\"computer\", \"server\", \"memory\", \"data\"],\n \"hash\": [\"hashtag\", \"number\", \"pound\"],\n \"headphones\": [\"music\", \"audio\", \"sound\"],\n \"heart\": [\"like\", \"love\", \"emotion\"],\n \"help-circle\": [\"question mark\"],\n \"hexagon\": [\"shape\", \"node.js\", \"logo\"],\n \"home\": [\"house\", \"living\"],\n \"image\": [\"picture\"],\n \"inbox\": [\"email\"],\n \"instagram\": [\"logo\", \"camera\"],\n \"key\": [\"password\", \"login\", \"authentication\", \"secure\"],\n \"layers\": [\"stack\"],\n \"layout\": [\"window\", \"webpage\"],\n \"life-buoy\": [\"help\", \"life ring\", \"support\"],\n \"link\": [\"chain\", \"url\"],\n \"link-2\": [\"chain\", \"url\"],\n \"linkedin\": [\"logo\", \"social media\"],\n \"list\": [\"options\"],\n \"lock\": [\"security\", \"password\", \"secure\"],\n \"log-in\": [\"sign in\", \"arrow\", \"enter\"],\n \"log-out\": [\"sign out\", \"arrow\", \"exit\"],\n \"mail\": [\"email\", \"message\"],\n \"map-pin\": [\"location\", \"navigation\", \"travel\", \"marker\"],\n \"map\": [\"location\", \"navigation\", \"travel\"],\n \"maximize\": [\"fullscreen\"],\n \"maximize-2\": [\"fullscreen\", \"arrows\", \"expand\"],\n \"meh\": [\"emoji\", \"face\", \"neutral\", \"emotion\"],\n \"menu\": [\"bars\", \"navigation\", \"hamburger\"],\n \"message-circle\": [\"comment\", \"chat\"],\n \"message-square\": [\"comment\", \"chat\"],\n \"mic-off\": [\"record\", \"sound\", \"mute\"],\n \"mic\": [\"record\", \"sound\", \"listen\"],\n \"minimize\": [\"exit fullscreen\", \"close\"],\n \"minimize-2\": [\"exit fullscreen\", \"arrows\", \"close\"],\n \"minus\": [\"subtract\"],\n \"monitor\": [\"tv\", \"screen\", \"display\"],\n \"moon\": [\"dark\", \"night\"],\n \"more-horizontal\": [\"ellipsis\"],\n \"more-vertical\": [\"ellipsis\"],\n \"mouse-pointer\": [\"arrow\", \"cursor\"],\n \"move\": [\"arrows\"],\n \"music\": [\"note\"],\n \"navigation\": [\"location\", \"travel\"],\n \"navigation-2\": [\"location\", \"travel\"],\n \"octagon\": [\"stop\"],\n \"package\": [\"box\", \"container\"],\n \"paperclip\": [\"attachment\"],\n \"pause\": [\"music\", \"stop\"],\n \"pause-circle\": [\"music\", \"audio\", \"stop\"],\n \"pen-tool\": [\"vector\", \"drawing\"],\n \"percent\": [\"discount\"],\n \"phone-call\": [\"ring\"],\n \"phone-forwarded\": [\"call\"],\n \"phone-incoming\": [\"call\"],\n \"phone-missed\": [\"call\"],\n \"phone-off\": [\"call\", \"mute\"],\n \"phone-outgoing\": [\"call\"],\n \"phone\": [\"call\"],\n \"play\": [\"music\", \"start\"],\n \"pie-chart\": [\"statistics\", \"diagram\"],\n \"play-circle\": [\"music\", \"start\"],\n \"plus\": [\"add\", \"new\"],\n \"plus-circle\": [\"add\", \"new\"],\n \"plus-square\": [\"add\", \"new\"],\n \"pocket\": [\"logo\", \"save\"],\n \"power\": [\"on\", \"off\"],\n \"printer\": [\"fax\", \"office\", \"device\"],\n \"radio\": [\"signal\"],\n \"refresh-cw\": [\"synchronise\", \"arrows\"],\n \"refresh-ccw\": [\"arrows\"],\n \"repeat\": [\"loop\", \"arrows\"],\n \"rewind\": [\"music\"],\n \"rotate-ccw\": [\"arrow\"],\n \"rotate-cw\": [\"arrow\"],\n \"rss\": [\"feed\", \"subscribe\"],\n \"save\": [\"floppy disk\"],\n \"scissors\": [\"cut\"],\n \"search\": [\"find\", \"magnifier\", \"magnifying glass\"],\n \"send\": [\"message\", \"mail\", \"email\", \"paper airplane\", \"paper aeroplane\"],\n \"settings\": [\"cog\", \"edit\", \"gear\", \"preferences\"],\n \"share-2\": [\"network\", \"connections\"],\n \"shield\": [\"security\", \"secure\"],\n \"shield-off\": [\"security\", \"insecure\"],\n \"shopping-bag\": [\"ecommerce\", \"cart\", \"purchase\", \"store\"],\n \"shopping-cart\": [\"ecommerce\", \"cart\", \"purchase\", \"store\"],\n \"shuffle\": [\"music\"],\n \"skip-back\": [\"music\"],\n \"skip-forward\": [\"music\"],\n \"slack\": [\"logo\"],\n \"slash\": [\"ban\", \"no\"],\n \"sliders\": [\"settings\", \"controls\"],\n \"smartphone\": [\"cellphone\", \"device\"],\n \"smile\": [\"emoji\", \"face\", \"happy\", \"good\", \"emotion\"],\n \"speaker\": [\"audio\", \"music\"],\n \"star\": [\"bookmark\", \"favorite\", \"like\"],\n \"stop-circle\": [\"media\", \"music\"],\n \"sun\": [\"brightness\", \"weather\", \"light\"],\n \"sunrise\": [\"weather\", \"time\", \"morning\", \"day\"],\n \"sunset\": [\"weather\", \"time\", \"evening\", \"night\"],\n \"tablet\": [\"device\"],\n \"tag\": [\"label\"],\n \"target\": [\"logo\", \"bullseye\"],\n \"terminal\": [\"code\", \"command line\", \"prompt\"],\n \"thermometer\": [\"temperature\", \"celsius\", \"fahrenheit\", \"weather\"],\n \"thumbs-down\": [\"dislike\", \"bad\", \"emotion\"],\n \"thumbs-up\": [\"like\", \"good\", \"emotion\"],\n \"toggle-left\": [\"on\", \"off\", \"switch\"],\n \"toggle-right\": [\"on\", \"off\", \"switch\"],\n \"tool\": [\"settings\", \"spanner\"],\n \"trash\": [\"garbage\", \"delete\", \"remove\", \"bin\"],\n \"trash-2\": [\"garbage\", \"delete\", \"remove\", \"bin\"],\n \"triangle\": [\"delta\"],\n \"truck\": [\"delivery\", \"van\", \"shipping\", \"transport\", \"lorry\"],\n \"tv\": [\"television\", \"stream\"],\n \"twitch\": [\"logo\"],\n \"twitter\": [\"logo\", \"social\"],\n \"type\": [\"text\"],\n \"umbrella\": [\"rain\", \"weather\"],\n \"unlock\": [\"security\"],\n \"user-check\": [\"followed\", \"subscribed\"],\n \"user-minus\": [\"delete\", \"remove\", \"unfollow\", \"unsubscribe\"],\n \"user-plus\": [\"new\", \"add\", \"create\", \"follow\", \"subscribe\"],\n \"user-x\": [\"delete\", \"remove\", \"unfollow\", \"unsubscribe\", \"unavailable\"],\n \"user\": [\"person\", \"account\"],\n \"users\": [\"group\"],\n \"video-off\": [\"camera\", \"movie\", \"film\"],\n \"video\": [\"camera\", \"movie\", \"film\"],\n \"voicemail\": [\"phone\"],\n \"volume\": [\"music\", \"sound\", \"mute\"],\n \"volume-1\": [\"music\", \"sound\"],\n \"volume-2\": [\"music\", \"sound\"],\n \"volume-x\": [\"music\", \"sound\", \"mute\"],\n \"watch\": [\"clock\", \"time\"],\n \"wifi-off\": [\"disabled\"],\n \"wifi\": [\"connection\", \"signal\", \"wireless\"],\n \"wind\": [\"weather\", \"air\"],\n \"x-circle\": [\"cancel\", \"close\", \"delete\", \"remove\", \"times\", \"clear\"],\n \"x-octagon\": [\"delete\", \"stop\", \"alert\", \"warning\", \"times\", \"clear\"],\n \"x-square\": [\"cancel\", \"close\", \"delete\", \"remove\", \"times\", \"clear\"],\n \"x\": [\"cancel\", \"close\", \"delete\", \"remove\", \"times\", \"clear\"],\n \"youtube\": [\"logo\", \"video\", \"play\"],\n \"zap-off\": [\"flash\", \"camera\", \"lightning\"],\n \"zap\": [\"flash\", \"camera\", \"lightning\"],\n \"zoom-in\": [\"magnifying glass\"],\n \"zoom-out\": [\"magnifying glass\"]\n}\n" }, { "path": "src/to-svg.js", "content": "import icons from './icons';\n\n/**\n * Create an SVG string.\n * @deprecated\n * @param {string} name\n * @param {Object} attrs\n * @returns {string}\n */\nfunction toSvg(name, attrs = {}) {\n console.warn(\n 'feather.toSvg() is deprecated. Please use feather.icons[name].toSvg() instead.',\n );\n\n if (!name) {\n throw new Error('The required `key` (icon name) parameter is missing.');\n }\n\n if (!icons[name]) {\n throw new Error(\n `No icon matching '${name}'. See the complete list of icons at https://feathericons.com`,\n );\n }\n\n return icons[name].toSvg(attrs);\n}\n\nexport default toSvg;\n" }, { "path": "webpack.config.js", "content": "const path = require('path');\n\nmodule.exports = {\n entry: ['core-js/es/array/from', path.resolve(__dirname, 'src/index.js')],\n output: {\n path: path.resolve(__dirname, 'dist'),\n libraryTarget: 'umd',\n library: 'feather',\n // Prevents webpack from referencing `window` in the UMD build\n // Source: https://git.io/vppgU\n globalObject: \"typeof self !== 'undefined' ? self : this\",\n },\n devtool: 'source-map',\n module: {\n rules: [\n {\n test: /\\.js$/,\n loader: 'babel-loader',\n exclude: /node_modules/,\n },\n ],\n },\n};\n" } ]