JSPM

hyper-ink-badge

1.0.0
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 7
  • Score
    100M100P100Q37375F
  • License MIT

Package Exports

  • hyper-ink-badge

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (hyper-ink-badge) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Hyper InkBadge

HyperInkBadge is a badge plugin for Hyper.app. It shows you a badge telling you the current session by ink color. Besides the colored ink, it could show text information as badges. This plugin is inspired by Badges of iTerm2 and Splatoon!

overview

Features & Demo

Change the color

You can change color of ink via GUI or CLI.

  • GUI: Just click the badge.
  • CLI: Input quoted ink-badge command with color code like below.
$'ink-badge #5FA, #3B3'

chagecolor

  • Click the badge with 'command' key then you can use color picker.

colorpicker

Set text

  • Input quoted ink-badge command with text like below.
$ 'ink-badge Hello World

Fix the color to 'Tab title'

  • Click with 'Shift' key then you can fixe current ink color to current tab title.

fixtotitle

Install

  1. get source code from github, and bundle it with webpack as below.
$ cd ~/.hyper_plugins/local
$ git clone
$ yarn
$ yarn webpack
  1. Configure the localPlugins parameter in ~/.hyper.js as bellow.
   localPlugins: ["hyper-ink-badge"],

Configuration.

module.exports = {
  config: {
    hyperInktoon: {
        command: 'ink',
        templateColors: [
            ['#e78a48', '#ffffff'], 
            ['#d9503f', '#5186ec'],
            ['#3472b4', '#4aabb8'],
        ],
        advancedPicker: true,
        fontPath: 'file:///tmp/ikamodoki.woff',
        imagePath: 'file:///tmp/slime.svg',
        baseColors: ['#0096d9', '#e5004a'],
    },
  }
}

command

change cli command key. default is value is ink-badge.

command: 'ink'

templateColors

Specify the template colors that used to change color by clicking the badge.

templateColors: [
  ['#e78a48', '#ffffff'], 
  ['#d9503f', '#5186ec'],
  ['#3472b4', '#4aabb8'],
],

advancedPicker

Set true, you can use color picker that enables you to select more detailed color. default false.

advancedPicker: true
deteiedcolorpicker

fontPath

You can use your favorite font. default font is 'paintball_web.woff' created by 'Project Paintball'

fontPath: 'file:///tmp/myfont.woff'

imagePath & baseColors

You can use your favarite SVG image instead of default ink image. Besides specifing imagePath, you have to set the baseColors value which indicates the changeable colors.

imagePath: 'file:///tmp/slime.svg',
baseColors: ['#0096d9', '#e5004a'],

2018-07-04 18 53 02

Licence

MIT