@megaputer/sprite-generator
TypeScript icon, indicating that this package has built-in type declarations

1.2.2 • Public • Published

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.

Readme

Keywords

none

Package Sidebar

Install

npm i @megaputer/sprite-generator

Weekly Downloads

2

Version

1.2.2

License

none

Unpacked Size

111 kB

Total Files

7

Last publish

Collaborators

  • ulop
  • c0gnize