Welcome to RoosterJs API References!
Please see here.
Rooster contains 6 basic 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-content-model-core:
Defines the core editor and plugin infrastructure. Use roosterjs-content-model-core
instead of roosterjs to build and customize your own editor.
roosterjs-content-model-api:
Defines APIs for editor operations. Use these APIs to modify content and
formatting in the editor you built using roosterjs-content-model-core.
roosterjs-content-model-dom: Defines APIs for Content Model and DOM operations. This package do conversion between DOM tree and roosterjs Content Model.
roosterjs-content-model-plugins: Defines basic plugins for common features.
roosterjs-content-model-types: Defines public interfaces and enumerations, including Content Model types, API parameters and other types.
There are also some extension packages to provide additional functionalities.
roosterjs-color-utils: Provide color transformation utility to make editor work under dark mode.
roosterjs-react: Provide a React wrapper of roosterjs so it can be easily used with React.
To be compatible with old (8.*) versions, you can use EditorAdapter class from the following package which can act as a 8.* Editor:
EditorAdapter to work with Editor (9.*) and legacy plugins (via EditorAdapterOptions.legacyPlugins)And the following packages are for old (8.*) compatibility:
Generated using TypeDoc