https://github.com/nexmo-community/open-wc-keypad
Example keypad Web Component built with Open-WC for the blog post at
https://github.com/nexmo-community/open-wc-keypad
javascript lit-element lit-html open-wc vonage webcomponent webcomponents
Last synced: 3 months ago
JSON representation
Example keypad Web Component built with Open-WC for the blog post at
- Host: GitHub
- URL: https://github.com/nexmo-community/open-wc-keypad
- Owner: nexmo-community
- License: mit
- Created: 2020-07-23T16:19:49.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2021-02-01T14:36:23.000Z (over 4 years ago)
- Last Synced: 2025-02-10T09:41:54.013Z (8 months ago)
- Topics: javascript, lit-element, lit-html, open-wc, vonage, webcomponent, webcomponents
- Language: JavaScript
- Homepage:
- Size: 73.2 KB
- Stars: 0
- Watchers: 11
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# \
Example keypad Web Component used in a blog post that can be found at [https://www.nexmo.com/blog/2020/08/13/creating-a-web-component-with-open-wc](https://www.nexmo.com/blog/2020/08/13/creating-a-web-component-with-open-wc)
This Web Component follows the [open-wc](https://github.com/open-wc/open-wc) recommendation.
## Installation
```bash
npm i @your-npm-username/whatever-you-like-keypad
```
## Usage
```html
import '@your-npm-username/whatever-you-like-keypad/whatever-you-like-keypad.js';
```
## Linting with ESLint, Prettier, and Types
To scan the project for linting errors, run
```bash
npm run lint
```
You can lint with ESLint and Prettier individually as well
```bash
npm run lint:eslint
```
```bash
npm run lint:prettier
```
To automatically fix many linting errors, run
```bash
npm run format
```
You can format using ESLint and Prettier individually as well
```bash
npm run format:eslint
```
```bash
npm run format:prettier
```
## 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`
```bash
npm start
```
To run a local development server that serves the basic demo located in `demo/index.html`