zombiebox-extension-about

2.1.2 • Public • Published

zombiebox-extension-about

ZombieBox extension for displaying main info about an application.

Usage

The extension provides popup About that should be integrated to the application. To do this, call About.processKey with the given key in main processKey method:

import About from 'about/about';
import BaseApplication from 'generated/zb/base-application';

/**
*/
export default class Application extends BaseApplication {
    /**
     * @override
     */
    processKey(zbKey, e) {
	    About.processKey(zbKey);

	    return super.processKey(zbKey, e);
	}
}

To display the information about the application press 1235789 (like Z) on the remote.

Custom key sequence

The default key sequence can be changed by calling About.setKeySequence method:

About.setKeySequence([
	Keys.DIGIT_1,
	Keys.DIGIT_2,
	Keys.DIGIT_3,
]);

Passing custom information

There is an ability to customize the displayed information. To do this, call About.setCustomDataProvider with a new function-provider:

About.setCustomDataProvider((defaultData) => {
	defaultData['apiVersion'] = app.getApiVersion();
	
	return defaultData;
});

Note: a new key must be defined by bracket notation.

Dependencies (0)

    Dev Dependencies (10)

    Package Sidebar

    Install

    npm i zombiebox-extension-about

    Weekly Downloads

    4

    Version

    2.1.2

    License

    MIT

    Unpacked Size

    111 kB

    Total Files

    31

    Last publish

    Collaborators

    • lacki
    • reefridge