Getting Started

plaiceholder packages are ESM only (opens in a new tab).

Plaiceholder is a server-side library. It will not work in the browser.

plaiceholder works on all runtimes supported by sharp (opens in a new tab).

sharp (opens in a new tab) is currently limited to Node.js, but there is a pull request (opens in a new tab) to expand support.

Prerequisites

Under-the-hood, Plaiceholder uses the wonderful and powerful sharp (opens in a new tab) library to transform images.

Some frameworks or libraries include sharp by default, so double-check before you install.

npm install sharp

npm install plaiceholder