White Cursor Atom Package

Provides a white I-bar cursor in editor views for use with dark backgrounds.

Unmaintained

Since atom/atom#8663 which was merged in Atom v1.0.12, this package is no longer necessary. I'm leaving it available as an example of how to build an Atom package.

Use

By default the white cursor is always enabled. However, if you set the white-cursor.enabled setting to detect, then when Atom is loaded or any time you change the themes, the White Cursor package attempts to determine whether you have a dark syntax theme set. If so, it enables the white cursor. You can override its autodetection for the current session by using the White Cursor: Toggle command from the Command Palette.

Commands

• white-cursor:toggle — Toggles the white cursor on or off.

Configuration

• white-cursor.enabled — Accepts one of three values:
  • always — White cursor is always enabled (default)
  • detect — Detects whether a dark syntax is being used and enables the white cursor accordingly
  • never — White cursor is always disabled
• white-cursor.darkThemes — An array of theme package names (lowercased and hyphenated) that should be treated as dark syntax themes even if they do not contain both dark and syntax in the name

Styles

The .white-cursor-image mixin is available in case there are situations where you need a white I-bar cursor in some areas of the UI even when you're using a light theme. For example, with the Term2 package you can add the following to your styles.less:

@import "packages/white-cursor/stylesheets/white-cursor";
 
.terminal {
  .white-cursor-image;
}

Copyright

Copyright © 2014-2015 Lee Dohm. See LICENSE for details.