• Packages
  • Themes
  • Documentation
  • Blog
  • Discussions

Chapter 1: Getting Started

  • Why Atom?
  • Installing Atom
  • Atom Basics
  • Summary

Chapter 2: Using Atom

  • Atom Packages
  • Moving in Atom
  • Atom Selections
  • Editing and Deleting Text
  • Find and Replace
  • Snippets
  • Autocomplete
  • Folding
  • Panes
  • Pending Pane Items
  • Grammar
  • Version Control in Atom
  • GitHub package
  • Writing in Atom
  • Basic Customization
  • Summary

Chapter 3: Hacking Atom

  • Tools of the Trade
  • The Init File
  • Package: Word Count
  • Package: Modifying Text
  • Package: Active Editor Info
  • Creating a Theme
  • Creating a Grammar
  • Creating a Legacy TextMate Grammar
  • Publishing
  • Iconography
  • Debugging
  • Writing specs
  • Handling URIs
  • Cross-Platform Compatibility
  • Converting from TextMate
  • Hacking on Atom Core
  • Contributing to Official Atom Packages
  • Creating a Fork of a Core Package in atom/atom
  • Maintaining a Fork of a Core Package in atom/atom
  • Summary

Chapter 4: Behind Atom

  • Configuration API
  • Keymaps In-Depth
  • Scoped Settings, Scopes and Scope Descriptors
  • Serialization in Atom
  • Developing Node Modules
  • Interacting With Other Packages Via Services
  • Maintaining Your Packages
  • How Atom Uses Chromium Snapshots
  • Summary

Reference: API

  • AtomEnvironment
  • BufferedNodeProcess
  • BufferedProcess
  • Clipboard
  • Color
  • CommandRegistry
  • CompositeDisposable
  • Config
  • ContextMenuManager
  • Cursor
  • Decoration
  • DeserializerManager
  • Directory
  • DisplayMarker
  • DisplayMarkerLayer
  • Disposable
  • Dock
  • Emitter
  • File
  • GitRepository
  • Grammar
  • GrammarRegistry
  • Gutter
  • HistoryManager
  • KeymapManager
  • LayerDecoration
  • MarkerLayer
  • MenuManager
  • Notification
  • NotificationManager
  • Package
  • PackageManager
  • Pane
  • Panel
  • PathWatcher
  • Point
  • Project
  • Range
  • ScopeDescriptor
  • Selection
  • StyleManager
  • Task
  • TextBuffer
  • TextEditor
  • ThemeManager
  • TooltipManager
  • ViewRegistry
  • Workspace
  • WorkspaceCenter

Appendix A: Resources

  • Glossary

Appendix B: FAQ

  • Is Atom open source?
  • What does Atom cost?
  • What platforms does Atom run on?
  • How can I contribute to Atom?
  • Why does Atom collect usage data?
  • Atom in the cloud?
  • What's the difference between an IDE and an editor?
  • How can I tell if subpixel antialiasing is working?
  • Why is Atom deleting trailing whitespace? Why is there a newline at the end of the file?
  • What does Safe Mode do?
  • I have a question about a specific Atom community package. Where is the best place to ask it?
  • I’m using an international keyboard and keys that use AltGr or Ctrl+Alt aren’t working
  • I’m having a problem with Julia! What do I do?
  • I’m getting an error about a “self-signed certificate”. What do I do?
  • I’m having a problem with PlatformIO! What do I do?
  • How do I make Atom recognize a file with extension X as language Y?
  • How do I make the Welcome screen stop showing up?
  • How do I preview web page changes automatically?
  • How do I accept input from my program or script when using the script package?
  • I am unable to update to the latest version of Atom on macOS. How do I fix this?
  • I’m trying to change my syntax colors from styles.less, but it isn’t working!
  • How do I build or execute code I've written in Atom?
  • How do I uninstall Atom on macOS?
  • macOS Mojave font rendering change
  • Why does macOS say that Atom wants to access my calendar, contacts, photos, etc.?
  • How do I turn on line wrap?
  • The menu bar disappeared, how do I get it back?
  • How do I use a newline in the result of find and replace?
  • What is this line on the right in the editor view?

Appendix C: Shadow DOM

  • Removing Shadow DOM styles

Appendix D: Upgrading to 1.0 APIs

  • Upgrading Your Package
  • Upgrading Your UI Theme Or Package Selectors
  • Upgrading Your Syntax Theme

Appendix E: Atom server-side APIs

  • Atom package server API
  • Atom update server API

  • mac
  • windows
  • linux

StyleManager Extended

A singleton instance of this class available via atom.styles, which you can use to globally query and observe the set of active style sheets. The StyleManager doesn’t add any style elements to the DOM on its own, but is instead subscribed to by individual <atom-styles> elements, which clone and attach style elements in different contexts.

Event Subscription

This section only has Extended methods.

Extended Methods

::observeStyleElements(callback)

Invoke callback for all current and future style elements.

Argument Description

callback

Function that is called with style elements.

styleElement

An HTMLStyleElement instance. The .sheet property will be null because this element isn’t attached to the DOM. If you want to attach this element to the DOM, be sure to clone it first by calling .cloneNode(true) on it. The style element will also have the following non-standard properties:

sourcePath

A String containing the path from which the style element was loaded.

context

A String indicating the target context of the style element.

Return values

Returns a Disposable on which .dispose() can be called to cancel the subscription.

::onDidAddStyleElement(callback)

Invoke callback when a style element is added.

Argument Description

callback

Function that is called with style elements.

styleElement

An HTMLStyleElement instance. The .sheet property will be null because this element isn’t attached to the DOM. If you want to attach this element to the DOM, be sure to clone it first by calling .cloneNode(true) on it. The style element will also have the following non-standard properties:

sourcePath

A String containing the path from which the style element was loaded.

context

A String indicating the target context of the style element.

Return values

Returns a Disposable on which .dispose() can be called to cancel the subscription.

::onDidRemoveStyleElement(callback)

Invoke callback when a style element is removed.

Argument Description

callback

Function that is called with style elements.

styleElement

An HTMLStyleElement instance.

Return values

Returns a Disposable on which .dispose() can be called to cancel the subscription.

::onDidUpdateStyleElement(callback)

Invoke callback when an existing style element is updated.

Argument Description

callback

Function that is called with style elements.

styleElement

An HTMLStyleElement instance. The .sheet property will be null because this element isn’t attached to the DOM. The style element will also have the following non-standard properties:

sourcePath

A String containing the path from which the style element was loaded.

context

A String indicating the target context of the style element.

Return values

Returns a Disposable on which .dispose() can be called to cancel the subscription.

Reading Style Elements

This section only has Extended methods.

Extended Methods

::getStyleElements()

Get all loaded style elements.

Paths

This section only has Extended methods.

Extended Methods

::getUserStyleSheetPath()

Get the path of the user style sheet in ~/.atom.

Return values

Returns a String.

  • Terms of Use
  • Privacy
  • Code of Conduct
  • Releases
  • FAQ
  • Contact
  • Contribute!
with by