# electron-touchscreen

> Boilerplate for touchscreen or kiosk apps built with Electron

Latest version **1.0.0** (published 2023-04-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install electron-touchscreen
pnpm add electron-touchscreen
yarn add electron-touchscreen
bun add electron-touchscreen
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2023-04-29 |
| First published | 2017-10-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 8.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 38 |
| Author | @jeremyfromearth |
| Maintainers | jeremy.from.earth |
| Keywords | electron, kiosk, touchscreen, exhibit, fullscreen |

## Links

- npm: https://www.npmjs.com/package/electron-touchscreen
- Repository: https://github.com/jeremyfromearth/electron-touchscreen
- Homepage: https://github.com/jeremyfromearth/electron-touchscreen#readme
- Issues: https://github.com/jeremyfromearth/electron-touchscreen/issues
- npm.io page: https://npm.io/package/electron-touchscreen

## Dependencies (1)

- [electron](https://npm.io/package/electron.md) *

## Recent versions

- 1.0.0 (latest) — 2023-04-29
- 0.0.11 — 2019-09-09
- 0.0.10 — 2018-05-24
- 0.0.9 — 2017-12-21
- 0.0.8 — 2017-12-09
- 0.0.7 — 2017-10-27
- 0.0.6 — 2017-10-24
- 0.0.5 — 2017-10-24
- 0.0.4 — 2017-10-21
- 0.0.3 — 2017-10-19
- 0.0.2 — 2017-10-19
- 0.0.1 — 2017-10-19

## README

# electron-touchscreen
Boilerplate for touchscreen or kiosk apps built with Electron.

## Install
```
npm install electron-touchscreen --save
```

## Run the example
```
cd example
npm run start
```

## Basic Usage
```
const path = require('path');
const url = require('url');
const electron = require('electron');

const TouchscreenWindow = require('electron-touchscreen');

let win = null;
const app = electron.app;

app.on('ready', ()=> {
  const demo_url = url.format({
    pathname: path.join(__dirname, 'index.html'),
    protocol: 'file', 
    slashes: true,
  });

  win = new TouchscreenWindow({url: demo_url});
});
```

## Key Commands
* __CMD+K__: Toggles fullscreen
* __CMD+C__: Toggle cursor visibility

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