Convert a bunch of PNGs to a Sass spritemap.
|
4 years ago | |
---|---|---|
example | 4 years ago | |
lib | 4 years ago | |
test | 4 years ago | |
.eslintrc.json | 4 years ago | |
.gitignore | 4 years ago | |
.npmignore | 4 years ago | |
LICENSE | 4 years ago | |
NOTICE.txt | 4 years ago | |
README.md | 4 years ago | |
package-lock.json | 4 years ago | |
package.json | 4 years ago | |
yarn.lock | 4 years ago |
Convert a bunch of PNGs to a Sass spritemap.
sass-spritemaker requires Node 6.9.0 or later.
npm install --save-dev @bthlabs/sass-spritemaker
This assumes that you’re using npm package manager. sass-spritemaker supports yarn, too.
The following JavaScript code demonstrates the most common usage of the library:
const {spritemaker} = require('../lib/spritemaker.js');
spritemaker({
files: ['./icons/*.png'],
output: './output/'
});
spritemaker(options)
This is the main entrypoint of the library. The options argument is an object that specifies the function's behaviour.
Options object fields:
fields
- array of globs that will be resolved to construct input files
list. Defaults to []
.output
- path to output directory. Defaults to sprite/
.urlPrefix
- URL prefix for background image URLs. Defaults to /
.To bootstrap the development environment, clone the repo and run npm install
from the root directory.
The package.json
file provides the following scripts:
lint
- performs an eslint run over the source code,test
- performs a single test run.If you think you found a bug or want to send a patch, feel free to contact me through e-mail.
If you're sending a patch, make sure it passes eslint checks and is tested.
sass-spritemaker is developed by Tomek Wójcik.
sass-spritemaker is licensed under the MIT License.