Skip to content

Latest commit

 

History

History
55 lines (35 loc) · 1.79 KB

README.md

File metadata and controls

55 lines (35 loc) · 1.79 KB
Raw

Big Close Button plugin

A plugin to add a big button to the chat box.

Based on the idea from this issue.

Installation

  1. Get the archive with the plugin sources. You can download it from the official site or build the plugin from sources.

  2. Untar/unzip the plugin's archive.

  3. Put files of the plugins to the <Mibew root>/plugins folder.

  4. (optional) Add plugins configs to "plugins" structure in "<Mibew root>/configs/config.yml". If the "plugins" stucture looks like plugins: [] it will become:

    plugins:
    "Mibew:BigCloseButton": # Plugin's configurations are described below
        operation_mode: dismiss

  5. Navigate to "<Mibew Base URL>/operator/plugin" page and enable the plugin.

Plugin's configurations

The plugin can be configured with values in "<Mibew root>/configs/config.yml" file.

config.operation_mode

Type: String

Default: close

Operation mode (i.e. how the button acts on click). At the moment there are two options available: close (close chat box and end the chat) and dismiss (just close chat box solely).

Build from sources

There are several actions one should do before use the latest version of the plugin from the repository:

  1. Obtain a copy of the repository using git clone, download button, or another way.
  2. Install node.js and npm.
  3. Install Gulp.
  4. Install npm dependencies using npm install.
  5. Run Gulp to build the sources using gulp default.

Finally .tar.gz and .zip archives of the ready-to-use Plugin will be available in release directory.

License

Apache License 2.0