Angular SDK

Overview

Cloudinary is a cloud-based service that provides an end-to-end image and video management solution. The Angular SDK provides simple, yet comprehensive image and video manipulation, optimization, and delivery capabilities that you can implement using code that integrates seamlessly with your existing Angular application.

Supported versions

Cloudinary's Angular support includes separate libraries for integration with AngularJS (also known as Angular 1.x) and with Angular versions 2.x and later (supported versions: 2.x, 4.x, 5.x, 6.x, 7.x, 8.x).

Quick example

The following Cloudinary URL and corresponding Angular SDK code delivers the image below in an https delivery URL, including all of the following transformations:

• Thumbnail crop to a size of 150x150 pixels using face detection gravity to automatically determine the location for the crop
• Rounded corners with a 20 pixel radius
• Sepia effect
• Overlay of the Cloudinary logo on the southeast corner (with a slight offset). The logo is scaled down to a 50 pixel width, with increased brightness, and partial transparency (opacity = 60%)
• Rotated by 10 degrees
• Converted to and delivered in PNG format (the originally uploaded image was a JPG)

<cl-image public-id="front_face.png" secure="true">
  <cl-transformation width="150" height="150" gravity="face" radius="20" effect="sepia" crop="thumb">
  </cl-transformation>
  <cl-transformation overlay="cloudinary_icon" gravity="south_east" x="5" y="5" width="50" opacity="60" effect="brightness:200">
  </cl-transformation>
  <cl-transformation angle="10">
  </cl-transformation>
</cl-image>

Angular SDK features

• Image manipulations
• Video manipulations (not supported for Angular JS)
• Transforming resources dynamically (transformations on events)
• Direct image and video upload (using the Upload widget or tools such as ng2-file-upload or JQuery-file-upload with Blueimp)

SDK installation and setup

This section includes installation and setup instructions for:

• AngularJS (version 1)
• Angular (version 2 and later)

AngularJS (version 1.x)

The Cloudinary Angular SDK serves as a layer on top of Cloudinary's Javascript library. Angular 1.x support is provided through the bower package manager:

1. Install the AngularJS SDK

bower install cloudinary_ng#1.x --save

This command installs AngularJS (if not already installed), the Cloudinary JavaScript SDK (cloudinary-core), and the Cloudinary AngularJS 1.x SDK.

The optional --save parameter saves the dependency in your package.json file.

2. Set Cloudinary configuration parameters

To use the Cloudinary AngularJS library, you have to configure at least your cloud_name. You can additionally define a number of optional configuration parameters if relevant.

For example:

yourApp.config(['cloudinaryProvider', function (cloudinaryProvider) {
  cloudinaryProvider
      .set("cloud_name", "mycompany")
      .set("secure", true)
      .set("upload_preset", "my_preset");
}]);

Angular 2.x and later

1. Install the Javascript SDK and the Angular SDK for the relevant Angular version

The Cloudinary Angular SDKs serve as a layer on top of Cloudinary's Javascript library. Install the Cloudinary Javascript library and the relevant version of the Angular SDK in the format:

npm install cloudinary-core @cloudinary/angular-<version> --save

<version>: Install the Cloudinary Angular SDK package that supports the Angular version you are using:

• For Angular 2, use 2.x
• For Angular 4, use 4.x
• For Angular 5-8, use 5.x. For example:

npm install cloudinary-core @cloudinary/angular-5.x --save

For details, see Angular image and video upload

2. Configure your bundler to work with the Cloudinary Angular SDK

For some bundlers, you need to edit certain files to integrate with the Cloudinary Angular (2.x or later) library.

For SystemJS:

In your systemjs.config.js file, add the cloudinary configuration to the map and packages sections. In the map section, make sure to specify the correct version for the Angular version you are using. In the example below, angular-5.x is specified.

  System.config({
    ...
    map: {
      // Cloudinary lib
      '@cloudinary/angular': 'npm:@cloudinary/angular-5.x',
      'cloudinary-core': 'npm:cloudinary-core',

    },
    packages: {
      ...
      "@cloudinary/angular": {
        main: 'index.js',
        defaultExtension: 'js'
      },
      "cloudinary-core": {
        main: 'cloudinary-jquery-file-upload.js',
        defaultExtension: 'js'
      }

    }
  });

For Rollup:

In rollup-config.js, under the plugins field, add:

export default {
 ...
 plugins: [
     nodeResolve({jsnext: true, module: true}),
     commonjs({
       include: [
       ...
       'node_modules/@cloudinary/angular/**',
       'node_modules/cloudinary-core/**',
       ],
       namedExports: {
         'cloudinary-core/cloudinary-core-shrinkwrap': [ 'Cloudinary' ],
         '@cloudinary/angular': [ 'CloudinaryModule', 'Cloudinary' ],
       }
     }),
 ]
}

3. In app.module.ts, import Cloudinary

Add the relevant Cloudinary imports and specify your cloud_name and any other required account configuration parameters. Make sure to specify the correct version for the Angular version you are using. In the example below, angular-5.x is specified.

  import { CloudinaryModule } from '@cloudinary/angular-5.x';
  import * as  Cloudinary from 'cloudinary-core';

And

  imports: [
   ....
   .... 
    CloudinaryModule.forRoot(Cloudinary, { cloud_name: 'mycloudname'}),
  ],

Set Cloudinary configuration parameters

In the imports or providers section of your app.module.ts (as relevant for your bundler), you must configure at least your cloud_name. You can additionally define a number of optional configuration parameters if relevant. You can find your account-specific configuration credentials in the dashboard of our Management Console.

For example:

CloudinaryModule.forRoot(Cloudinary, 
    {cloud_name: 'mycompany', upload_preset: 'mypreset', private_cdn: true, 
     cname: 'mycompany.images.com'}),

Using core Cloudinary JavaScript features

The Cloudinary JavaScript library is the foundation library underlying Cloudinary's Angular SDK. You can access any of the core JavaScript functionality within your Angular code after importing the core library. For example:

import { Component } from '@angular/core';
import { Cloudinary } from '@cloudinary/angular-5.x'; 
export class AppComponent {
  constructor(private cloudinary: Cloudinary) {
    // <img src="https://res.cloudinary.com/demo/image/upload/dog.jpg" />
    console.log(cloudinary.cloudinaryInstance.image('dog')); 
  }
}

Sample projects

The Angular SDKs provide a set of sample projects that can help you get started with your own.

Samples for AngularJS (version 1)

Samples for Angular (version 2 or later)

The following samples link to the master branch of the sample apps. Parallel examples are available for all earlier supported versions of Angular as well.