Mibew/title-notification-plugin
1
0
Fork 0
mirror of https://github.com/Mibew/title-notification-plugin.git synced 2024-11-15 00:44:12 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity
Provides notification about new messages and new threads in window title.
12 Commits 1 Branch 2 Tags 22 KiB
PHP 51.8%
JavaScript 48.2%
c6de6fd33e
Go to file
Fedor A. Fetisov c6de6fd33e Fix invalid bitmask for release archives
2018-08-07 20:06:52 +03:00
js Update copyright holder 2014-10-22 13:30:57 +00:00
.bowerrc Initial commit 2014-10-17 08:37:37 +00:00
.gitignore Initial commit 2014-10-17 08:37:37 +00:00
bower.json Initial commit 2014-10-17 08:37:37 +00:00
gulpfile.js Fix invalid bitmask for release archives 2018-08-07 20:06:52 +03:00
LICENSE Initial commit 2014-10-17 08:37:37 +00:00
package.json Bump plugin's version 2014-12-19 15:57:59 +00:00
Plugin.php Bump plugin's version 2014-12-19 15:57:59 +00:00
README.md Update installation instructions 2017-03-21 15:37:14 +03:00

README.md

Mibew Title Notification plugin

It provides notification about new messages and new threads in window title.

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:TitleNotification": # Plugin's configurations are described below
        new_thread: false
        new_message: "operator"

  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.new_thread

Type: Boolean

Default: true

If set to true, window title of the visitors awaiting page will be changed when a visitor starts a new thread. This value is optional and can be skipped.

config.new_message

Type: String

Default: both

This option indicates in what chat windows the title should be changed when a new message is came. The possible values are "client", "operator", "both" and "none". This value is optional and can be skipped.

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