# transparent-titlebar

> Transparent title bar with native title label in Electron for Mac

Latest version **0.2.0** (published 2020-08-19) · MIT license · 0 weekly downloads

## Install

```sh
npm install transparent-titlebar
pnpm add transparent-titlebar
yarn add transparent-titlebar
bun add transparent-titlebar
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.0 |
| Published | 2020-08-19 |
| First published | 2018-01-02 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 6.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | yes |
| GitHub stars | 16 |
| Author | Ryohei Ikegami |
| Maintainers | seanchas116 |

## Links

- npm: https://www.npmjs.com/package/transparent-titlebar
- Repository: https://github.com/seanchas116/transparent-titlebar
- Homepage: https://github.com/seanchas116/transparent-titlebar#readme
- Issues: https://github.com/seanchas116/transparent-titlebar/issues
- npm.io page: https://npm.io/package/transparent-titlebar

## Dependencies (2)

- [bindings](https://npm.io/package/bindings.md) ^1.5.0
- [node-addon-api](https://npm.io/package/node-addon-api.md) ^3.0.0

## Recent versions

- 0.2.0 (latest) — 2020-08-19
- 0.1.0 — 2018-01-02

## README

# transparent-titlebar

Transparent title bar with native title label in Electron for Mac

![Example](images/example.gif)

|Using transparent-titlebar|titleBarStyle: hidden in Electron|Normal|
|-|-|-|
| ![Using transparent-titlebar](images/transparent.png) | ![titleBarStyle: hidden](images/titlebarstyle-hidden.png) | ![Normal](images/normal.png) |

## Install

```
npm install transparent-titlebar
```

TypeScript definitions are included.

## Use

```js
let win: BrowserWindow
const transparentTitlebar = require('transparent-titlebar')

// Setup window to use transparent titlebar
transparentTitlebar.setup(win.getNativeWindowHandle())

// Set title color (must be called on page load and whenever the title has changed)
transparentTitlebar.setColor(win.getNativeWindowHandle(), 1, 0, 0, 1)
```

## Run Example

```
cd examples
npm install
npm start
```

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