https://github.com/coveooss/png-sprite

Gulp task that converts images to sprites+css
https://github.com/coveooss/png-sprite

Last synced: about 2 months ago
JSON representation

Gulp task that converts images to sprites+css

• Host: GitHub
• URL: https://github.com/coveooss/png-sprite
• Owner: coveooss
• License: mit
• Created: 2014-11-28T23:59:18.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2024-09-24T17:30:18.000Z (8 months ago)
• Last Synced: 2025-03-25T22:21:37.892Z (2 months ago)
• Language: JavaScript
• Homepage:
• Size: 37.1 KB
• Stars: 4
• Watchers: 28
• Forks: 2
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
coveo-png-sprite

==========

[![npm](https://img.shields.io/npm/v/coveo-png-sprite.svg?style=flat-square)](https://www.npmjs.com/package/coveo-png-sprite)

[![dependencies](https://img.shields.io/david/Coveo/png-sprite.svg?style=flat-square)](https://david-dm.org/Coveo/png-sprite)

[![Code Climate](https://img.shields.io/codeclimate/github/Coveo/png-sprite.svg?style=flat-square)](https://codeclimate.com/github/Coveo/png-sprite)

[![license](http://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](https://github.com/Coveo/png-sprite/blob/master/LICENSE)

coveo-png-sprite is a gulp module that creates sprite sheets from multiple images

```js

var gulp = require('gulp');

var pngSprite = require('coveo-png-sprite');

gulp.task('buildSprites', function (done) {

  return gulp.src('img/**/*.png')

      .pipe(pngSprite.gulp({

        cssPath: 'sprites.scss',

        pngPath: 'sprites.png',

        namespace: 'sprites'

      }))

      .pipe(gulp.dest('./target/'))

});

```

```js

var fs = require('fs');

var Sprite = require('coveo-png-sprite').Sprite;

var sprite = new Sprite();

sprite.addImageSrc([

  "./img/a.png",

  "./img/b.png",

  "./img/c.png",

  "./img/d.png"

], function(){

  var obj = sprite.compile('./sprite.png');

  obj.png.pipe(fs.createWriteStream('sprite.png'));

  fs.writeFile('sprite.css', obj.css);

});

```