@mapbox/spritezero
    DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/mapbox__spritezero package

    8.0.0 • Public • Published

    npm version Build Status

    spritezero

    Small opinionated sprites.

    Why is this different than sprite generation libraries like spritesmith? spritezero was initially created to power a sprite API, and thus is geared towards performance, as well as an ability to work with image data in buffers rather than on disk. Also, since version 2.0, spritezero generates sprites based on SVG graphics alone, therefore making it possible to support @2x and higher-dpi sprites from the same source.

    Usage

    var spritezero = require('@mapbox/spritezero');
    var fs = require('fs');
    var glob = require('glob');
    var path = require('path');
    
    [1, 2, 4].forEach(function(pxRatio) {
        var svgs = glob.sync(path.resolve(path.join(__dirname, 'input/*.svg')))
            .map(function(f) {
                return {
                    svg: fs.readFileSync(f),
                    id: path.basename(f).replace('.svg', '')
                };
            });
        var pngPath = path.resolve(path.join(__dirname, 'output/sprite@' + pxRatio + '.png'));
        var jsonPath = path.resolve(path.join(__dirname, 'output/sprite@' + pxRatio + '.json'));
    
        // Pass `true` in the layout parameter to generate a data layout
        // suitable for exporting to a JSON sprite manifest file.
        spritezero.generateLayout({ imgs: svgs, pixelRatio: pxRatio, format: true }, function(err, dataLayout) {
            if (err) return;
            fs.writeFileSync(jsonPath, JSON.stringify(dataLayout));
        });
    
        // Pass `false` in the layout parameter to generate an image layout
        // suitable for exporting to a PNG sprite image file.
        spritezero.generateLayout({ imgs: svgs, pixelRatio: pxRatio, format: false }, function(err, imageLayout) {
            spritezero.generateImage(imageLayout, function(err, image) {
                if (err) return;
                fs.writeFileSync(pngPath, image);
            });
        });
    
    });

    Documentation

    Complete API documentation is here: http://mapbox.github.io/spritezero/

    Installation

    Requires nodejs v10.0.0 or greater.

    $ npm install @mapbox/spritezero

    Executable

    spritezero-cli is an executable for bundling and creating your own sprites from a folder of svg's:

    $ npm install -g @mapbox/spritezero-cli
    $ spritezero --help
    
    Usage:
    spritezero [output filename] [input directory]
      --retina      shorthand for --ratio=2
      --ratio=[n]   pixel ratio

    Install

    npm i @mapbox/spritezero

    DownloadsWeekly Downloads

    370

    Version

    8.0.0

    License

    ISC

    Unpacked Size

    33.8 kB

    Total Files

    10

    Last publish

    Collaborators

    • mapbox-npm-01
    • mapbox-npm-02
    • mapbox-npm-07
    • mapbox-npm-03
    • mapbox-npm-04
    • mapbox-npm-09
    • mapbox-npm-05
    • mapbox-npm-06
    • mapbox-npm-08
    • mapbox-npm-advanced-actions
    • mapbox-npm-ci
    • mapbox-npm
    • mapbox-admin
    • mapbox-machine-user