squaresplit
v1.0.2
Published
A tiny library for spitting a square into smaller squares
Downloads
170
Maintainers
Readme
squaresplit
A tiny JavaScript library for splitting a single square container into multiple squares. which is useful for generating CSS sprites and WebGL textures. This library was inspired by mapbox/potpack
Demo
Example usage
import squaresplit from 'squaresplit';
const numberOfSquares = 50
const size = 1024 // optional
const {squares fill} = potpack(numberOfSquares,size);
// squares is resulting squares with format {w: number, h: number, x: number, y: number}
// fill is the space utilization value (0 to 1), higher is better
//squares are ordered from biggest width to least
squares[0]; // {w: 300, h: 300, x: 0, y: 0}
squares[1]; // {w: 100, h: 100, x: 100, y: 0}
Install
Install with NPM: npm install squaresplit
.
In Node, you can't use require
— only import
in ESM-capable versions (v12.15+):
import squaresplit from 'squaresplit';