0.1.6 • Published 10 months ago

pom-text-editor-react v0.1.6

Weekly downloads
-
License
MIT
Repository
-
Last release
10 months ago

PomTextEditor

PomTextEditor is a customizable and easy-to-use text editor component for React applications. It provides rich text editing features with a simple API for integration.

Installation

To install PomTextEditor in your project, use either npm or yarn.

Using npm:

bash

Copy code

npm install pom-text-editor-react

Using yarn:

bash

Copy code

yarn add pom-text-editor-react

Usage

javascript

Copy code

import EditorComponent from 'pom-text-editor-react'; // Correct import path

import 'pom-text-editor-react/dist/index.css'; // Import necessary styles

Example with Toolbar Customization

You can easily customize toolbars and capture changes using the component’s API:

jsx

Copy code

import React from 'react';

import EditorComponent from 'pom-text-editor-react';

  

function App() {

const handleSave = (val) => {

console.log(val, 'Your HTML content');

};

  

return (

<div>

<h1>My App</h1>

<EditorComponent

change={handleSave}

toolbarAfter={

<>

<span>12</span>

<span>12</span>

</>

}

toolbarBefore={

<>

<span onClick={() => console.log('Clicked 1')}>Helo5</span>

<span onClick={() => console.log('Clicked 2')}>Helo6</span>

</>

}

/>

</div>

);

}

  

export default App;

Handling Data Changes

To retrieve and process the editor content:

jsx

Copy code

function change(val) {

console.log(val, 'Editor content');

}

Custom Styles

By default, PomTextEditor comes with pre-built styles. However, if you want to customize the styles, you can add your own CSS:

css

Copy code

import 'pom-text-editor-react/dist/index.css'; 
// Base styles for the editor

You can also include scoped styles directly in your React components.

Documentation

For detailed information and advanced customization options, refer to the PomTextEditor documentation (Coming soon).

Contributing

We welcome contributions! To contribute:

Fork the repository.

Create a new feature branch: git checkout -b feature/your-feature.

Commit your changes: git commit -m 'Add new feature'.

Push to the branch: git push origin feature/your-feature.

Open a Pull Request.

License

PomTextEditor is licensed under the MIT License. See the LICENSE file for more details.

Contact

If you have any questions or suggestions, feel free to reach out via email: ssengendonazil@gmail.com.

Contributors

SSENGENDO NAZIL – Lead Project Maintainer

0.1.6

10 months ago

0.1.5

10 months ago

0.1.4

10 months ago

0.1.3

10 months ago

0.0.3

10 months ago

0.0.2

10 months ago

0.0.1

10 months ago