Context API

Local Add-on API

Download Local Community API Docs Components

Search…

Getting started with Add-ons

Designing your Add-on

Building your Add-on

Add-on Structure

Context API

Using local-components

Hooks

Example Add-ons

Context API

context.environment
Includes the following properties:
appPath: Path to running Local by Flywheel.app
userHome: Path to current user home directory
phpVersion: Available PHP versions in Local
version: Local version
dockerPath: Path to Docker binary in Local by Flywheel.app
userDataPath: Path to Local's user data folder. On macOS this defaults to ~/Library/Application Support/Local by Flywheel
context.hooks
Use context.hooks to run actions at certain times. Hooks are especially useful when adding in element with context.React.
context.electron
Exposes Electron API. The available methods and classes will differ based on whether or not this is ran from the main process or renderer process.
With the Electron API you can create dialogs, open new windows, and more.
context.request
​request npm package, which makes it very easy to send HTTP/HTTPS requests.
context.fileSystem
​fs-extra npm package, which extends the native fs API in Node.js.
context.fileSystemJetpack
​fs-jetpack npm package. Some may prefer it over the native fs API in Node.js.
context.notifier
​node-notifier npm package. The main method in this class is notify.
Example
context.notifier.notify({  
    title: 'Notification Title',  
    message: 'This is an example notification message.',
});
context.process
Node.js process object.
context.React
Renderer Only
context.React required to use JSX in your renderer entry point. You can also use context.React to access React's Top-Level API.
context.ReactRouter
Link - https://reactrouter.com/web/api/Link​
NavLink - https://reactrouter.com/web/api/NavLink​
Route - https://reactrouter.com/web/api/Route​
Router - https://reactrouter.com/web/api/Router​
Deprecated
The following contexts have been deprecated in the most recent versions of Local.
context.docker
Use context.docker to run Docker commands.
Example
context.docker(`start ${container}`).then(stdout => {    
    //Success
}).catch(({stdout, stderr}) => {    
    //Something bad happened
});