RFC: New package @remirror/extension-image

Detailed Description

This issue is to track discussion for an image extension. The extension should follow the given RemirrorExtension api (subject to change).

Borrowed configuration structure from https://github.com/pqina/filepond. Will possibly use filepond under the hood.

<RemirrorExtension<ImageExtensionOptions>
    Constructor={Image}
    Provider={() => ({process, revert, load, restore, fetch})} />

Possible Implementation

Constructor would handle the prosemirror schema logic.

Provider expects a configuration function on how to perform the network tasks necessary for the image to save the image and pass the resolved image object back to the extension to save in the document.

Image would save to the schema like:

{
    type: "image",
    attrs: {
        id: "testId", // can supply an id or a url.
        url: "https://provider.url/testId.png", 
        width: 300,
        height: 200,
        alt: "optional alt tag"
     }
}

Provider API (short version)

The provider configuration would seek to emulate (if not fork) https://pqina.nl/filepond/docs/patterns/api/server/#advanced

• Process: Handles uploading an image to the server and passes the id or url to remirror to save in the document. Passes the resulting file object to the extension. Also passes optional parameters to the other lifecycle methods.
• Revert: Custom revert methods receive the unique server file id and a load and error callback.
• Load: Custom load methods receive the local file source, and the callback methods: load, error, abort, and headers.
• Restore: Custom restore methods used to restore an image from the server back into the editor. Useful when storing drafts or editing saved documents.
• Fetch: The custom fetch method receives the url to fetch and passes a file object to the extension

Edit: Jun-20-2019 - Added details on the lifecycle methods

[ifiokjr]

Okay, I’m now visiting this.

The API feels stable enough to begin working on a general case @remirror/extension-image package.

[hennessyevan]

Just as an update to this, I know it’s been a while but I’m currently working on this extension internally in an app and will publish as an extension when it’s done 👍