editor-sdk package

Classes

Class	Description
EventEmitter	Event Emitter extended by ShakrEditor
ShakrEditor	Amplify Editor class which returns a instance that can communicates with Amplify's Editor iframe window.
ShakrreadyEditor	Amplify Editor class which returns a instance that can communicates with Shakrready Editor iframe window.

Enumerations

Enumeration	Description
ShakrEditorError	Amplify Editor error types.
ShakrreadyEditorError	Shakrready Editor error types.

Functions

Function	Description
createShakrEditor(options)	Factory function to create ShakrEditor instance
createShakrreadyEditor(options)	Factory function to create ShakrreadyEditor instance

Interfaces

Interface	Description
ShakrEditorCustomizabilityOptions	Options to control customizability in Amplify Editor.
ShakrEditorErrorEvent	Event Object for 'error' event.
ShakrEditorEventMap	Event map interface for ShakrEditor.
ShakrEditorFinishEvent	Event Object for 'finish' event when ShakrEditorOptions.wait_rendering is true.
ShakrEditorGetMediaEvent	Event Object for 'get_media' event.
ShakrEditorMedia	Media object interface which should be returned by 'get_media' event or 'open_media_library' event event listener's callback.
ShakrEditorMediaLibrary	SDK consumer provided media library config
ShakrEditorOpenMediaLibraryEvent	Event Object for 'open_media_library' event.
ShakrEditorOptions	ShakrEditor constructor options interface
ShakrEditorTheme	Theme setting options for Amplify Editor.
ShakrEditorThemeCustomizeOptions	Theme customize options for Amplify Editor
ShakrreadyEditorErrorEvent	Event Object for 'error' event.
ShakrreadyEditorEventMap	Event map interface for ShakrreadyEditor.
ShakrreadyEditorOptions	ShakrreadyEditor constructor options interface

Type Aliases

Type Alias	Description
ShakrEditorAppearanceType	Light (light) / Dark (dark) / Dynamically change appearance depends on browser/OS setting (browser)