# hyperterm-tab-icons

> Icons in the header tabs for the current running process in HyperTerm.

Latest version **1.1.0** (published 2016-09-26) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install hyperterm-tab-icons
pnpm add hyperterm-tab-icons
yarn add hyperterm-tab-icons
bun add hyperterm-tab-icons
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2016-09-26 |
| First published | 2016-07-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 91 |
| Author | Dylan Frankland |
| Maintainers | dfrankland |
| Keywords | hyperterm, tabs, icons, cool |

## Links

- npm: https://www.npmjs.com/package/hyperterm-tab-icons
- Repository: https://github.com/dfrankland/hyperterm-tab-icons
- Homepage: https://github.com/dfrankland/hyperterm-tab-icons#readme
- Issues: https://github.com/dfrankland/hyperterm-tab-icons/issues
- npm.io page: https://npm.io/package/hyperterm-tab-icons

## Dependencies (2)

- [react](https://npm.io/package/react.md) ^15.2.1
- [fuzzaldrin](https://npm.io/package/fuzzaldrin.md) ^2.1.0

## Alternatives

- [@fortawesome/react-fontawesome](https://npm.io/package/@fortawesome/react-fontawesome.md) — 2.2M weekly downloads
- [roboto-fontface](https://npm.io/package/roboto-fontface.md) — 196.0K weekly downloads
- [@react-native-vector-icons/common](https://npm.io/package/@react-native-vector-icons/common.md) — 150.4K weekly downloads
- [@procore/core-icons](https://npm.io/package/@procore/core-icons.md) — 4.6K weekly downloads
- [@react-md/material-icons](https://npm.io/package/@react-md/material-icons.md) — 1.6K weekly downloads

## Recent versions

- 1.1.0 (latest) — 2016-09-26
- 1.0.3 — 2016-08-17
- 1.0.2 — 2016-07-27
- 1.0.1 — 2016-07-24
- 1.0.0 — 2016-07-24

## README

# HyperTerm Tab Icons

> Icons in the header tabs for the current running process in HyperTerm.

## How It Works

Uses [fuzzaldrin][1] to try to match the current tab title against the icons
that have been pre-compiled and displays it. Has the ability to map different
icons and styles.

### Demo

![alt demo][2]

### Configuration

There are few options to customize the different icons and styles applied.
You may configure these inside of `~/.hyperterm.js`.

#### `config.tabIcons.activeStyle`

*   Type: `object`
*   Default: `{ transition: 'opacity 200ms ease-in' }`

This object can be any [CSSStyleDeclaration][3] allowed.
Essentially pass an inline style object [the same way you would with React][4].

#### `config.tabIcons.inactiveStyle`

*   Type: `object`
*   Default: `{ color: '#fff', opacity: 0.3 }`

This object can be any [CSSStyleDeclaration][3] allowed.
Essentially pass an inline style object [the same way you would with React][4].

#### `config.tabIcons.mapIcons`

*   Type: `object`
*   Default: `{}`

Map of icon to array of process names. Example:

```javascript
{
  nodejs: ['node'],
  docker: ['docker-compose'],
}
```

Look inside [`src/icons`][5] for possible icons to map to. Look at
[`src/mapIcons.js`][6] for defaults.

#### `config.tabIcons.mapColors`

*   Type: `object`
*   Default: `{}`

Map of process name to color string. Example:

```javascript
{
  bash: '#FFF',
  fish: '#D8494F',
  zsh: '#C5DB00',
}
```

Look at [`src/mapColors.js`][7] for defaults.

#### `config.tabIcons.disableColors`

* Type: `boolean`
* Default: `false`

Toggles icon colors. Similar to setting all colors to `#FFF`.

### Contribution

Obviously there are an almost infinite amount of processes out there, so any
help adding new icons, mapping colors, et cetera is greatly appreciated!

### Credit

Inspired by [Atom's][8] [`file-icons`][9].

[1]: https://github.com/atom/fuzzaldrin
[2]: http://i.giphy.com/pb6hCi4j0ErpC.gif
[3]: https://developer.mozilla.org/en-US/docs/Web/API/CSSStyleDeclaration/cssText
[4]: https://facebook.github.io/react/tips/inline-styles.html
[5]: https://github.com/dfrankland/hyperterm-tab-icons/tree/master/src/icons
[6]: https://github.com/dfrankland/hyperterm-tab-icons/tree/master/src/mapIcons.js
[7]: https://github.com/dfrankland/hyperterm-tab-icons/tree/master/src/mapColors.js
[8]: http://atom.io/
[9]: https://github.com/DanBrooker/file-icons

---
_Source: https://npm.io/package/hyperterm-tab-icons · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._