AtomEnvironment essential
Atom global for dealing with packages, themes, menus, and the window.
An instance of this class is always available as the atom global.
Properties
::clipboard
A Clipboard instance
::deserializers
A DeserializerManager instance
::views
A ViewRegistry instance
::notifications
A NotificationManager instance
::keymaps
A KeymapManager instance
::tooltips
A TooltipManager instance
::commands
A CommandRegistry instance
::grammars
A GrammarRegistry instance
::styles
A StyleManager instance
::packages
A PackageManager instance
::themes
A ThemeManager instance
::contextMenu
A ContextMenuManager instance
::textEditors
A TextEditorRegistry instance
::workspace
A Workspace instance
::history
A HistoryManager instance
Event Subscription
::onDidBeep(callback)
Invoke the given callback whenever ::beep is called.
| Argument | Description |
|---|---|
callback() |
| Return values |
|---|
Returns a Disposable on which |
::onWillThrowError(callback)
Invoke the given callback when there is an unhandled error, but before the devtools pop open
| Argument | Description |
|---|---|
callback(event) |
Function to be called whenever there is an unhandled error |
event |
|
.originalError |
Object the original error object |
.message |
String the original error object |
.url |
String Url to the file where the error originated. |
.line |
|
.column |
|
.preventDefault() |
Function call this to avoid popping up the dev tools. |
| Return values |
|---|
Returns a Disposable on which |
::onDidThrowError(callback)
Invoke the given callback whenever there is an unhandled error.
| Argument | Description |
|---|---|
callback(event) |
Function to be called whenever there is an unhandled error |
event |
|
.originalError |
Object the original error object |
.message |
String the original error object |
.url |
String Url to the file where the error originated. |
.line |
|
.column |
| Return values |
|---|
Returns a Disposable on which |
::whenShellEnvironmentLoaded(callback)
Invoke the given callback as soon as the shell environment is loaded (or immediately if it was already loaded).
| Argument | Description |
|---|---|
callback() |
Function to be called whenever there is an unhandled error |
Atom Details
::getReleaseChannel()
Gets the release channel of the Atom application.
| Return values |
|---|
Returns the release channel as a String. Will return a specific release channel name like 'beta' or 'nightly' if one is found in the Atom version or 'stable' otherwise. |
::getWindowLoadTime()
Get the time taken to completely load the current window.
This time include things like loading and activating packages, creating DOM elements for the editor, and reading the config.
| Return values |
|---|
Returns the Number of milliseconds taken to load the window or null if the window hasn't finished loading yet. |
::getLoadSettings()
Get the load settings for the current window.
| Return values |
|---|
Returns an Object containing all the load setting key/value pairs. |
Managing The Atom Window
::open(params)
Open a new Atom window using the given options.
Calling this method without an options parameter will open a prompt to pick a file/folder to open in the new window.
| Argument | Description |
|---|---|
params |
An Object with the following keys: |
.pathsToOpen |
|
.newWindow |
A Boolean, true to always open a new window instead of reusing existing windows depending on the paths to open. |
.devMode |
A Boolean, true to open the window in development mode. Development mode loads the Atom source from the locally cloned repository and also loads all the packages in ~/.atom/dev/packages |
.safeMode |
A Boolean, true to open the window in safe mode. Safe mode prevents all packages installed to ~/.atom/packages from loading. |
::close()
Close the current window.
::getSize()
Get the size of current window.
| Return values |
|---|
Returns an Object in the format |
::getCurrentWindow()
Get the current window
::center()
Move current window to the center of the screen.
::focus()
Focus the current window.
::show()
Show the current window.
::hide()
Hide the current window.
::reload()
Reload the current window.
::restartApplication()
Relaunch the entire application.
::setFullScreen()
Set the full screen state of the current window.
::toggleFullScreen()
Toggle the full screen state of the current window.
Messaging the User
::beep()
Visually and audibly trigger a beep.
::confirm(options, [callback])
A flexible way to open a dialog akin to an alert dialog.
While both async and sync versions are provided, it is recommended to use the async version such that the renderer process is not blocked while the dialog box is open.
The async version accepts the same options as Electron's dialog.showMessageBox.
For convenience, it sets type to 'info' and normalizeAccessKeys to true by default.
If the dialog is closed (via Esc key or X in the top corner) without selecting a button
the first button will be clicked unless a "Cancel" or "No" button is provided.
// Async version (recommended)atomconfirmmessage: 'How you feeling?'detail: 'Be honest.'buttons: 'Good''Bad'response =>if response === 0windowalert'good to hear'elsewindowalert'bummer'```js// Legacy sync versionconst chosen = atomconfirmmessage: 'How you feeling?'detailedMessage: 'Be honest.'buttons:Good: => windowalert'good to hear'Bad: => windowalert'bummer'
| Argument | Description |
|---|---|
options |
An options Object. If the callback argument is also supplied, see the documentation at https://electronjs.org/docs/api/dialog#dialogshowmessageboxbrowserwindow-options-callback for the list of available options. Otherwise, only the following keys are accepted: |
.message |
The String message to display. |
.detailedMessage |
optional
The String detailed message to display. |
.buttons |
optional
Either an Array of Strings or an Object where keys are button names and the values are callback Functions to invoke when clicked. |
callback() |
optional
A Function that will be called with the index of the chosen option. If a callback is supplied, the dialog will be non-blocking. This argument is recommended. |
| Return values |
|---|
Returns the chosen button index Number if the buttons option is an array
or the return value of the callback if the buttons option is an object.
If a callback function is supplied, returns |
Managing the Dev Tools
::openDevTools()
Open the dev tools for the current window.
| Return values |
|---|
Returns a Promise that resolves when the DevTools have been opened. |
::toggleDevTools()
Toggle the visibility of the dev tools for the current window.
| Return values |
|---|
Returns a Promise that resolves when the DevTools have been opened or closed. |
::executeJavaScriptInDevTools()
Execute code in dev tools.