vwc-keypad

A keypad component for Vonage's Vivid Web Components

Properties

Property	Type
no-asterisk	boolean
no-hash	boolean
no-display	boolean
actionText	string
cancelText	string

Methods

Method	Type
createAction	(): void

Events

Event	Payload
digit-added	digit: string
digits-sent	digit: string
action-ended	null

<vwc-keypad>

This webcomponent follows the open-wc recommendation.

Installation

npm i vwc-keypad

Usage

<script type="module">
  import 'vwc-keypad/vwc-keypad.js';
</script>

<vwc-keypad></vwc-keypad>

Linting with ESLint, Prettier, and Types

To scan the project for linting errors, run

npm run lint

You can lint with ESLint and Prettier individually as well

npm run lint:eslint

npm run lint:prettier

To automatically fix many linting errors, run

npm run format

You can format using ESLint and Prettier individually as well

npm run format:eslint

npm run format:prettier

Testing with Karma

To run the suite of karma tests, run

npm run test

To run the tests in watch mode (for TDD, for example), run

npm run test:watch

Demoing with Storybook

To run a local instance of Storybook for your component, run

npm run storybook

To build a production version of Storybook, run

npm run storybook:build

Tooling configs

For most of the tools, the configuration is in the package.json to reduce the amount of files in your project.

If you customize the configuration a lot, you can consider moving them to individual files.

Local Demo with es-dev-server

npm start

To run a local development server that serves the basic demo located in demo/index.html