Skip to content

jmjuanes/electron-ejs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

59 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

electron-ejs

npm npm npm

Simple Electron plugin for rendering EJS templates. It allows you to use ejs files in your electron projects.

Install

Install electron-ejs using NPM:

npm install electron-ejs

Usage

//Import dependencies
let electron = require("electron");
let electronEjs = require("electron-ejs");

//Initialize the app
let app = electron.app;

//Initialize the ejs parser
let ejs = new electronEjs({"key": "my value"}, {});

//Now you can read EJS files
app.on("ready", function () {
    //Create the new window
    mainWindow = new BrowserWindow({
        "width": 800, 
        "height": 600
    });

    //More app configuration
    // ....

    //Load the ejs file
    mainWindow.loadURL("file://" + __dirname + "/index.ejs");
});

API

electronEjs(data, options)

Initializes the electron-ejs parser. This can take the following arguments:

data

An object with the data that will be used as a variable in your ejs file.

options

An object with the ejs options. The list with all the options are available here: https://github.com/mde/ejs#options.

The filename options is not necessary and will be ignored.

Want to contribute?

Pull requests and issues are always welcome :)

Contributors

See the full list of contributors.

License

MIT © Josemi Juanes.