This guide is intended to get you up-and-running with the Local Addon API.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
context
overview
references
styles
.gitignore
GLOSSARY.md
README.md
SUMMARY.md
book.json

README.md

Local Add-on API

This guide is intended to get you up-and-running with the Local Add-on API. Local add-on's are written primarily in JavaScript and are modeled after Node.js packages.

Structure

package.json

The package.json file is a format for describing Node.js modules. Local add-ons are built on top of Node.js modules.

You must define a renderer and/or main entry-point.

Renderer Process Entry Point

The renderer process is what runs inside the main window. This is where you will add buttons, forms, and any other user interface elements.

Most add-ons will exclusively use the renderer process entry point for the sake of simplicity.

Main Process Entry Point

By tapping into the main process you can run processes even when the window is closed but Local is still running.

Contribute To This Guide

You can contribute to improve this documentation on GitHub by opening issues or creating pull requests.