1.0.1 • Published 12 months ago

suneditor-picmo-emoji v1.0.1

Weekly downloads
-
License
MIT
Repository
github
Last release
12 months ago

Emoji Plugin for SunEditor

This plugin integrates emoji support into SunEditor using the Picmo library. With this plugin, users can easily insert emojis into text, enhancing the user experience with expressive symbols.

screenshot

Features

  • Easy integration
  • Utilizes the Picmo library for a rich set of emojis.
  • User-friendly interface for selecting and inserting emojis.
  • Lightweight and efficient (no additional libraries except Picmo).

Installation

To install the plugin, follow these steps:

  1. Add the Emoji Plugin to your project. You can either download the source code or install it via npm:
npm install suneditor-picmo-emoji

Usage

Here is a basic example of how to integrate the Emoji Plugin into your editor:

  1. Initialize the Picmo emoji picker and integrate it with your editor:
import { picmo }  from 'suneditor-picmo-emoji'
  1. Add a plugin in your config:
suneditor.create('editor', {
    plugins: [
        picmo
    ]
})
  1. Add "picmo" to your button list:
...
buttonList: [
    [
        'picmo'
    ]
]
...
  1. Now, when you run your project, the emoji picker should be integrated with your editor, allowing users to easily insert emojis.

Contributing

We welcome contributions to improve this plugin! Please follow these steps to contribute:

  1. Fork the repository.
  2. Create a new branch for your feature or bug fix.
  3. Make your changes and commit them with descriptive messages.
  4. Push your changes to your forked repository.
  5. Open a pull request to the main repository.

License

This project is licensed under the MIT License. See the LICENSE.md file for more details.

Acknowledgements

  • SunEditor - Excellent WYSIWYG editor.
  • Picmo - The emoji picker library used in this plugin.

Contact

For questions or support, please open an issue on GitHub.

1.0.1

12 months ago

1.0.0

12 months ago