essence-ng2-editor v1.0.6

essence-ng2-editor

essence-ng2-editor is a editor component for Angular.

依赖的第三方插件：UEditor

Usage

1. Install

   npm install --save essence-ng2-editor@latest

2. 在index.html引入UEditor

   <script src="./assets/scripts/ueditor/ueditor.config.js"></script>
   <script src="./assets/scripts/ueditor/ueditor.all.min.js"></script>
   <script src="./assets/scripts/ueditor/lang/zh-cn/zh-cn.js"></script>

3. Add the EssenceNg2EditorModule

   import {EssenceNg2EditorModule} from "essence-ng2-editor";
   @NgModule({
       imports: [
           EssenceNg2EditorModule
       ]
   })

4. Use in the template

   <essence-ng2-editor #editor id="editor" [(ngModel)]="model_text"
                       (contentChange)="contentChange($event)"
                       (ready)="editorReady($event)"
                       (click)="test(editor.text)">
   </essence-ng2-editor>

5. Use in the component

   model_text: string = '<p style="font-weight: bold;"><a href="http://ueditor.baidu.com/website/index.html" target="_blank" title="去UEditor官网">UEditor Component for Angular2</a></p>';
   
   contentChange ($event) {
       console.log("contentChange：", $event);
   }
   
   editorReady ($event) {
       console.log("ready：", $event);
   }
   
   test (text: string): void {
       console.log(text);
   }

API

Inputs

• [(ngModel)]（string） - 绑定编辑器内容
• ueOption（?Object） - 属性参数（参照官网API），默认defaultConfig如下：

    defaultConfig: any = {
        autoHeightEnabled: true,
        allowDivTransToP: false,
        toolbars: [
            ['fullscreen', 'source', 'undo', 'redo'],
            ['bold', 'italic', 'underline', 'fontborder', 'strikethrough', 'superscript', 'subscript', 'removeformat', 'formatmatch', 'autotypeset', 'blockquote', 'pasteplain', '|', 'forecolor', 'backcolor', 'insertorderedlist', 'insertunorderedlist', 'selectall', 'cleardoc']
        ]
    };

Outputs

• ready - 编辑器准备就绪后会触发该事件

• destroy - 执行destroy方法会触发该事件

• reset - 执行reset方法会触发该事件

• focusEvent - 执行focus方法会触发该事件

• langReady - 语言加载完成会触发该事件

• beforeExecCommand - 运行命令之后会触发该命令

• afterExecCommand - 运行命令之后会触发该命令

• firstBeforeExecCommand - 运行命令之前会触发该命令

• beforeGetContent - 在getContent方法执行之前会触发该事件

• afterGetContent - 在getContent方法执行之后会触发该事件

• getAllHtml - 在getAllHtml方法执行时会触发该事件

• beforeSetContent - 在setContent方法执行之前会触发该事件

• afterSetContent - 在setContent方法执行之后会触发该事件

• selectionchange - 每当编辑器内部选区发生改变时，将触发该事件。警告： 该事件的触发非常频繁，不建议在该事件的处理过程中做重量级的处理

• beforeSelectionChange - 在所有selectionchange的监听函数执行之前，会触发该事件

• afterSelectionChange - 在所有selectionchange的监听函数执行完之后，会触发该事件

• contentChange - 编辑器内容发生改变时会触发该事件

Methods

• setHeight (height: number): void - 设置编辑器高度。当配置项autoHeightEnabled为真时，该方法无效 - height 编辑器高度（不带单位）
• setContent (html: string, isAppendTo: boolean = false): void - 设置编辑器的内容，可修改编辑器当前的html内容 - html 要插入的html内容

  • 若传入true，不清空原来的内容，在最后插入内容，否则，清空内容再插入

• getContent (): any - 获取编辑器html内容

• getContentTxt (): any - 获取编辑器纯文本内容

• getPlainTxt (): any - 获取编辑器带格式的纯文本内容

• hasContents (): boolean - 判断编辑器是否有内容

• focus (): void - 让编辑器获得焦点

• blur (): void - 让编辑器失去焦点

• isFocus (): boolean - 判断编辑器是否获得焦点

• setDisabled (): void - 设置当前编辑区域不可编辑

• setEnabled (): void - 设置当前编辑区域可以编辑

• setHide (): void - 隐藏编辑器

• setShow (): void - 显示编辑器

• getSelectionText (): string - 获得当前选中的文本

• executeCommand (command: string, content?: string) - 执行指定命令 - command 执行的命令

  • content 执行要操作的内容

Develop

```bash
npm install // 安装依赖包

npm start // 启动项目
```

License