Logo for jsDocs.io

@wangeditor-next/editor

  • Version 5.6.49
  • Published
  • 7.22 MB
  • 20 dependencies
  • MIT license

Install

npm i @wangeditor-next/editor
yarn add @wangeditor-next/editor
pnpm add @wangeditor-next/editor

Overview

Web rich text editor, Web 富文本编辑器

Index

Variables

Functions

Classes

Variables

variable _default

const _default: {};

    Functions

    function createEditor

    createEditor: (option?: Partial<ICreateEditorOption>) => IDomEditor;

    • 创建 editor 实例

    function createToolbar

    createToolbar: (option: ICreateToolbarOption) => Toolbar;

    • 创建 toolbar 实例

    Classes

    class Boot

    class Boot {}

      constructor

      constructor();

        property editorConfig

        static editorConfig: IEditorConfig;

          property plugins

          static plugins: PluginType[];

            property simpleEditorConfig

            static simpleEditorConfig: IEditorConfig;

              property simpleToolbarConfig

              static simpleToolbarConfig: IToolbarConfig;

                property toolbarConfig

                static toolbarConfig: IToolbarConfig;

                  method registerElemToHtml

                  static registerElemToHtml: (elemToHtmlConf: IElemToHtmlConf) => void;

                    method registerMenu

                    static registerMenu: (
                        menuConf: IRegisterMenuConf,
                        customConfig?: ISingleMenuConfig
                    ) => void;

                      method registerModule

                      static registerModule: (module: IModuleConf) => void;

                        method registerParseElemHtml

                        static registerParseElemHtml: (parseElemHtmlConf: IParseElemHtmlConf) => void;

                          method registerParseStyleHtml

                          static registerParseStyleHtml: (fn: ParseStyleHtmlFnType) => void;

                            method registerPlugin

                            static registerPlugin: (plugin: PluginType) => void;

                              method registerPreParseHtml

                              static registerPreParseHtml: (preParseHtmlConf: IPreParseHtmlConf) => void;

                                method registerRenderElem

                                static registerRenderElem: (renderElemConf: IRenderElemConf) => void;

                                  method registerRenderStyle

                                  static registerRenderStyle: (fn: RenderStyleFnType) => void;

                                    method registerStyleToHtml

                                    static registerStyleToHtml: (fn: styleToHtmlFnType) => void;

                                      method setEditorConfig

                                      static setEditorConfig: (newConfig?: IEditorConfig) => void;

                                        method setSimpleEditorConfig

                                        static setSimpleEditorConfig: (newConfig?: IEditorConfig) => void;

                                          method setSimpleToolbarConfig

                                          static setSimpleToolbarConfig: (newConfig?: IToolbarConfig) => void;

                                            method setToolbarConfig

                                            static setToolbarConfig: (newConfig?: IToolbarConfig) => void;

                                              Package Files (3)

                                              Dependencies (20)

                                              Dev Dependencies (3)

                                              Peer Dependencies (0)

                                              No peer dependencies.

                                              Badge

                                              To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                                              You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@wangeditor-next/editor.

                                              • Markdown
                                                [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@wangeditor-next/editor)
                                              • HTML
                                                <a href="https://www.jsdocs.io/package/@wangeditor-next/editor"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>