Nerdiest Political Manifesto

    i3-status-starter

    0.1.4 • Public • Published

    i3-status-starter

    npm version Dependency Status Build Status Codacy Badge Codacy Badge

    This is a template for writing modules for i3-status. It uses ES2015 modules and babel to compile to node 6. You can code your module as you want, this is just a suggestion.

    Table of content

    Scripts

    use npm run

    • compile use babel to compile for non-es6 runtime
    • test to run the mocha tests
    • watch to watch for changes, compile and test on save.
    • cover to build test coverage report

    Documentation

    A module for i3-status contains a constructor and an update method.

    import { EventEmitter } from 'events';
     
    export default class Starter extends EventEmitter {
        constructor(options, output) {}
     
        update() {}
    }

    Constructor

     constructor(options, output) {
            super();
            options = options || {};
            this.output = output || {};
     
            //custom config
            this.myField = options.myField || 'default';
        }

    i3-status provides the options for the current module from the config together with an output to your constructor.

    If you want to provide extra config just add them to the config file and it is passed to the constructor, example:

      - name: starter
        module: i3-status-starter
        myField: value

    Labels, intervals, click actions etc. will automatically add to your module. If you need to overwrite the click handler see custom click handler

    The output is defined by the i3-bar documentation. The most basic usage is:

    {
        "full_text": "full text",
        "short_text": "short text"
    }

    The name and color is set by the i3-status, but you may overwrite the color. To mark a block as urgent set "urgent":true.

    Update Method

     update() {
            //update output
            this.output.full_text = 'My value: ' + this.myValue;
            this.output.short_text = this.myValue;
     
            //emit updated event to i3Status
            this.emit('updated', this, this.output);
        }

    The update method is called by i3-status based on the configured interval. The update method should update the this.output object and emit an updated event with the blocks name and the output object. If your code uses callbacks just emit the updated event when your callback is done. You can pause executions until your update method is fully completed.

    Interval based execution

    Your module will be called by the i3-status based on the interval set in the block config or the main config. The interval is available in your module:

    console.log(this.__interval); // interval started by i3-status
    console.log(this.__interval_time); // interval length in ms

    Additional Fields

    There are some fields set by i3-status to your module instances.

    • __name: The name of the block your module instanced is started for
    • __click: The click configuration from the config file. See i3-status documentation for more detail.
    • __label: The label of the block
    • __index: Position of the block inside the bar
    • __logger: winston logger to use for logging

    Custom click handler

    By default i3-status injects an action method into your module. You can implement a custom action method if you need more control over the mouse events on the block. The action method gets an action as parameter, which is documented in the i3bar documentation.

    Example:

     
    action(action) {
        this.__logger.debug('button pressed on %s:', this.__name, action.button);
    }

    Pause executions

    If you have a module with long-running code you maybe want to prevent further invocations of the update method until your code execution is ready.

    update() {
        //pause further executions
        this.emit('pause', this);
     
        //ivoke some call
        invoke( (text) => {
            //update output
            this.output.full_text = result.length > 0 ? result[0] : '';
            this.output.short_text = result.length > 1 ? result[1] : '';
     
            //resume further executions
            this.emit('resume', this);
     
            //emit updated event to i3Status
            this.emit('updated', this, this.output);
        });
    }

    Logging

    i3-status uses winston for logging. The log file is written to ~/.i3status.log. Start i3-status with -v to enable verbose logging.

     
    update() {
        this.__logger.debug('update called on ', this.__name);
    }
     

    Reporter

    If you want to display more information which cannot fit in the bar itself you can use the reporter.

    First you should check if there is a reporter defined and if it supports your output format

        if (this.__reporter && this.__reporter.supports('html')) {
            this.__reporter.display(output, action);
        }

    Then you can call the display method. The method takes two arguments, the output and the action from i3-status. If you don't have an action you can create one.

    The output object for the html-reporter contains

    1. a header of the report window
    2. a content in your content type, e.g. html
    3. an optional userStyle with custom css

    The action object contains a x and y value indicating where on the screen the mouse was pressed and where (roughly) the windows should appear.

    Testing

    Please have a look at the Tests for a test example.

    Install

    npm i i3-status-starter

    DownloadsWeekly Downloads

    2

    Version

    0.1.4

    License

    MIT

    Last publish

    Collaborators

    • fehmer