# @xroussel/ng-virtual-keyboard

> Virtual Keyboard for Angular applications

Latest version **0.6.15** (published 2020-01-21) · MIT license · 0 weekly downloads

## Install

```sh
npm install @xroussel/ng-virtual-keyboard
pnpm add @xroussel/ng-virtual-keyboard
yarn add @xroussel/ng-virtual-keyboard
bun add @xroussel/ng-virtual-keyboard
```

## Health

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

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads; large bundle; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.6.15 |
| Published | 2020-01-21 |
| First published | 2017-07-31 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 6 |
| Unpacked size | 21 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 25 |
| Author | Protacon |
| Maintainers | xroussel |
| Keywords | Angular |

## Links

- npm: https://www.npmjs.com/package/@xroussel/ng-virtual-keyboard
- Repository: https://github.com/protacon/ng-virtual-keyboard
- Homepage: https://github.com/protacon/ng-virtual-keyboard#readme
- Issues: https://github.com/protacon/ng-virtual-keyboard/issues
- npm.io page: https://npm.io/package/@xroussel/ng-virtual-keyboard

## Dependencies (6)

- [hammerjs](https://npm.io/package/hammerjs.md) 2.0.8
- [@angular/cdk](https://npm.io/package/@angular/cdk.md) 2.0.0-beta.8
- [@angular/material](https://npm.io/package/@angular/material.md) 2.0.0-beta.8
- [@angular/animations](https://npm.io/package/@angular/animations.md) 4.3.1
- [@angular/flex-layout](https://npm.io/package/@angular/flex-layout.md) 2.0.0-beta.8
- [ng2-right-click-menu](https://npm.io/package/ng2-right-click-menu.md) 0.0.14

## Recent versions

- 0.6.15 (latest) — 2020-01-21
- 0.6.14 — 2019-04-05
- 0.6.13 — 2018-12-14
- 0.6.12 — 2018-12-03
- 0.6.11 — 2018-11-14
- 0.6.10 — 2018-10-18
- 0.6.9 — 2018-10-10
- 0.6.8 — 2018-10-10
- 0.6.7 — 2017-11-03
- 0.6.6 — 2017-11-03
- 0.6.5 — 2017-10-26
- 0.6.4 — 2017-10-05
- 0.6.3 — 2017-09-28
- 0.6.2 — 2017-08-04
- 0.6.1 — 2017-07-31
- … 1 more at https://npm.io/package/@xroussel/ng-virtual-keyboard/versions

## README

# ng-virtual-keyboard
[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
[![npm version](https://badge.fury.io/js/%40protacon%2Fng-virtual-keyboard.svg)](https://badge.fury.io/js/%40protacon%2Fng-virtual-keyboard)
[![Build Status](https://travis-ci.org/protacon/ng-virtual-keyboard.png?branch=master)](https://travis-ci.org/protacon/ng-virtual-keyboard)
[![codecov](https://codecov.io/gh/protacon/ng-virtual-keyboard/branch/master/graph/badge.svg)](https://codecov.io/gh/protacon/ng-virtual-keyboard)
[![Dependency Status](https://david-dm.org/protacon/ng-virtual-keyboard.svg)](https://david-dm.org/protacon/ng-virtual-keyboard)
[![devDependency Status](https://david-dm.org/protacon/ng-virtual-keyboard/dev-status.svg)](https://david-dm.org/protacon/ng-virtual-keyboard#info=devDependencies)

## What is this?
Virtual Keyboard for Angular applications

## Install
### Step 1: Install @protacon/ng-virtual-keyboard
```bash
$ npm install --save @protacon/ng-virtual-keyboard
```

### Step 2: Import the module
Add `NgVirtualKeyboardModule` as an import in your app's root NgModule.
```typescript
import { NgVirtualKeyboardModule }  from '@protacon/ng-virtual-keyboard';

@NgModule({
  ...
  imports: [
    ...
    NgVirtualKeyboardModule,
  ],
  ...
})
export class AppModule { }
```

## Usage
Simple usage example
```html
<input type="text" value=""
  ng-virtual-keyboard
  ng-virtual-keyboard-layout="alphanumeric"
  ng-virtual-keyboard-placeholder="Custom placeholder text"
  ng-virtual-keyboard-type="password"
/>
```

| Attribute | Description |
| --- | --- |
| `ng-virtual-keyboard`             | Required to initialize Virtual Keyboard to specified input |
| `ng-virtual-keyboard-layout`      | Used layout on keyboard, following keyboards are defaults that you can use `alphanumeric, alphanumericSwiss, alphanumericNordic, extended, extendedNordic, numeric, phone` |
| `ng-virtual-keyboard-placeholder` | Override placeholder text, if input has not any - or you want to override input placeholder value |
| `ng-virtual-keyboard-type` | Override input type, text is default value |

## Demo
https://protacon.github.io/ng-virtual-keyboard/

## License
[The MIT License (MIT)](LICENSE)

Copyright (c) 2017 Protacon

---
_Source: https://npm.io/package/@xroussel/ng-virtual-keyboard · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._