Skip to content

Latest commit

 

History

History
63 lines (47 loc) · 1.73 KB

README.md

File metadata and controls

63 lines (47 loc) · 1.73 KB

System Theme Hyper Plugin

NPM Version NPM Downloads NPM License

This plugin allows you to change the Hyper terminal emulator theme based on the system theme. When the system theme changes, the window gets reloaded and the new theme is applied.

Plugin Preview

Installation

Add hyper-system-theme to the plugins list in your ~/.hyper.js configuration file.

module.exports = {
  ...
  plugins: ['hyper-system-theme'],
  ...
};

Usage

The plugin will expose two new configuration options in your ~/.hyper.js configuration file:

  • lightConfigOverrides: an object containing the config overrides for the light theme
  • darkConfigOverrides: an object containing the config overrides for the dark theme

The keys in the lightConfigOverrides and darkConfigOverrides objects will override the default Hyper configuration options.

Example

module.exports = {
  ...
  lightConfigOverrides: {
    backgroundColor: '#fff',
    foregroundColor: '#000',
    cursorColor: '#000',
    borderColor: '#fff',
  },
  darkConfigOverrides: {
    backgroundColor: '#000',
    foregroundColor: '#fff',
    cursorColor: '#fff',
    borderColor: '#000',
  },
  ...
};

Contributing

If you have any bugs, feature requests, or questions, please open an issue on the GitHub repository. Pull requests are welcome, especially if you can figure out a way to reload the theme without reloading the window :).

License

This project is licensed under the MIT License - see the LICENSE file for details.