e-ngx-editor
v5.1.1
Published
基于Angular的富文本编辑组件,依赖第三方插件:neditor(neditor 基于 UEditor)
Downloads
9
Maintainers
Readme
e-ngx-editor
基于Angular的富文本编辑组件,依赖第三方插件:neditor(neditor 基于 UEditor)
需要使用后台相关的功能(如上传图片、视频等等)请部署对应的后端,后端部署说明
Usage
Install
npm install --save e-ngx-editor@latest
在index.html引入neditor 下载安装包
<script src="./assets/scripts/neditor/neditor.config.js"></script> <script src="./assets/scripts/neditor/neditor.all.min.js"></script> <script src="./assets/scripts/neditor/i18n/zh-cn/zh-cn.js"></script>
Add the ENgxEditorModule
import {ENgxEditorModule} from "e-ngx-editor"; @NgModule({ imports: [ ENgxEditorModule ] })
Use in the template
<e-ngx-editor #editor [(ngModel)]="model_text" (contentChange)="contentChange($event)" (ready)="editorReady($event)" (click)="test(editor.text)"> </e-ngx-editor>
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
) - 属性参数(参照官网配置),默认defaultConfig如下:
defaultConfig: any = {
autoHeightEnabled: false
};
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
```shell
npm install // 安装依赖包
npm start // 启动项目
```