Programmable Media

Flutter quick start

Last updated: Oct-31-2023

This quick start is intended to let you quickly try using several common Cloudinary features. It doesn't necessarily employ coding best practices and the code you create here isn't intended for production.

You can perform this quick start in a code sandbox or in a clean project in the dev environment of your choice.

You can also view the completed code of this quick start in a GitHub repo and code explorer.

Tip
If you aren't familiar with Cloudinary, you may want to first take a look at the Developer get started guide for a high-level overview of integrating Cloudinary into your code, and an introduction to the main concepts.

You may also find our Glossary helpful to understand Cloudinary-specific terminology.

In this quick start you'll learn how to start delivering your media from Cloudinary using the @cloudinary/flutter package.

Tip
To get a more in-depth understanding of the architecture, you may want to start from the Flutter SDK introduction.

Prerequisites

To perform this quick start, you'll need:

1. Set up and configure the SDK

Install the package

Install the @cloudinary_flutter package by adding Cloudinary as a dependency in your pubspec.yaml file.

Configure Cloudinary

Create a basic Flutter app, and in main.dart copy and paste the following:

main.dart

2. Upload an image

You need to use an image in your Cloudinary product environment for the next steps. All new accounts come with sample images, so we'll be using the sample image with public ID cld-sample for the purposes of this quick start.

If you want to try uploading an image via the Cloudinary Console, expand the following section for instructions:

Note
For convenience, the above step shows how to upload files using the Media Library user interface, but as a developer, you'll probably be interested in uploading files programmatically. You can do this by adding an Upload Widget to your app, or making a direct call to the upload method of the Upload API, as explained in Flutter SDK image and video upload or you can use the CLI.

3. Transform and deliver the image

Use the CldImageWidget to display the full image URL based on the specified transformation parameters:

Copy and paste the following code, under the configuration code:

main.dart (continued)

Note
If you followed the steps to upload the docs/models asset, you might want to use that public ID instead of cld-sample. If you're using an image with a public ID other than cld-sample, make sure to update your code for the remainder of this quick start with the public ID of the image you're delivering.

4. Run your code

Run the code to see the transformed image.

Transformed image

View the completed code

Here's the full example:

This code is available on GitHub.

Ready to learn more?

✔️ Feedback sent!

Rate this page: