Cloudinary Flutter SDK

Build Status

About

The Cloudinary Flutter SDK allows you to quickly and easily integrate your application with Cloudinary. Effortlessly optimize and transform your cloud's assets.

The Flutter SDK is based on the Cloudinary Dart SDK, with additional Flutter specific features.

Note

This Readme provides basic installation and usage information.

Table of Contents

Key Features

Transform and optimize assets. Visit our documentation to learn more about media optimization and transformations.

Version Support

SDK Version Flutter Version
1.3.0 > 1.0

Installation

To use this SDK, add the Flutter and Dart Cloudinary libraries as dependencies in your pubspec.yaml file.

dependencies:
  cloudinary_flutter: ^1.0.0
  cloudinary_url_gen: ^1.0.0

Usage

Setup

The Cloudinary class is the main entry point for using the library. Your cloud_name is required to create an instance of this class. Your api_key and api_secret are also needed to perform secure API calls to Cloudinary (e.g., image and video uploads). Setting the configuration parameters can be done either programmatically using an appropriate constructor of the Cloudinary class or globally using an environment variable. You can find your account-specific configuration parameters in the Dashboard page of your account console.

Here’s an example of setting configuration parameters in your Flutter application:

Cloudinary cloudinary = CloudinaryObject.fromCloudName(cloudName: 'demo');

Transform and Optimize Assets

Generate a Cloudinary URL using the cloudinary.media helper method and pass this to your image or video view:

For example, to generate a url for an image called sample using Cloudinary's image widget:

 CldImageWidget(
  publidId: 'sample',
  transformation: Transformation()
  ..resize(Resize.scale()..width(500)),
),

Contributions

See contributing guidelines.

Get Help

If you run into an issue or have a question, you can either:

About Cloudinary

Cloudinary is a powerful media API for websites and mobile apps alike, Cloudinary enables developers to efficiently manage, transform, optimize, and deliver images and videos through multiple CDNs. Ultimately, viewers enjoy responsive and personalized visual-media experiences—irrespective of the viewing device.

Additional Resources

Licence

Released under the MIT license.