payload-base64-plugin
v1.2.0
Published
Payload CMS plugin for automatic base64 encoding of images
Downloads
22
Readme
payload-blurhash-plugin
Payload CMS plugin for automatic base64 encoding of images.
Getting started
- Install the package with
npm i payload-base64-plugin
oryarn add payload-base64-plugin
. - Add the plugin to your
payload.config.ts
:
import generateBase64 from 'payload-blurhash-plugin';
export default buildConfig({
/* ... */
plugins: [generateBase64()],
});
Plugin options
Optionally, you can pass the following options to tweak the behavior of the plugin:
export interface Base64PluginOptions {
/*
* Array of collection slugs that the plugin should apply to.
* By default, the plugin will apply to all collections with `upload` properties.
*/
collections?: CollectionConfig['slug'][];
/*
* an integer (between 4 and 64) to adjust the returned placeholder size
* Default: 4
*/
size?: number;
/*
* turn on/off the alpha channel removal
* Default: true
*/
removeAlpha?: boolean;
}
Credits
This plugin is heavily based on the plugin payload-blurhash-plugin by invakid404.
Since I only changed the encoding to base64, I decided to fork the original plugin instead of creating a new one.
Thank you a lot for your work!