Skip to content

Utility which able collect png and svg files and generate Sprite Sheet (CSS Sprites)

License

Notifications You must be signed in to change notification settings

Megaputer/sprite-generator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

sprite-generator

Purpose of this utility to simplify generation of sprite sheets (CSS sprites).

Built on top of spritesmith and svg-sprite.

Example

let {SpriteGenerator} = require('sprite-generator');

let sprite = new SpriteGenerator({
  sprites: [
    // PNG icons
    {name: 'png-pack', sourceFolder: 'images/png'},
    // SVG icons
    {name: 'svg-pack', sourceFolder: 'images/svg', include: /\.svg$/i},
  ],

  targetFolder: {
    icons: 'build/images/sprites',
    scss: 'src/build/sprites',
    ts: 'src/build/sprites'
  },

  classes: {
    base: 'i',
    sprite: 's',
    size: 'x',
    icon: 'i'
  },

  url: `image-path('sprites/#SPRITE_FILE')`
});

sprite.generate();

Utility will create several scss and ts files in targetFolder.

License

Licensed under the MIT license.

About

Utility which able collect png and svg files and generate Sprite Sheet (CSS Sprites)

Resources

License

Stars

Watchers

Forks

Packages

No packages published