Compare commits

..

15 Commits

Author SHA1 Message Date
93dd65f8c5 feat: Add archive icon 2018-03-01 23:05:04 -08:00
031f305c83 feat: Add icon 2018-03-01 23:05:04 -08:00
1180d2d8b4 feat: Add gift icon 2018-03-01 23:05:04 -08:00
3422f0aaf7 feat: Add SVG sprite support (#319) 2018-02-20 16:30:59 -08:00
b3655c438f fix: Fix semantic-release deploys
Updated .travis.yml to match the example provided in the documentation
https://semantic-release.gitbooks.io/semantic-release/content/docs/recipes/travis.html
2018-02-20 12:48:09 -08:00
5a8a8b7d93 fix: Reorder help-circle elements (#308) 2018-02-07 08:20:57 -08:00
ba33c8312e Merge pull request #278 from feathericons/dependabot/npm_and_yarn/eslint-plugin-prettier-2.5.0
chore(dependencies): Bump eslint-plugin-prettier from 2.4.0 to 2.5.0
2018-01-19 09:32:05 -08:00
b157434645 Merge pull request #277 from feathericons/dependabot/npm_and_yarn/semantic-release-12.2.2
chore(dependencies): Bump semantic-release from 8.2.0 to 12.2.2
2018-01-19 06:43:27 -08:00
6adadf4319 chore(dependencies): Bump eslint-plugin-prettier from 2.4.0 to 2.5.0
Bumps [eslint-plugin-prettier](https://github.com/prettier/eslint-plugin-prettier) from 2.4.0 to 2.5.0.
- [Changelog](https://github.com/prettier/eslint-plugin-prettier/blob/master/CHANGELOG.md)
- [Commits](https://github.com/prettier/eslint-plugin-prettier/compare/v2.4.0...v2.5.0)
2018-01-19 05:50:26 +00:00
7ea765f04f chore(dependencies): Bump semantic-release from 8.2.0 to 12.2.2
Bumps [semantic-release](https://github.com/semantic-release/semantic-release) from 8.2.0 to 12.2.2.
- [Release notes](https://github.com/semantic-release/semantic-release/releases)
- [Commits](https://github.com/semantic-release/semantic-release/compare/v8.2.0...v12.2.2)
2018-01-19 05:49:42 +00:00
2dbe78fc02 Merge pull request #260 from feathericons/dependabot/npm_and_yarn/html-minifier-3.5.8
chore(dependencies): Bump html-minifier from 3.5.7 to 3.5.8
2018-01-18 21:48:59 -08:00
0dce8a8fb9 Merge pull request #265 from feathericons/dependabot/npm_and_yarn/eslint-4.15.0
chore(dependencies): Bump eslint from 4.13.1 to 4.15.0
2018-01-18 21:48:25 -08:00
ed0e08a451 chore(dependencies): Bump eslint from 4.13.1 to 4.15.0
Bumps [eslint](https://github.com/eslint/eslint) from 4.13.1 to 4.15.0.
- [Release notes](https://github.com/eslint/eslint/releases)
- [Changelog](https://github.com/eslint/eslint/blob/master/CHANGELOG.md)
- [Commits](https://github.com/eslint/eslint/compare/v4.13.1...v4.15.0)
2018-01-08 08:03:01 +00:00
b5331a253d docs: Updated README.md 2017-12-29 15:16:43 -08:00
ada2681ad4 chore(dependencies): Bump html-minifier from 3.5.7 to 3.5.8
Bumps [html-minifier](https://github.com/kangax/html-minifier) from 3.5.7 to 3.5.8.
- [Release notes](https://github.com/kangax/html-minifier/releases/tag/v3.5.8)
- [Commits](https://github.com/kangax/html-minifier/compare/v3.5.7...v3.5.8)
2017-12-25 07:37:07 +00:00
14 changed files with 894 additions and 844 deletions

View File

@ -9,5 +9,8 @@ before_script:
- npm prune
script:
- npm start
after_success:
- npm run semantic-release
deploy:
provider: script
skip_cleanup: true
script:
- npx semantic-release

View File

@ -27,11 +27,12 @@ npm install feather-icons
* [Usage](#usage)
* [Client-side](#client-side)
* [Node](#node)
* [SVG Sprite](#svg-sprite)
* [API Reference](#api-reference)
* [`feather.icons`](#feathericons)
* [`feather.icons[name].toSvg()`](#feathericonsnametosvgattrs)
* [`feather.replace()`](#featherreplaceattrs)
* [[Deprecated] `feather.toSvg()`](#deprecated-feathertosvgname-attrs)
* [(DEPRECATED) `feather.toSvg()`](#deprecated-feathertosvgname-attrs)
* [Roadmap](#roadmap)
* [Contributing](#contributing)
* [Related Projects](#related-projects)
@ -166,6 +167,42 @@ feather.icons.x.toSvg({ class: 'foo bar', 'stroke-width': 1, color: 'red' })
See the [API Reference](#api-reference) for more information about the available properties and methods of the `feather` object.
### SVG Sprite
A SVG Sprite is also provided, which can be used as following:
```html
<svg class="feather feather-[iconName]"
width="24"
height="24"
fill="none"
stroke="currentColor"
stroke-width="2"
stroke-linecap="round"
stroke-linejoin="round"
>
<use xlink:href="feather-sprite.svg#[iconName]"/>
</svg>
```
Where `iconName` is the name of the icon you want to display.
Same result but using a CSS class:
```css
.feather {
width: 24px;
height: 24px;
stroke: currentColor;
stroke-width: 2;
stroke-linecap: round;
stroke-linejoin: round;
fill: none;
}
```
```html
<svg class="feather feather-[iconName]">
<use xlink:href="feather-sprite.svg#[iconName]"/>
</svg>
```
Prefer using CSS classes to keep things organized.
## API Reference
### `feather.icons`
@ -287,7 +324,7 @@ All attributes on the placeholder element (i.e. `<i>`) will be copied to the `<s
---
### [Deprecated] `feather.toSvg(name, [attrs])`
### (DEPRECATED) `feather.toSvg(name, [attrs])`
> **Note:** `feather.toSvg()` is deprecated. Please use `feather.icons[name].toSvg()` instead.

View File

@ -0,0 +1,14 @@
// Jest Snapshot v1, https://goo.gl/fbAQLP
exports[`builds sprite correctly 1`] = `
"<svg xmlns=\\"http://www.w3.org/2000/svg\\">
<defs>
<symbol id=\\"icon1\\" viewBox=\\"0 0 24 24\\">
<line x1=\\"23\\" y1=\\"1\\" x2=\\"1\\" y2=\\"23\\"></line><line x1=\\"1\\" y1=\\"1\\" x2=\\"23\\" y2=\\"23\\"></line>
</symbol>
<symbol id=\\"icon2\\" viewBox=\\"0 0 24 24\\">
<circle cx=\\"12\\" cy=\\"12\\" r=\\"11\\"></circle>
</symbol>
</defs>
</svg>"
`;

View File

@ -0,0 +1,12 @@
/* eslint-env jest */
import buildSpriteString from '../build-sprite-string';
const icons = {
icon1:
'<line x1="23" y1="1" x2="1" y2="23"></line><line x1="1" y1="1" x2="23" y2="23"></line>',
icon2: '<circle cx="12" cy="12" r="11"></circle>',
};
test('builds sprite correctly', () => {
expect(buildSpriteString(icons)).toMatchSnapshot();
});

View File

@ -0,0 +1,30 @@
import defaultAttrs from '../src/default-attrs.json';
const svgStartTag = `<svg xmlns="${defaultAttrs.xmlns}">\n<defs>\n`;
const svgEndTag = '</defs>\n</svg>';
/**
* Renders the inner sprites as SVG Symbols
* @param {object} icons the icons object
* @returns {string} the rendered string with SVG symbols
*/
function buildSpriteString(icons) {
const symbols = Object.keys(icons)
.map(icon => toSvgSymbol(icon, icons[icon]))
.join('');
return svgStartTag + symbols + svgEndTag;
}
/**
* Renders a SVG symbol tag
* @param {string} name The name of the icon
* @param {string} contents The contents of the icon
* @returns {string} the rendered SVG symbol
*/
function toSvgSymbol(name, contents) {
return `<symbol id="${name}" viewBox="${defaultAttrs.viewBox}">
${contents}\n</symbol>\n`;
}
export default buildSpriteString;

14
bin/build-sprite.js Normal file
View File

@ -0,0 +1,14 @@
import fs from 'fs';
import path from 'path';
import icons from '../dist/icons.json';
import buildSpriteString from './build-sprite-string';
const sprite = buildSpriteString(icons);
const OUT_FILE = path.resolve(__dirname, '../dist/feather-sprite.svg');
console.log(`Building ${OUT_FILE}`); // eslint-disable-line no-console
fs.writeFile(OUT_FILE, sprite, err => {
if (err) throw err;
});

View File

@ -5,6 +5,7 @@
./node_modules/.bin/rimraf dist
mkdir dist
./node_modules/.bin/babel-node bin/build-icons-json.js
./node_modules/.bin/babel-node bin/build-sprite.js
./node_modules/.bin/rimraf dist/icons
mkdir dist/icons

15
icons/archive.svg Normal file
View File

@ -0,0 +1,15 @@
<svg
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"
>
<polyline points="21 8 21 21 3 21 3 8" />
<rect x="1" y="3" width="22" height="5" />
<line x1="10" y1="12" x2="14" y2="12" />
</svg>

After

Width:  |  Height:  |  Size: 340 B

17
icons/gift.svg Normal file
View File

@ -0,0 +1,17 @@
<svg
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"
>
<polyline points="20 12 20 22 4 22 4 12" />
<rect x="2" y="7" width="20" height="5" />
<line x1="12" y1="22" x2="12" y2="7" />
<path d="M12 7H7.5a2.5 2.5 0 0 1 0-5C11 2 12 7 12 7z" />
<path d="M12 7h4.5a2.5 2.5 0 0 0 0-5C13 2 12 7 12 7z" />
</svg>

After

Width:  |  Height:  |  Size: 459 B

View File

@ -9,7 +9,7 @@
stroke-linecap="round"
stroke-linejoin="round"
>
<path d="M9.09 9a3 3 0 0 1 5.83 1c0 2-3 3-3 3" />
<circle cx="12" cy="12" r="10" />
<path d="M9.09 9a3 3 0 0 1 5.83 1c0 2-3 3-3 3" />
<line x1="12" y1="17" x2="12" y2="17" />
</svg>

Before

Width:  |  Height:  |  Size: 339 B

After

Width:  |  Height:  |  Size: 339 B

14
icons/youtube.svg Normal file
View File

@ -0,0 +1,14 @@
<svg
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"
>
<path d="M22.54 6.42a2.78 2.78 0 0 0-1.94-2C18.88 4 12 4 12 4s-6.88 0-8.6.46a2.78 2.78 0 0 0-1.94 2A29 29 0 0 0 1 11.75a29 29 0 0 0 .46 5.33A2.78 2.78 0 0 0 3.4 19c1.72.46 8.6.46 8.6.46s6.88 0 8.6-.46a2.78 2.78 0 0 0 1.94-2 29 29 0 0 0 .46-5.25 29 29 0 0 0-.46-5.33z" />
<polygon points="9.75 15.02 15.5 11.75 9.75 8.48 9.75 15.02" />
</svg>

After

Width:  |  Height:  |  Size: 547 B

1558
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -13,8 +13,7 @@
"test": "jest",
"cm": "git-cz",
"precommit": "lint-staged",
"commitmsg": "commitlint --edit",
"semantic-release": "semantic-release pre && npm publish && semantic-release post"
"commitmsg": "commitlint --edit"
},
"config": {
"commitizen": {
@ -36,19 +35,19 @@
"commitizen": "^2.9.6",
"core-js": "^2.5.3",
"cz-conventional-changelog": "^2.1.0",
"eslint": "^4.13.1",
"eslint": "^4.15.0",
"eslint-config-airbnb-base": "^12.1.0",
"eslint-config-prettier": "^2.9.0",
"eslint-plugin-import": "^2.5.0",
"eslint-plugin-prettier": "^2.4.0",
"html-minifier": "^3.5.7",
"eslint-plugin-prettier": "^2.5.0",
"html-minifier": "^3.5.8",
"husky": "^0.14.3",
"jest": "^21.2.1",
"lint-staged": "^6.0.0",
"npm-run-all": "^4.1.2",
"prettier": "^1.8.2",
"rimraf": "^2.6.2",
"semantic-release": "^8.2.0",
"semantic-release": "^12.2.2",
"svgo": "^0.7.2",
"webpack": "^3.10.0"
},

View File

@ -53,6 +53,7 @@
"folder-minus": ["directory"],
"folder-plus": ["directory"],
"folder": ["directory"],
"gift": ["present", "box", "birthday", "party"],
"git-branch": ["code", "version control"],
"git-commit": ["code", "version control"],
"git-merge": ["code", "version control"],
@ -150,6 +151,7 @@
"x-circle": ["cancel", "close", "delete", "remove", "times"],
"x-square": ["cancel", "close", "delete", "remove", "times"],
"x": ["cancel", "close", "delete", "remove", "times"],
"youtube": ["logo", "video", "play"],
"zap-off": ["flash", "camera", "lightning"],
"zap": ["flash", "camera", "lightning"]
}