# broccoli-spritesmith

> Broccoli sass/scss spritesmith plugins

Latest version **0.0.12** (published 2015-01-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install broccoli-spritesmith
pnpm add broccoli-spritesmith
yarn add broccoli-spritesmith
bun add broccoli-spritesmith
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.12 |
| Published | 2015-01-26 |
| First published | 2014-07-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 8 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Hysios Hu |
| Maintainers | hysios |

## Links

- npm: https://www.npmjs.com/package/broccoli-spritesmith
- Repository: https://github.com/hysios/broccoli-spritesmith
- Issues: https://github.com/hysios/broccoli-spritesmith/issues
- npm.io page: https://npm.io/package/broccoli-spritesmith

## Dependencies (8)

- [rsvp](https://npm.io/package/rsvp.md) ^3.0.9
- [colors](https://npm.io/package/colors.md) ^0.6.2
- [mkdirp](https://npm.io/package/mkdirp.md) ^0.5.0
- [walk-sync](https://npm.io/package/walk-sync.md) ^0.1.2
- [lodash-node](https://npm.io/package/lodash-node.md) ^2.4.1
- [spritesmith](https://npm.io/package/spritesmith.md) ^0.19.2
- [broccoli-writer](https://npm.io/package/broccoli-writer.md) ^0.1.1
- [broccoli-replace](https://npm.io/package/broccoli-replace.md) ^0.1.7

## Recent versions

- 0.0.12 (latest) — 2015-01-26
- 0.0.10 — 2014-10-06
- 0.0.9 — 2014-08-24
- 0.0.8 — 2014-08-24
- 0.0.7 — 2014-08-24
- 0.0.6 — 2014-08-24
- 0.0.5 — 2014-08-24
- 0.0.4 — 2014-08-22
- 0.0.3 — 2014-07-24
- 0.0.2 — 2014-07-23
- 0.0.1 — 2014-07-23

## README

broccoli-spritesmith
--------------------

this is spritesmit for broccoli plugins


Usage
-----

Example

```js 
	var BroccoliSpritesmith = require('broccoli-spritesmith'),
	var spriteTree = BroccoliSpritesmith('test/images');

```

API
---

BroccoliSpritesmith(tree, options)

Example `options` object:
```js
{
    output: 'all',
    outputPath: 'assets',
    spriteName: 'sprites',
    ext: 'png',

    // sprite engine arguments   
    engine: 'auto', // e.g. phantomjs, canvas, ...
    algorithm: 'binary-tree',
    padding: 5
}
```


`output` defaults is 'all', can be set `'scss'`, `'image'`, '`less`', but now only support `'scss'` , `'image'`

`engine`, `algorithm`, `padding` are spritesmith [options](https://github.com/Ensighten/spritesmith#documentation)

License

MIT © Hysios Hu

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