Code Monkey home page Code Monkey logo

button-refresh-plugin's Introduction

Mibew Button Refresh plugin

It make the button refresents actual operator's state.

NB.: Actually the plugin adjusts the button generation process. So if you want to disable autorefresh of the button, it's not enough to only disable the plugin. One should also regenerate the button afterwards.

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:ButtonRefresh": # Plugin's configurations are described below
            refresh_frequency: 3
  5. Navigate to "<Mibew Base URL>/operator/plugin" page and enable the plugin.

  6. Regenerate button at "<Mibew Base URL>/operator/button-code" page.

Beware that when the plugin will be disabled or uninstalled the button MUST be regenerated.

Plugin's configurations

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

config.refresh_frequency

Type: Integer

Default: 3

Specify time in seconds between button refreshes. 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

button-refresh-plugin's People

Contributors

faf avatar justblackbird avatar

Watchers

 avatar  avatar  avatar  avatar

button-refresh-plugin's Issues

The plugin cannot be easily disabled

The button needs to be regenerated after the plugin becomes disabled/uninstalled to stop the refreshing. Also after changing plugin's settings the button needs to be regenerated too.

I believe there is another way to interact with the core that does not need the button to be regenerated at every change.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.