Compile cloudinary URLs at build time.
You can define the globals for your cloudinary URLs in a cloudinaryrc.json that should be placed in the root of your project.
{ "native": { "cloud_name": "trivago", "secure": true }, "overrideBaseUrl": true, "host": "trivago.images.com", "defaultTransforms": { "fetch_format": "auto", "quality": "auto" } }- native - these are directly passed into the
cloudinary-coreupon instantiation, you can use all the configs in the official cloudinary API. - overrideBaseUrl - set this to true if you want to override cloudinary default URL with the property host.
- host - a host to perform replace the default generated base URL (
res.cloudinary.com/trivago/image/upload). - defaultTransforms - an object that holds transforms that are applied by default to all the generated cloudinary URLs. These properties can still be overwritten for individual cases, by passing the same property within the
option.transformsof that__buildCloudinaryUrlcall.
__buildCloudinaryUrl(assetName, options);http[s]://host/<transforms>/<prefix><assetName><postfix><resourceExtension>
- assetName {string} [mandatory] - a string that represents the asset/image name.
- options {object} [optional] - the options object aggregates a series of optional parameters that you can feed in to the plugin in order to customize your URL. Again note that all parameters inside of
optionsare entirely optional. - options.transforms {object} - these object are the cloudinary transformations to apply to the URL (e.g.
{height: 250, width: 250}). For convince they will keep the same API as the cloudinary-core image transformations, these said you can check the official docs and use thecloudinary-coreAPI directly. - options.prefix {string} - a prefix string for you
assetName. - options.postfix {string} - a postfix string for you
assetName. - options.resourceExtension {string} - the resource extension (e.g. ".jpeg", ".png"). You can also specify the extension within the
assetName, let's suppose that yourassetNameisdog-pictureyou can simple passdog-picture.jpegwithin theassetNameitself. This optional parameter is only here you to give you a more robust API and also the possibility to interpolate theprefixandpostfixwith theassetNameas you can see in the url above URL structure<prefix><assetName><postfix><resourceExtension>.
npm install babel-plugin-cloudinary
{ "plugins": ["babel-plugin-cloudinary"] }// gallery.js function getImageUrl(imageName) { // compiles into "`${'https://res.cloudinary.com/<cloud_name>/image/upload/'}${imageName}${'.jpeg'}`;" return __buildCloudinaryUrl(imageName, { transforms: { width: 250, height: 250, }, resourceExtension: ".jpeg", }); }This projects ships together with the plugin a types definition file (index.d.ts) that will be automatically recognized by IDEs and text editors with typescript based IntelliSense. In case you have some linting in place it might also be convenient to make __buildCloudinaryUrl a global. With eslint you can achieve this by adding a simple property to the globals block just like:
// .eslintrc.js module.exports = { // ... globals: { // ... __buildCloudinaryUrl: true, }, // ... };