netlify-cms-widget-external-image v0.1.0

netlify-cms-widget-external-image

Image widget for Netlify CMS: upload image to an external server and store just an identifier

Usage

npm install --save-dev react@17 react-dom@17 netlify-cms-app netlify-cms-widget-external-image

import CMS from "netlify-cms-app";
import ExternalImage from "netlify-cms-widget-external-image";

CMS.registerWidget(
  "external-image",
  ExternalImage(
    async (f) => {
      // upload ...
      return "some-asset-id";
    },
    (assetId) => `https://myassetserver.com/asset/${assetId}`
  )
);
CMS.init();

It is also possible to use Netlify CMS including this widget without any bundling, using scripts from a CDN. Insert the following before the </body> tag.

<script src="https://cdn.jsdelivr.net/npm/react@17/umd/react.production.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/react-dom@17/umd/react-dom.production.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/netlify-cms-widget-external-image@0.1/dist/ExternalImage.umd.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/netlify-cms-app@2/dist/netlify-cms-app.min.js"></script>
<script>
  NetlifyCmsApp.registerWidget(
    "external-image",
    NetlifyCMSWidgetExternalImage(
      async (f) => {
        // upload ...
        return "some-asset-id";
      },
      (assetId) => `https://myassetserver.com/asset/${assetId}`
    )
  );
  NetlifyCmsApp.init();
</script>

API

export type WidgetInstanceMeta

export declare type WidgetInstanceMeta = {
  field: ReadonlyMap<string, any>;
  entry: ReadonlyMap<string, any>;
};

Object containing available metadata. field contains config for the given field from CMS config.yml, entry contains data about the current item that is being edited (namely values of other fields, slug, raw...)

(export default) function createExternalImageWidget(...)

declare function createExternalImageWidget(
  uploadCallback: (file: File, meta: WidgetInstanceMeta) => Promise<string>,
  getPreviewUrl: (storedValue: string, meta: WidgetInstanceMeta) => string
): React.ComponentClass<CmsWidgetControlProps>;
export default createExternalImageWidget;

Factory function for a component class that you can provide to CMS.registerWidget.

uploadCallback is called when user chooses to upload a new image (including replacing the previous one). You should store the image (File is a subclass of Blob) and return a string that identifies the file (that will be stored in the content)

getPreviewUrl takes the value as returned by the callback and must return a URL (as a string) of a suitable preview

Both functions can make use of the available metadata (see above).