NPMap Symbol Library
Add requests for new symbols as an issue. Starting in 2018, newly developed symbols will be added to the
src/standalone directory and bundled into periodic releases. Symbol development for NPMap Builder will be temporarily suspended until that application is rewritten to pull symbols from the
standalone directory. A more detailed release checklist can be found here.
The Symbol Library uses a semantic versioning scheme:
- 0.0.z: Bugfixes and modifications
- 0.y.0: Icons added
- x.0.0: Icons removed, sprite scheme changed, or major features added
This repository was originally forked from Mapbox's Maki project, so the file structure is similar.
Source SVG files are in the
src subdirectory. Each symbol is designed at three pixel-perfect sizes (max dimensions 14, 22, and 30 pixels square) and in black and white versions to support different use cases. These can be found in the
src/standalone directory. In addition, a subset of 94 symbols are designed at 12, 18, and 24 pixels square for use in NPMap Builder.
PNG renders of all of the SVGs are in the
renders directory. High-resolution (aka Retina) versions of each icon are present as well, named using the common
You can use the SVGs and PNGs in this repository as they are without building anything, however a render script is included to assist designers/developers who want to modify or create new icons. It will render SVGs to PNGs at 100% and 200% resolution, create sprites used by NPMap.js, NPMap Builder, and the Places Editor, and generate corresponding CSS styles for the sprites.
After installing the required prerequisites, you can run the script like this:
cd npmap-symbol-library npm install bash render.sh