Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/manufosela/lcd-digit
Lit-Element LCD Digit
https://github.com/manufosela/lcd-digit
Last synced: about 1 month ago
JSON representation
Lit-Element LCD Digit
- Host: GitHub
- URL: https://github.com/manufosela/lcd-digit
- Owner: manufosela
- License: other
- Created: 2019-11-21T17:24:10.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-07-21T09:39:37.000Z (over 1 year ago)
- Last Synced: 2023-07-21T11:03:45.766Z (over 1 year ago)
- Language: JavaScript
- Size: 911 KB
- Stars: 1
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# \
This webcomponent follows the [open-wc](https://github.com/open-wc/open-wc) recommendation.
## Installation
```bash
npm i lcd-digit
```
## Usage
```html
import 'lcd-digit/lcd-digit.js';
```
## Styling
--dot-color: #ff0;
--dot-size: 16px;
## Attributes
- digit: type: String
- count: type: Boolean
- lcd-reference: String,
- max-value: type: Number,
## 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
```
## Testing with Karma
To run the suite of karma tests, run
```bash
npm run test
```
or to run them in compatibility mode for legacy browsers
```bash
npm run test:compatibility
```
To run the tests in watch mode (for TDD, for example), run
```bash
npm run test:watch
```
or
```bash
npm run test:compatibility
```
## Testing with Karma via BrowserStack
To run the suite of karma tests in BrowserStack, run
```bash
npm run test:bs
```
## Managing Test Snapshots
You can manage the test snapshots using
```bash
npm run test:update-snapshots
```
or
```bash
npm run test:prune-snapshots
```
## Demoing with Storybook
To run a local instance of Storybook for your component, run
```bash
npm run storybook
```
To build a production version of Storybook, run
```bash
npm run storybook:build
```
## 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`
```bash
npm start:compatibility
```
To run a local development server in compatibility mode for older browsers that serves the basic demo located in `demo/index.html`