Skip to content

Repository files navigation

react-ckeditor-component

React component for CKEditor

Installation

react-ckeditor-component

Usage

importCKEditorfrom"react-ckeditor-component";classExampleextendsComponent{constructor(props){super(props);this.updateContent=this.updateContent.bind(this);this.state={content: 'content',}}updateContent(newContent){this.setState({content: newContent})}onChange(evt){console.log("onChange fired with event info: ",evt);varnewContent=evt.editor.getData();this.setState({content: newContent})}onBlur(evt){console.log("onBlur event called with event info: ",evt);}afterPaste(evt){console.log("afterPaste event called with event info: ",evt);}render(){return(<CKEditoractiveClass="p10"content={this.state.content}events={{"blur": this.onBlur,"afterPaste": this.afterPaste,"change": this.onChange}}/>)}}

The package also includes an in-built example under the /example folder. Run the sample application by cloning project and running npm start.

Props

nametypedefaultmandatorydescription
contentanyNoDefault value to be set in CKEditor
onChange (Deprecated)functionNoDeprecated in v1.0.6. Is now handled via events prop.
configobjectNoConfigs to be passed in CKEditor
isScriptLoadedbooleanfalseNoPass true if ckeditor script is already loaded in project
scriptUrlstringStandard CKEditorNoThe CKEditor script that needs to be loaded. Pass a custom script with plugins if you need a customized CKEditor.
activeClassstringNoAny Css class to be used with CKEditor container div.
events (New)objectNoAn object of custom event handlers so that you can listen to any CKEditor event (Added in v1.0.6)

Note- Starting v1.0.6, you can listen to change event directly by passing its event handler in events prop instead of passing a separate onChange prop. The onChange prop is now deprecated.

License

react-ckeditor-component is released under the MIT license.

About

CKEditor component for React with plugin and custom event listeners support

Topics

Resources

Stars

129 stars

Watchers

8 watching

Forks

Releases

Packages

Used by

Contributors

Languages