https://github.com/frocher/wc-range-datepicker

lit-element webcomponent

Last synced: 8 months ago
JSON representation

Range datepicker webcomponent

README

# \

This webcomponent follows the [open-wc](https://github.com/open-wc/open-wc) recommendation.

Examples and documentation can be found here : [https://wc-range-datepicker.netlify.app/](https://wc-range-datepicker.netlify.app/)

## Installation
```bash
npm i wc-range-datepicker
```

## Usage
```html

import 'wc-range-datepicker/wc-range-datepicker.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
```

## Testing with Karma
To run the suite of karma tests, run
```bash
npm run test
```

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

```bash
npm run test:watch
```

## 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
```

## 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`