1.0.0 • Published 5 years ago

hyper-wallpaper v1.0.0

Weekly downloads
3
License
MIT
Repository
github
Last release
5 years ago

Hyper-Wallpaper

Extension for Hyper which apply background image easily

demo

Features

  • Background Images with simple config. You need to write only a few lines in hyper.js
  • Multiple images. Hyper-Wallpaper lets you change background image instantly
  • Coexistence with non-image background. You can remove background image and use simple monochromatic background

Configuration

Hyper-Wallpaper can be configured in hyper.js as follows:

module.exports = {
  config: {
    
    // ...
    
    wallpapers: [
      {
        image: true,
        filePath: '/path/to/your/image',
        size: 'cover'
      },
      {
        image: true,
        filePath: '/path/to/your/another/image',
        size: 'cover'
      },
      {
        image: false,
        color: '#000000'
      }
    ],
    
    // ...
    
  }
}

Each item of wallpaper array shows configuration for a wallpaper.

The available options in a wallpaper configurations are as follows:

OptionTypeDescription
imageBooleantrue when you set background image. false when you don't set image but use monochromatic background.
filePathStringFile path for background image file. This option will be ignored when image is false.
sizeStringImage size for background image. Accepted value is same with background-size CSS property. This option will be ignored when image is false. 
colorStringBackground color as HTML color code for monochromatic background. This option will be ignored when image is true