Use Cloudinary parameters

After you install the Cloudinary integration, the following parameter types are available. You can use these to incorporate content from Cloudinary into your components and compositions.

Cloudinary image parameter#

This parameter type allows a Uniform user to select one Cloudinary media item.

Add image parameter to component#

For a user to select a media item from Cloudinary, you must add a parameter to a component. The parameter is used to store the identifiers to the selected media items when the user selects media items.

1. In Uniform, navigate to your component.

2. Add a new parameter using the parameter type Cloudinary image.

3. The configuration parameters are all optional. Project admins can specify whether a value must be set for a specific Cloudinary parameter in order for the component to validate and allow the composition to be published.
   To use the new “folder pre-selection” utility, you will need to supply the Cloudinary API secret in the settings screen of the integration so that Uniform can use the Admin API to pull down the folders that are available. This key is optional in the setup of the integration, but without it you won't be able to use the folder feature.

   

   Cloudinary parameter with no options specified.

Edit image parameter value#

When you use a component with an Cloudinary parameter, by default no media item will be selected. You are prompted to add a media item.

1. After adding the component to a composition, click Edit value in the property panel.

2. Click Add media item.

   

3. Select the item you want to select and click Insert.

4. You will see details about the item you selected, including the title and some metadata.

   

   About this step

   After your selection is saved, you are presented with the following options:

   • If you want to edit the selected item in Cloudinary, click Edit.
   • If you want to deselect the item, click Unlink.

Cloudinary image list parameter#

With this parameter, authors can select one or many images assets to be returned as an array.

Add image list parameter to a component#

For a user to select a media item from Cloudinary, you must add a parameter to a component. The parameter is used to store the identifiers to the selected media items when the user selects media items.

1. In Uniform, navigate to your component.

2. Add a new parameter using the parameter type Cloudinary image list.

3. The configuration parameters are all optional. Project admins can specify whether a value must be set for a specific Cloudinary parameter in order for the component to validate and allow the composition to be published.
   To use the new “folder pre-selection” utility, you will need to supply the Cloudinary API secret in the settings screen of the integration so that Uniform can use the Admin API to pull down the folders that are available. This key is optional in the setup of the integration, but without it you won't be able to use the folder feature.
   Select “gallery view” to manage selected Cloudinary assets in a responsive and “drag and drop” interface.

   

Edit image list parameter value#

When you use a component with an Cloudinary parameter, by default no media item will be selected. You are prompted to add a media item.

1. After adding the component to a composition, click Edit value in the property panel.

2. Click Add media item.

   

3. Select the item you want to select and click Insert.

4. You will see details about the item you selected, including the title and some metadata.

   

   About this step

   After your selection is saved, you are presented with the following options:

   • If you want to edit the selected item in Cloudinary, click Edit.
   • If you want to deselect the item, click Unlink.
   • You can select additional media items by clicking Add media item.

Cloudinary video parameter#

With this parameter, authors can select one or many images assets to be returned as an array.

Add video parameter to a component#

For a user to select a video item from Cloudinary, you must add a parameter to a component. The parameter is used to store the identifiers to the selected media items when the user selects media items.

1. In Uniform, navigate to your component.

2. Add a new parameter using the parameter type Cloudinary video.

3. The configuration parameters are all optional. Project admins can specify whether a value must be set for a specific Cloudinary parameter in order for the component to validate and allow the composition to be published.
   To use the new “folder pre-selection” utility, you will need to supply the Cloudinary API secret in the settings screen of the integration so that Uniform can use the Admin API to pull down the folders that are available. This key is optional in the setup of the integration, but without it you won't be able to use the folder feature.
   Select “gallery view” to manage selected Cloudinary assets in a responsive and “drag and drop” interface.

   

Edit video parameter value#

When you use a component with an Cloudinary parameter, by default no media item will be selected. You are prompted to add a media item.

1. After adding the component to a composition, click Edit value in the property panel.

2. Click Add media item.

   

3. Select the item you want to select and click Insert.

4. You will see details about the item you selected, including the title and some metadata.

   

   About this step

   After your selection is saved, you are presented with the following options:

   • If you want to edit the selected item in Cloudinary, click Edit.
   • If you want to deselect the item, click Unlink.

Configure an enhancer#

When an item is selected, Uniform only stores the identifier for the item. Your front-end application must retrieve the details for the item. Uniform provides an enhancer to simplify this process.

How Uniform stores the selected item#

The following is an example of what Uniform stores for the parameter.

Add the enhancer#

Uniform provides an enhancer so you don't need to write the API calls to Cloudinary to retrieve data for media items.

1. Add the following npm packages to your front-end application:

   @uniformdev/canvas-cloudinary

   CopyCopied!

2. In a text editor, open the file where you retrieve the composition definition from Uniform.

   About this step

   You are looking for the code calls the async function getComposition. The code below assumes the object returned is set in a variable composition.

3. Add the following import statements:

   import { createCloudinaryEnhancer, CLOUDINARY_PARAMETER_TYPES, } from '@uniformdev/canvas-cloudinary';

   CopyCopied!

4. Add the following code:

   await enhance({ composition, enhancers: new EnhancerBuilder().parameterType( CLOUDINARY_PARAMETER_TYPES, createCloudinaryEnhancer(), ), context: {}, });

   CopyCopied!

   About this step

   This registers the enhancer to be used for any occurrence of the Cloudinary Items parameter.