@payhos/theme-plugin

PayHos Theme Plugin

PayHos Theme plugin package is built by EmbyBest Concept Nig. Ltd to assist other developers to easily build, maintain and published their own developed themes in the PayHos themes marketplace. It is tested with Node.js and can easily be adapted to other JavaScript-based environments easily.

Installation

Install package via npm by running the following command:

npm install @payhos/theme-plugin --save-dev

Usage

The theme plugin is associated with a node.js server which helps developer create, sync and update theme labels created during the course of theme development. To start the plugin server, run the following command:

node node_modules/@payhos/theme-plugin/dev/server

With the command above, a node.js server is started running on localhost, port 5001 and can be accessed via http://localhost:5001. With this developer-facing interface, you can update and delete the contents of labels as desired.

import { ThemePluginClient } from '@payhos/theme-plugin';

const credentials = {
 themeId: `THEME_ID`,
 secret: `THEME_SECRET_KEY`
};

const client = new ThemePluginClient(credentials);

Use ThemePluginClient to get the plugin proxy object on which any keyed label can be invoked.

client.init().then(plugin => {
  // plugin received here is used to read labels into your templates and user-facing texts/sentences.
  console.log(plugin);
}).catch(e => {
  console.error(e);
});

To read labels that can be translated later, use the plugin variable received from the promise above as follows:

let welcomeText = plugin.welcome_text;

The variable welcomeText created above invokes the creation of the welcome_text label which whose real rext value can be updated in the node.js plugin server running on http://localhost:5001 as noted above.