@builder.io/plugin-cloudinary

See here for the React component that powers this plugin

Usage no npm install needed!

<script type="module">
  import builderIoPluginCloudinary from 'https://cdn.skypack.dev/@builder.io/plugin-cloudinary';
</script>

README

Cloudinary support for Builder.io

See here for the React component that powers this plugin

Plugin example

Status

Builder plugins are in beta. If you run into any issues or have questions please contact help@builder.io for help

Developing this plugin

Install

git clone https://github.com/BuilderIO/builder.git
cd plugins/cloudinary
npm install

Develop

npm start

Add the plugin in Builder.io

From your organization settings page click the edit (pencil) button next to plugins and enter the development URL for this plugin http://localhost:1268/builder-plugin-cloudinary.system.js and hit save

NOTE: Loading http:// content on an https:// website will give you a warning. Be sure to click the shield in the top right of your browser and choose "load unsafe scripts" to allow the http content on Builder's https site when devloping locally

Load unsafe script example

Now as you develop you can restart Builder to see the latest version of your plugin.

To uninstall your plugin run just go back to your organization settings page and click the edit (pencil) button next to plugins and delete your development URL form the list and save

Seeing your plugin in action

Set your component to use the CloudinaryImageEditor plugin type (see below)

export const Image = withBuilder(CloudinaryImageComponent, {
  name: 'Image',
  inputs: [{ name: 'image', type: 'cloudinaryImageEditor' }],
});

then you can leverage this plugin to access your cloudinary image content using the official Cloudinary Media Library widget.

Just add a component with a cloudinaryImageEditor editor type and open it's options to see your cloudinary editor in action!

The Cloudinary Image editor contains 2 buttons:

  • SET CREDENTIALS: This brings up a dialog to set your cloudinary credentials (API key and Cloud name). In order to work, you need to have SSO enabled and be previously logged in (current version does not support other authentication approach).

  • CHOOSE IMAGE: Once your credentials are set (you only need to do this once) a new dialog will appear with the a Cloudinary media library browser. Select your asset and click INSERT button to insert the image to your page. Only one selection at a time is supported.

Frameworks

Builder.io uses React and Material UI for the UI, and Emotion for styling.

Using these frameworks in Builder plugins ensures best possible experience and performance.

Publishing

To publish send a pull request to this repo with your plugin, and we will review and publish it when ready. Then you can install it via it's published name, e.g. @builder.io/plugin-cloudinary

Contributors

Created by @JacoboGallardo!