Angular SDK (Legacy)

Overview

Cloudinary's Angular SDK provides simple, yet comprehensive image and video upload, transformation, 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-13.x).

Quick example

Take a look at the following transformation code and the image it delivers:

This relatively simple code performs all of the following on the original front_face.jpg image before delivering it:

• Crop to a 150x150 thumbnail using face-detection gravity to automatically determine the location for the crop
• Round the corners with a 20 pixel radius
• Apply a sepia effect
• Overlay the Cloudinary logo on the southeast corner of the image (with a slight offset). The logo is scaled down to a 50 pixel width, with increased brightness and partial transparency (opacity = 60%)
• Rotate the resulting image (including the overlay) by 10 degrees
• Convert and deliver the image in PNG format (the originally uploaded image was a JPG)

And here's the URL that would be included in the image tag that's automatically generated from the above code:

In a similar way, you can transform a video.

Angular SDK features

• Image transformations
• Video transformations (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 (cloudinary-core) library. Angular 1.x support is provided through the bower package manager:

1. Install the AngularJS SDK

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

The optional --save parameter saves the dependency in your bower.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.

Most functionality implemented on the client side does not require authentication, so only your cloud_name is required to be configured, and not your API key or secret. Your API secret should never be exposed on the client side, so if you want to use signed uploads or generate delivery signatures, you'll also need server-side code, for which you can use one of our backend SDKs.

For example:

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 cloudinary-core (legacy) library. Install the Cloudinary JavaScript library and the relevant version of the Angular SDK in the format:

<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-13, use 5.x. For example:

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.

For Rollup:

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

3. In app.module.ts, import Cloudinary

Add the relevant Cloudinary imports and specify your cloud_name and any other required 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.

And

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 Cloud name in the Programmable Media Dashboard of the Cloudinary Console, and you can find all of your credentials, including API Key and API Secret, on the API Keys page of the Cloudinary Console Settings.

For example:

Using core Cloudinary JavaScript features

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

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)

Project	Notes
Photo Album	Uses ng-file-upload to upload files
Photo Album with jQuery	Uses the Cloudinary jquery-file-upload to upload files

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.

Project	Bundler used	Notes
Angular CLI sample	CLI
Angular Universal sample	Webpack	A minimal Angular starter for Universal JavaScript using TypeScript and Webpack. Utilizes packages from the Angular Universal repository to enable lazy loading.
Photo album sample app	Webpack	Uses ng2-file-upload for uploading files
Photo album sample app with jQuery	SystemJS	Uses Cloudinary's jQuery plugin for uploading files using jQuery and blueimp.