Context API
context.environment
context.environmentIncludes 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
context.hooksUse
context.hooks to run actions at certain times. Hooks are especially useful when adding in element with context.React.context.electron
context.electronExposes 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
context.requestcontext.fileSystem
context.fileSystemcontext.fileSystemJetpack
context.fileSystemJetpackcontext.notifier
context.notifierExample
1
context.notifier.notify({
2
title: 'Notification Title',
3
message: 'This is an example notification message.',
4
});
Copied!
context.process
context.processcontext.React
context.ReactRenderer 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
context.ReactRouterDeprecated
The following contexts have been deprecated in the most recent versions of Local.
context.docker
context.dockerUse
context.docker to run Docker commands.Example
1
context.docker(`start ${container}`).then(stdout => {
2
//Success
3
}).catch(({stdout, stderr}) => {
4
//Something bad happened
5
});
Copied!
Last modified 8mo ago