Welcome to RoosterJs API References!
Rooster contains 9 packages.
-
roosterjs: A facade of all Rooster code for those who want a quick start. Use the
createEditor()function in roosterjs to create an editor with default configurations. -
roosterjs-editor-core: Defines the core editor and plugin infrastructure. Use
roosterjs-editor-coreinstead ofroosterjsto build and customize your own editor. -
roosterjs-editor-api: Defines APIs for editor operations. Use these APIs to modify content and formatting in the editor you built using
roosterjs-editor-core. -
roosterjs-editor-dom: Defines APIs for DOM operations. Use
roosterjs-editor-apiinstead unless you want to access DOM API directly. -
roosterjs-editor-plugins: Defines basic plugins for common features. Examples: making hyperlinks, pasting HTML content, inserting inline images.
-
roosterjs-editor-types: Defines public interfaces and enumerations.
-
roosterjs-html-sanitizer A common library to help sanitize HTML.
-
roosterjs-plugin-image-resize A plugin to help do inline image resize within the editor
-
roosterjs-plugin-picker A plugin to help build picker-like plugins