# @megaputer/sprite-generator

> Generation sprites

Latest version **1.2.2** (published 2019-01-09) · 0 weekly downloads

## Install

```sh
npm install @megaputer/sprite-generator
pnpm add @megaputer/sprite-generator
yarn add @megaputer/sprite-generator
bun add @megaputer/sprite-generator
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.2 |
| Published | 2019-01-09 |
| First published | 2019-01-09 |
| Weekly downloads | 0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 108.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | c0gnize |

## Links

- npm: https://www.npmjs.com/package/@megaputer/sprite-generator
- npm.io page: https://npm.io/package/@megaputer/sprite-generator

## Dependencies (3)

- [svg-sprite](https://npm.io/package/svg-sprite.md) ^1.5.0
- [pascal-case](https://npm.io/package/pascal-case.md) ^2.0.1
- [spritesmith](https://npm.io/package/spritesmith.md) ^3.3.1

## Recent versions

- 1.2.2 (latest) — 2019-01-09

## README

# sprite-generator

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

Built on top of [spritesmith](https://github.com/Ensighten/spritesmith) and [svg-sprite](https://github.com/jkphl/svg-sprite).

## Example

```typescript
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.

---
_Source: https://npm.io/package/@megaputer/sprite-generator · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._