1.0.0 • Published 4 years ago
@slozano/react-text-editor v1.0.0
React Text Editor
A small, simple and customizable text editor for React applications.
Table of Contents
Installation
To install, you can use npm or yarn:
npm install @superdatascience/react-text-editor
Usage
import React, { useState, Fragment } from 'react';
import ReactDOM from 'react-dom';
import Editor from '@superdatascience/react-text-editor';
const Example = () => {
const [values, setValues] = useState({ text: '<p>Editor example text</p>' });
const handleChange = (event) => {
const { name, value } = event.target;
setValues({ ...values, [name]: value });
}
return (
<Fragment>
<Editor
field="text"
html={values.text}
saveCallback={handleChange}
placeholder="custon placeholder text..."
/>
<button onClick={() => console.log(values.text)}>Preview Text</button>
</Fragment>
);
};
ReactDOM.render(<Example />, document.body);
Props
Prop | Type | Description | |
---|---|---|---|
field | String | Field that callback event.target.name will replace | |
html | String | Current html text value | |
saveCallback | Function | Save changes function. The Editor returns a event with the updated information | |
placeholder | String | Text editor custom placeholder |
Requirements
The minimum supported version of React is v16.13.1. If you use an older version, upgrade React to use this library.
Contributing
If you would like to contribute to React Text Editor, please make sure to read our contributor guidelines.
1.0.0
4 years ago