Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/froala/react-froala-wysiwyg

React component for Froala WYSIWYG HTML Rich Text Editor.
https://github.com/froala/react-froala-wysiwyg

Last synced: 3 days ago
JSON representation

React component for Froala WYSIWYG HTML Rich Text Editor.

Awesome Lists containing this project

README 

        
# React JS Froala WYSIWYG Editor



[![npm](https://img.shields.io/npm/v/react-froala-wysiwyg.svg)](https://www.npmjs.com/package/react-froala-wysiwyg)

[![npm](https://img.shields.io/npm/dm/react-froala-wysiwyg.svg)](https://www.npmjs.com/package/react-froala-wysiwyg)

[![npm](https://img.shields.io/npm/l/react-froala-wysiwyg.svg)](https://www.npmjs.com/package/react-froala-wysiwyg)



>react-froala-wyswiyg provides React bindings to the Froala WYSIWYG editor VERSION 3.



## Installation



```bash

npm install react-froala-wysiwyg --save

```



## Update editor version

```bash

npm update froala-editor

```

## Install font-awesome

```bash

npm install font-awesome --save

```



## Usage with Class Component



#### 1. Require and use Froala Editor component inside your application.



```jsx

import React from 'react';

import ReactDOM from 'react-dom/client';



// Require Editor CSS files.

import 'froala-editor/css/froala_style.min.css';

import 'froala-editor/css/froala_editor.pkgd.min.css';



import FroalaEditorComponent from 'react-froala-wysiwyg';



// Import all Froala Editor plugins;

// import 'froala-editor/js/plugins.pkgd.min.js';



// Import a single Froala Editor plugin.

// import 'froala-editor/js/plugins/align.min.js';



// Import a language file.

// import 'froala-editor/js/languages/de.js';



// Import a third-party plugin.

// import 'froala-editor/js/third_party/image_tui.min.js';

// import 'froala-editor/js/third_party/embedly.min.js';

// import 'froala-editor/js/third_party/spell_checker.min.js';



// Include font-awesome css if required.

// install using "npm install font-awesome --save"

// import 'font-awesome/css/font-awesome.css';

// import 'froala-editor/js/third_party/font_awesome.min.js';



// Include special components if required.

// import FroalaEditorView from 'react-froala-wysiwyg/FroalaEditorView';

// import FroalaEditorA from 'react-froala-wysiwyg/FroalaEditorA';

// import FroalaEditorButton from 'react-froala-wysiwyg/FroalaEditorButton';

// import FroalaEditorImg from 'react-froala-wysiwyg/FroalaEditorImg';

// import FroalaEditorInput from 'react-froala-wysiwyg/FroalaEditorInput';



// Render Froala Editor component.

const root = ReactDOM.createRoot(document.getElementById('editor'));

root.render();

```



#### Add editor to UI by passing id to html element



```





```

#### Pass properties to the wrapping DOM element



```js



```



**tag** attr is used to tell on which tag the editor is initialized.



There are special tags: **a**, **button**, **img**, **input**. Do not use them in FroalaEditor component. To initialize the editor on a special tag, use `FroalaEditorA`, `FroalaEditorButton`, `FroalaEditorImg` and `FroalaEditorInput` components.



### Config



You can pass editor options as component attribute (optional).



`config={this.config}`



You can pass any existing Froala option. Consult the [Froala documentation](https://www.froala.com/wysiwyg-editor/docs/options) to view the list of all the available options:



```js

config={{

  placeholderText: 'Edit Your Content Here!',

  charCounterCount: false

}}

```



Aditional option is used:

* **immediateReactModelUpdate**: (default: false) This option updates the React model as soon as a key is released in the editor. Note that it may affect performances.



### Events and Methods



Events can be passed in with the options, with a key events and object where the key is the event name and the value is the callback function.



```js

config={{

  placeholder: "Edit Me",

  events : {

    'focus' : function(e, editor) {

      console.log(editor.selection.get());

    }

  }

}}

```



Using the editor instance from the arguments of the callback you can call editor methods as described in the [method docs](http://froala.com/wysiwyg-editor/docs/methods).



Froala events are described in the [events docs](https://froala.com/wysiwyg-editor/docs/events).



### Model



The WYSIWYG HTML editor content model.



`model = {this.state.model}`



Two way binding:



```jsx

import React from 'react';



class EditorComponent extends React.Component {

  constructor () {

    super();



    this.handleModelChange = this.handleModelChange.bind(this);



    this.state = {

      model: 'Example text'

    };

  }



  handleModelChange: function(model) {

    this.setState({

      model: model

    });

  }



  render () {

    return 

  }

}

```



To achieve one way binding and pass only the initial editor content, simply do not pass `onModelChange` attribute.



Use the content in other places:



```js



```



### Special tags

You can also use the editor on **img**, **button**, **input** and **a** tags:



```js



```



The model must be an object containing the attributes for your special tags. Example:



```js

constructor () {

  super();



  this.handleModelChange = this.handleModelChange.bind(this);



  this.state = {

    model: {src: 'path/to/image.jpg'}

  };

}

```



* The model can contain a special attribute named **innerHTML** which inserts innerHTML in the element: If you are using 'button' tag, you can specify the button text like this:



```js

this.state = {

  model: {innerHTML: 'Click Me'}

};

```

As the button text is modified by the editor, the **innerHTML** attribute from buttonModel model will be modified too.



## Manual Instantiation



Gets the functionality to operate on the editor: create, destroy and get editor instance. Use it if you want to manually initialize the editor.



`onManualControllerReady={this.handleManualController}`



```js

handleManualController: function(initControls) {

  //...

}

```

The object received by the function will contain the following methods:



- **initialize**: Call this method to initialize the Froala Editor

- **destroy**: Call this method to destroy the Froala Editor

- **getEditor**: Call this method to retrieve the editor that was created. This method will return *null* if the editor was not yet created



## Displaying HTML



To display content created with the froala editor use the `FroalaEditorView` component.



```js



```



## Usage with Functional Component



#### 1. Require and use Froala Editor component inside your application.



```jsx

import React from 'react';

import ReactDOM from 'react-dom/client';



// Require Editor CSS files.

import 'froala-editor/css/froala_style.min.css';

import 'froala-editor/css/froala_editor.pkgd.min.css';



import FroalaEditorComponent from 'react-froala-wysiwyg';



// Import all Froala Editor plugins;

// import 'froala-editor/js/plugins.pkgd.min.js';



// Import a single Froala Editor plugin.

// import 'froala-editor/js/plugins/align.min.js';



// Import a language file.

// import 'froala-editor/js/languages/de.js';



// Import a third-party plugin.

// import 'froala-editor/js/third_party/image_tui.min.js';

// import 'froala-editor/js/third_party/embedly.min.js';

// import 'froala-editor/js/third_party/spell_checker.min.js';



// Include font-awesome css if required.

// install using "npm install font-awesome --save"

// import 'font-awesome/css/font-awesome.css';

// import 'froala-editor/js/third_party/font_awesome.min.js';



// Include special components if required.

// import FroalaEditorView from 'react-froala-wysiwyg/FroalaEditorView';

// import FroalaEditorA from 'react-froala-wysiwyg/FroalaEditorA';

// import FroalaEditorButton from 'react-froala-wysiwyg/FroalaEditorButton';

// import FroalaEditorImg from 'react-froala-wysiwyg/FroalaEditorImg';

// import FroalaEditorInput from 'react-froala-wysiwyg/FroalaEditorInput';



// Render Froala Editor component.

const root = ReactDOM.createRoot(document.getElementById('editor'));

root.render(

  

)



```

#### Add editor to UI by passing id to html element



```





```



#### Pass properties to the wrapping DOM element



```js



```

**tag** attr is used to tell on which tag the editor is initialized.



There are special tags: **a**, **button**, **img**, **input**. Do not use them in FroalaEditor component. To initialize the editor on a special tag, use `FroalaEditorA`, `FroalaEditorButton`, `FroalaEditorImg` and `FroalaEditorInput` components.



### Config



You can pass editor options as component attribute (optional).



`config={config}`



You can pass any existing Froala option. Consult the [Froala documentation](https://www.froala.com/wysiwyg-editor/docs/options) to view the list of all the available options:



```js

config={{

  placeholderText: 'Edit Your Content Here!',

  charCounterCount: false

}}

```



Aditional option is used:

* **immediateReactModelUpdate**: (default: false) This option updates the React model as soon as a key is released in the editor. Note that it may affect performances.



### Events and Methods



Events can be passed in with the options, with a key events and object where the key is the event name and the value is the callback function.



```js

config={{

  placeholder: "Edit Me",

  events : {

    'focus' : function(e, editor) {

      console.log(editor.selection.get());

    }

  }

}}

```



Using the editor instance from the arguments of the callback you can call editor methods as described in the [method docs](http://froala.com/wysiwyg-editor/docs/methods).



Froala events are described in the [events docs](https://froala.com/wysiwyg-editor/docs/events).



Now you can use these buttons in options:

 ```javascript

 toolbarButtons: [['undo', 'redo' , 'bold'], ['alert', 'clear', 'insert']],



 ```



### Model



The WYSIWYG HTML editor content model.



`model = {model}`



Two way binding:



```jsx

import React,{ useState } from 'react';



const App=()=> {

  const [model,setModel] = useState("Example Set");



  const handleModelChange= (event)=>{

    setModel(event)

  }

  return (

    


      

      

    


  );

}

```



To achieve one way binding and pass only the initial editor content, simply do not pass `onModelChange` attribute.



Use the content in other places:



```js



```



### Special tags

You can also use the editor on **img**, **button**, **input** and **a** tags:



```js



```

The model must be an object containing the attributes for your special tags. Example:



```js

    model={{src: 'path/to/image.jpg',

        width:"300px",

        alt:"Old Clock"

    }}

```



* The model can contain a special attribute named **innerHTML** which inserts innerHTML in the element: If you are using 'button' tag, you can specify the button text like this:



```js

model={{innerHTML: 'Click Me'}}

```

As the button text is modified by the editor, the **innerHTML** attribute from buttonModel model will be modified too.



## Usage with Server-Side Rendering



When using Server-Side Rendering you can use Froala components as described previously. If you require additonal plugins or translations, you will have to use React lazy loading

in order to load the plugins first. Please refer to the examples below.



### Class component



```js

import React, { Suspense } from "react";



import 'froala-editor/css/froala_editor.pkgd.min.css';

import 'froala-editor/css/froala_style.css';



const FroalaEditor = React.lazy(() => import('react-froala-wysiwyg'));



export default class MyComponent extends React.Component {

  constructor () {

    super();

    this.state = {

      isInitialized: false

    };

  }



  componentDidMount() {

    // Import all Froala Editor plugins;

    import('froala-editor/js/plugins.pkgd.min.js').then(() => this.setState({isInitialized: true}));

  }



  render() {

	  return <>

  	  {this.state.isInitialized && (

	  	  Loading...}>

		  	  

	  	  

      )}

  	>;

  }

}

```



### Functional component



```js

import React, { Suspense, useEffect, useState } from "react";



import 'froala-editor/css/froala_editor.pkgd.min.css';

import 'froala-editor/css/froala_style.css';



const FroalaEditor = React.lazy(() => import('react-froala-wysiwyg'));



export default function MyComponent() {

	const [isInitialized, setIsInitialized] = useState(false);



	useEffect(() => {

		async function initPlugins() {

      // Import all Froala Editor plugins;

			await import('froala-editor/js/plugins.pkgd.min.js');

			setIsInitialized(true);

		}

		if (!isInitialized) {

			initPlugins();

		}

	});



	return <>

	  {isInitialized && (

		  Loading...}>

			  

		  

    )}

	>;

}

```



## Manual Instantiation



Gets the functionality to operate on the editor: create, destroy and get editor instance. Use it if you want to manually initialize the editor.



`onManualControllerReady={handleManualController}`



```js

handleManualController =(initControls) =>{

  //...

}

```

The object received by the function will contain the following methods:



- **initialize**: Call this method to initialize the Froala Editor

- **destroy**: Call this method to destroy the Froala Editor

- **getEditor**: Call this method to retrieve the editor that was created. This method will return *null* if the editor was not yet created



## Displaying HTML



To display content created with the froala editor use the `FroalaEditorView` component.



```js



```



#### Specific option for special tags



* **reactIgnoreAttrs**: (default: null) This option is an array of attributes that you want to ignore when the editor updates the froalaModel:



 ```js

config: {

  reactIgnoreAttrs: ['class', 'id']

},

 ```



## Using type definition file

`index.d.ts` file is the type definition file for this repository. It is placed inside lib folder.In order to use it in your code , use the following line:

```

///

```

where path is the location of index.d.ts file.



### Custom Buttons



You can pass the custom buttons to the editor by following way:



```javascript



import Froalaeditor from 'froala-editor';

Froalaeditor.DefineIcon('alert', {NAME: 'info', SVG_KEY: 'help'});

  Froalaeditor.RegisterCommand('alert', {

    title: 'Hello',

    focus: false,

    undo: false,

    refreshAfterCallback: false,

    callback: function () {

      alert('Hello!');

    }

  });



  Froalaeditor.DefineIcon('clear', {NAME: 'remove', SVG_KEY: 'remove'});

  Froalaeditor.RegisterCommand('clear', {

    title: 'Clear HTML',

    focus: false,

    undo: true,

    refreshAfterCallback: true,

    callback: function () {

      this.html.set('');

      this.events.focus();

    }

  });



  Froalaeditor.DefineIcon('insert', {NAME: 'plus', SVG_KEY: 'add'});

  Froalaeditor.RegisterCommand('insert', {

    title: 'Insert HTML',

    focus: true,

    undo: true,

    refreshAfterCallback: true,

    callback: function () {

      this.html.insert('My New HTML');

    }

  });

  



 ```

 Now you can use these buttons in options:

 ```javascript

 toolbarButtons: [['undo', 'redo' , 'bold'], ['alert', 'clear', 'insert']],



 ```



## License



The `react-froala-wyswiyg` project is under MIT license. However, in order to use Froala WYSIWYG HTML Editor plugin you should purchase a license for it.



Froala Editor has [3 different licenses](http://froala.com/wysiwyg-editor/pricing) for commercial use.

For details please see [License Agreement](http://froala.com/wysiwyg-editor/terms).



## Development environment setup



If you want to contribute to react-froala-wyswiyg, you will first need to install the required tools to get the project going.



#### Prerequisites



* [Node Package Manager](https://npmjs.org/) (NPM)

* [Git](http://git-scm.com/)



#### Install dependencies



    $ npm install



#### Build



    $ npm run build



#### Run Demo



    $ npm run demo