Nominating Presidential Muppets

    cloudinary-core
    TypeScript icon, indicating that this package has built-in type declarations

    2.13.0 • Public • Published

    Cloudinary Javascript Core SDK (Legacy)

    About

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

    Note

    This Readme provides basic installation and usage information. For the complete documentation, see the Javascript SDK Guide.

    Table of Contents

    Key Features

    Browser Support

    Chrome, Safari, Firefox, IE 11

    Installation

    Install using your favorite package manager (yarn, npm)

    npm install cloudinary-core

    Or

    yarn add cloudinary-core

    Usage

    Setup

    There are several ways to configure cloudinary-core:

    Explicitly
    var cl = cloudinary.Cloudinary.new( { cloud_name: "demo"});
    Using the config function
    // Using the config function
    var cl = cloudinary.Cloudinary.new();
    cl.config( "cloud_name", "demo");
    From meta tags in the current HTML document

    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();
    From environment variables

    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();

    Transform and Optimize Assets

    // 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" }
      ]
    });

    Generate Image and Video HTML Tags

    • 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

    File upload

    See cloudinary-jquery-file-upload.

    Contributions

    • Ensure tests run locally (npm run test)
    • Open a PR and ensure Travis tests pass

    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.

    Keywords

    none

    Install

    npm i cloudinary-core

    DownloadsWeekly Downloads

    184,283

    Version

    2.13.0

    License

    MIT

    Unpacked Size

    2.07 MB

    Total Files

    64

    Last publish

    Collaborators

    • cloudinary