🚧🚧 EXPERIMENTAL! WORK IN PROGRESS! 🚧🚧
Generate appropriately resized and optimized images into your website, using a configuration that can be shared with client-side libraries.
@mapbox/appropriate-images-react can be used to do this in React, with a component that measures its own available width.
generate(imageConfig: Object, options: Object): Promise<Array<string>>
imageConfig is an image configuration.
Options are documented below.
Returns a Promise that resolves with an array of filenames for the resized and optimized images that have been written to your output directory.
When the Promise rejects, it may reject with a single error or an array of errors.
For each image it will:
Output filenames have suffixes corresponding to the size of the variant. For example, with the following property in your image configuration:
bear:basename: 'bear.png'sizes:width: 300width: 600 height: 200/* ... */
You will get files with the following basenames:
string(required) - Path to your directory of source images. The
basenames in your image configuration should be relative to this directory.
string(required) - Path to the directory where resized, optimized images should be written.
?Array<string>- Ids of images to be processed. Image ids correspond to keys in the image configuration. If not provided, all images in the configuration will be processed.
?Object- Options for imageminPngquant.
?Object- Options for imageminMozjpeg.
?Object- Options for imageminWebp.
const appropriateImages = ;const myImageConfig = ;;
createCli(imageConfig: Object, options: Object): void
Create a CLI for your specific directory structure, providing a quick way to generate and re-generate images, with nice error handling.
This package exposes the
createCli function instead of an actual CLI because it is not convenient to completely configure it from the command line.
createCli, you can configure it within a JS file, then run that JS file as a CLI.
#!/usr/bin/env node'use strict';const appropriateImages = ;const myImageConfig = ;const myOptions =inputDirectory: '../path/to/my/source/image/directory/'outputDirectory: '../path/to/directory/where/i/want/resized/optimized/images/';;
Don't forget to
chmod +x path/to/file to make it executable.
Then you can run it as a CLI:
my-appropriate-images horse bear pig my-appropriate-images --all --quiet
The image configuration is an object. For every property:
id. This image id is used by all of the fucntions above,
Each image's configuration object includes the following:
The path from
options.inputDirectory to the image (including the image's extension).
An array of objects representing sizes. Each size must include a
width, and can optionally include other properties.
number(required) - A width for the generated image.
?number- The height for the generated image. If no
heightis provided, the
widthis used and the image's aspect ratio is preserved. If a
heightis provided and it does not fit the image's aspect ratio, the image will be cropped.
'center'. Defines the manner in which the image will be cropped if both
heightare provided. Must be a valid
cropvalue for sharp: