bestfit
Finds image rendition that best fits a given container.
var bestfit = ; var renditions = width: 2 height: 1 id: 0 width: 3 height: 15 id: 1 width: 1 height: 05 id: 2 width: 4 height: 2 id: 3 ; var fn = ;;
Output
{ width: 3,
height: 1.5,
id: 1,
widthPercentage: 1.5,
heightPercentage: 1 }
Installation
npm install bestfit
API
-
bestfit(renditions) → {function}
-
Finds image rendition that best fits a given container preferring images that are too large over images that are too small.
Note: all renditions are assumed to have the same aspect ratio
Parameters:
Name Type Description renditions
Array.<Object> available image renditions each having a width and height property
- Source:
Returns:
when called with available width and height it returns the best fitting rendition
- Type
- function
generated with docme
License
MIT