-
Notifications
You must be signed in to change notification settings - Fork 1.3k
feat(svg-sprite): Adds build sprite script with tests and docs #319
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
5996edc
feat(svg-sprite): Adds build sprite script with tests and docs
c28aeea
feat(svg-sprite): Adds build sprite script with tests and docs
7b5bdfa
feat(svg-sprite): Adds build sprite script with tests and docs
32ca4bb
feat(svg-sprite): Adds build sprite script with tests and docs
e97a39e
feat(svg-sprite): Adds build sprite script with tests and docs
ba70b75
feat(svg-sprite): Adds build sprite script with tests and docs
abf4b1e
feat(svg-sprite): Adds build sprite script with tests and docs
1935455
feat(svg-sprite): fixes and recommendations
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
14 changes: 14 additions & 0 deletions
14
bin/__tests__/__snapshots__/build-sprite-string.test.js.snap
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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>" | ||
| `; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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(); | ||
| }); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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; | ||
| }); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Awesome, can you add this to the table of contents?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yes, sure! I forgot that, I'm not used to contribute to such well made projects.