editor-sdk package#

Classes#

ClassDescription
EventEmitterEvent Emitter extended by ShakrEditor
ShakrEditorShakr Editor class which returns a instance that can communicates with Shakr's Editor iframe window.

Enumerations#

EnumerationDescription
ShakrEditorErrorShakr Editor error types.

Functions#

FunctionDescription
createShakrEditor(options)Factory function to create ShakrEditor instance

Interfaces#

InterfaceDescription
ShakrEditorErrorEventEvent Object for 'error' event.
ShakrEditorEventMapEvent map interface for ShakrEditor.
ShakrEditorFinishEventEvent Object for 'finish' event when ShakrEditorOptions.wait_rendering is true.
ShakrEditorGetMediaEventEvent Object for 'get_media' event.
ShakrEditorMediaMedia object interface which should be returned by 'get_media' event or 'open_media_library' event event listener's callback.
ShakrEditorMediaLibrarySDK consumer provided media library config
ShakrEditorOpenMediaLibraryEventEvent Object for 'open_media_library' event.
ShakrEditorOptionsShakrEditor constructor options interface
ShakrEditorThemeTheme setting options for Shakr Editor.

Type Aliases#

Type AliasDescription
ShakrEditorAppearanceTypeLight (light) / Dark (dark) / Dynamically change appearance depends on browser/OS setting (browser)