https://github.com/conversejs/community-plugins
3rd party, community contributed plugins for Converse.js
https://github.com/conversejs/community-plugins
Last synced: 11 months ago
JSON representation
3rd party, community contributed plugins for Converse.js
- Host: GitHub
- URL: https://github.com/conversejs/community-plugins
- Owner: conversejs
- License: other
- Created: 2018-03-15T08:55:55.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2025-04-08T16:19:02.000Z (about 1 year ago)
- Last Synced: 2025-04-08T17:28:21.677Z (about 1 year ago)
- Language: JavaScript
- Size: 42.2 MB
- Stars: 14
- Watchers: 13
- Forks: 11
- Open Issues: 46
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.txt
Awesome Lists containing this project
README
# Converse.js Community Plugins
This repo contains community contributed plugins, not included in the core of Converse.js.
To see a demo of all the plugins working, click [here](https://conversejs.github.io/community-plugins/)
## Example - stickers plugin
## Creating a plugin
To create a new plugin, use [generator-converse](https://github.com/conversejs/generator-conversejs),
which is a [Yeoman](http://yeoman.io/) generator.
Install Yeoman and the generator:
npm install -g yo generator-conversejs
Then, to create a new plugin, run the following:
$ yo conversejs my-sexy-plugin
Where `my-sexy-plugin` should be replaced with the name of your plugin.
## Adding a plugin to the repo here for general use
Simple raise a PR with your new plugin. Please make sure you do the following first
- Create a subfolder for your plugin and copy all your files in there. Please include a screenshot of the plugin working in converse.
- Edit index.html, add your plugin to the index page. Comit your changes and make sure it works from the demo web site at https://conversejs.github.io/community-plugins/.
## Enabling a plugin in Converse
Before a plugin can be used, it needs to be whitelisted when you call `converse.initialize`.
converse.initialize({
whitelisted_plugins: ['my-sexy-plugin'],
});
## TODO: Moving plugins to Lerna
We've started using [Lerna](https://lernajs.org) to manage the plugin packages.
For older plugins, the following needs to be done:
* Move it to the `./packages/` directory
* Add a package.json and give it a name in the form `@converse-plugins/name`