Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mixtur/webpack-spritesmith
Webpack plugin that converts set of images into a spritesheet and SASS/LESS/Stylus mixins
https://github.com/mixtur/webpack-spritesmith
spritesmith webpack-plugin
Last synced: about 2 months ago
JSON representation
Webpack plugin that converts set of images into a spritesheet and SASS/LESS/Stylus mixins
- Host: GitHub
- URL: https://github.com/mixtur/webpack-spritesmith
- Owner: mixtur
- Created: 2015-11-12T07:54:38.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2023-01-04T01:12:19.000Z (over 1 year ago)
- Last Synced: 2024-04-14T22:18:42.964Z (5 months ago)
- Topics: spritesmith, webpack-plugin
- Language: JavaScript
- Size: 1.38 MB
- Stars: 497
- Watchers: 6
- Forks: 56
- Open Issues: 18
-
Metadata Files:
- Readme: Readme.md
- Changelog: CHANGELOG.MD
Awesome Lists containing this project
README
[](https://www.npmjs.com/package/webpack-spritesmith)
A webpack plugin that converts a set of images into a spritesheet and SASS/LESS/Stylus mixins, using
[spritesmith](https://github.com/Ensighten/spritesmith) and [spritesheet-templates](https://github.com/twolfson/spritesheet-templates)
All ideas are shamelessly taken from [gulp.spritesmith](https://github.com/twolfson/gulp.spritesmith).
### Example
Let's say you have the following folder structure
```
/
|-src
| |-ico
| | |-new.png
| | |-open.png
| | |-save.png
| | ...
| |-style.styl
| ...
|-webpack.config.js
```
Then you need to instantiate the plugin in the webpack config like this:
```javascript
//webpack.config.js
var path = require('path');
var SpritesmithPlugin = require('webpack-spritesmith');
module.exports = {
// ...
module: {
rules: [
{test: /\.styl$/, use: [
'style-loader',
'css-loader',
'stylus-loader'
]},
{test: /\.png$/, use: [
'file-loader?name=i/[hash].[ext]'
]}
]
},
resolve: {
modules: ["node_modules", "spritesmith-generated"]
},
plugins: [
new SpritesmithPlugin({
src: {
cwd: path.resolve(__dirname, 'src/ico'),
glob: '*.png'
},
target: {
image: path.resolve(__dirname, 'src/spritesmith-generated/sprite.png'),
css: path.resolve(__dirname, 'src/spritesmith-generated/sprite.styl')
},
apiOptions: {
cssImageRef: "~sprite.png"
}
})
]
// ...
};
```
And then just use it
```stylus
//style.styl
@import '~sprite.styl'
.close-button
sprite($close)
.open-button
sprite($open)
```
There are a few things to notice in config
- file-loader used for generated image
- `resolve` contains location of where generated image is
- cssImageRef is specified as '~sprite.png'
So the way generated image is accessed from the generated API now must be specified manually.
### Config
- `src` - used to build a list of source images
- `cwd` should be the closest common directory for all source images;
- `glob` well... it is a glob
- `options` - optional. These options are passed down to the packages that handle the globbing of images. (We use [gaze](https://github.com/shama/gaze), which passes them down to [globule](https://github.com/cowboy/node-globule), which also passes them down to [node-glob](https://github.com/isaacs/node-glob#options).)
`cwd` and `glob` both will be passed directly to [glob](https://github.com/isaacs/node-glob) (and [gaze](https://github.com/shama/gaze)
in watch mode), then the resulting list of files will be used as a list of source images
- `target` - generated files
- `image` - the target image's filename. Can be interpolated with [loader-utils](https://github.com/webpack/loader-utils#interpolatename). I would recommend to use file-loader for interpolation though.
- `css` - can be one of the following
- `"full/path/to/spritesheet/api"` - for example `path.resolve(__dirname, 'src/spritesmith-generated/sprite.styl')`
- `["full/path/to/spritesheet/api1", "full/path/to/spritesheet/api2"]`,
- `["full/path/to/spritesheet/api1", ["full/path/to/spritesheet/api2", spritesmithTemplatesOptions]]`
spritesmithTemplatesOptions - is the second argument [here](https://github.com/twolfson/spritesheet-templates#templaterdata-options)
for example
```javascript
...
css: [
path.resolve(__dirname, 'src/spritesmith-generated/sprite.styl'),
[path.resolve(__dirname, 'src/spritesmith-generated/sprite.json'), {
format: 'json_texture'
}]
]
```
- `apiOptions` - optional
- `generateSpriteName` - a function. Takes a full path to a source image file and expected to return
name by which it will be referenced in API. Return value will be used as `sprite.name` for
[spritesheet-templates](https://github.com/twolfson/spritesheet-templates). Default behaviour is to
use filename (without dirname and extension)
- `spritesheet_name`, `retina_spritesheet_name` - passed to [spritesheet-templates](https://github.com/twolfson/spritesheet-templates) (`retina_spritesheet_name` only takes effect if `apiOptions.retina` is also specified)
- `cssImageRef` - a path by which a generated image will be referenced in API. If target.image is interpolated, `cssImageRef` should be interpolated the same way too.
- `handlebarsHelpers` - an object. Container for helpers to register to handlebars for our template
- Each key-value pair is the name of a handlebars helper corresponding to its function
- For example, `{half: function (num) { return num/2; }` will add a handlebars helper that halves numbers
- Note that handlebarsHelpers is global. If you have multiple instances of SpritesmithPlugin, helpers defined later will override helpers defined earlier.
- `spritesmithOptions` - optional. Options for [spritesmith](https://github.com/Ensighten/spritesmith)
- `retina` - optional, when specified, uses retina capabilities of [spritesheet-templates](https://github.com/twolfson/spritesheet-templates). Can be either a suffix string (like '@2x') or an object consisting of three fields:
- `classifier` - `Function` that allows to say which source is for retina spritesheet and which is not. Will be called with full path to source file, and should return an object of this format -
```javascript
{
type: String, // determines which kind of source is this. May take one of the two values: 'retina' and 'normal'
normalName: String, //a full path to the corresponding normal source image
retinaName: String, //a full path to the corresponding retina source image
}
```
- `targetImage` - a full path to the generated retina image
- `cssImageRef` - a path by which generated image will be referenced in the API
When used as a suffix string it applies to source files, a filename for retina spritesheet image and cssImageRef
`apiOptions.generateSpriteName` will be applied to `normalName` returned by `retina.classifier`
- `customTemplates` - optional. An object with keys and values corresponding to format names and template descriptions respectively.
Template description can be either a `path/to/handlebars/template/file` or a template function
You can use templates registered here as `format` in "target.css"
For example you can write something like this
```javascript
//webpack.config.js
var templateFunction = function (data) {
var shared = '.ico { background-image: url(I) }'
.replace('I', data.sprites[0].image);
var perSprite = data.sprites.map(function (sprite) {
return '.ico-N { width: Wpx; height: Hpx; background-position: Xpx Ypx; }'
.replace('N', sprite.name)
.replace('W', sprite.width)
.replace('H', sprite.height)
.replace('X', sprite.offset_x)
.replace('Y', sprite.offset_y);
}).join('\n');
return shared + '\n' + perSprite;
};
module.exports = {
...
plugins: [
new SpritesmithPlugin({
target: {
...
css: [
[path.resolve(__dirname, 'src/spritesmith-generated/sprite-1.css'), {
format: 'function_based_template'
}],
[path.resolve(__dirname, 'src/spritesmith-generated/sprite-2.css'), {
format: 'handlebars_based_template'
}]
]
},
customTemplates: {
'function_based_template': templateFunction,
'handlebars_based_template': path.resolve(__dirname, '../my_handlebars_template.handlebars')
},
...
})
]
}
```
- `logCreatedFiles` optional. When set to `true` will `console.log` a list of created files.
__This scary readme file is a cry for help. If someone can improve it please do. Also the config itself is terrible, it could also use some improvement. I welcome any reasonable suggestions. Thank you.__