The Javascript SDK allows you to quickly and easily integrate your application with Cloudinary. Effortlessly optimize and transform your cloud's assets.
This Readme provides basic installation and usage information. For the complete documentation, see the Javascript SDK Guide.
- Key Features
- Browser Support
- Installation
- Usage
- Contributions
- About Cloudinary
- Additional Resources
- Licence
Chrome, Safari, Firefox, IE 11
npm install cloudinary-core
Or
yarn add cloudinary-core
There are several ways to configure cloudinary-core:
var cl = cloudinary.Cloudinary.new( { cloud_name: "demo"});
// Using the config function
var cl = cloudinary.Cloudinary.new();
cl.config( "cloud_name", "demo");
When using the library in a browser environment, you can use meta tags to define the configuration options.
The init()
function is a convenience function that invokes both fromDocument()
and fromEnvironment()
.
For example, add the following to the header tag:
<meta name="cloudinary_cloud_name" content="demo">
In your JavaScript source, invoke fromDocument()
:
var cl = cloudinary.Cloudinary.new();
cl.fromDocument();
// or
cl.init();
When using the library in a backend environment such as NodeJS, you can use an environment variable to define the configuration options.
Set the environment variable, for example:
export CLOUDINARY_URL=cloudinary://demo
In your JavaScript source, invoke fromEnvironment()
:
var cl = cloudinary.Cloudinary.new();
cl.fromEnvironment();
// or
cl.init();
// Apply a single transformation
cl.url( "sample", { crop: "scale", width: "200", angle: "10" })
// Chain (compose) multiple transformations
cl.url( "sample", {
transformation: [
{ angle: -45 },
{ effect: "trim", angle: "45", crop: "scale", width: "600" },
{ overlay: "text:Arial_100:Hello" }
]
});
- Use the
image()
function to generate an HTMLImageElement - Use the
imageTag()
function to generate an ImageTag instance - Use the
video()
function to generate an HTMLVideoElement - Use the
videoTag()
function to generate a VideoTag instance
See cloudinary-jquery-file-upload.
- Ensure tests run locally (
npm run test
) - Open a PR and ensure Travis tests pass
If you run into an issue or have a question, you can either:
- Open a Github issue (for issues related to the SDK)
- Open a support ticket (for issues related to your account)
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.
- Cloudinary Transformation and REST API References: Comprehensive references, including syntax and examples for all SDKs.
- MediaJams.dev: Bite-size use-case tutorials written by and for Cloudinary Developers
- DevJams: Cloudinary developer podcasts on YouTube.
- Cloudinary Academy: Free self-paced courses, instructor-led virtual courses, and on-site courses.
- Code Explorers and Feature Demos: A one-stop shop for all code explorers, Postman collections, and feature demos found in the docs.
- Cloudinary Roadmap: Your chance to follow, vote, or suggest what Cloudinary should develop next.
- Cloudinary Facebook Community: Learn from and offer help to other Cloudinary developers.
- Cloudinary Account Registration: Free Cloudinary account registration.
- Cloudinary Website: Learn about Cloudinary's products, partners, customers, pricing, and more.
Released under the MIT license.