https://github.com/manufosela/theme-toggle

Web-component with Lit based in @open-wc to change between light theme and dark theme automatically
https://github.com/manufosela/theme-toggle

Last synced: 3 months ago
JSON representation

Web-component with Lit based in @open-wc to change between light theme and dark theme automatically

README

# \

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

[Demo](https://codepen.io/manufosela/pen/rNGPORY)

[Demo video](https://www.loom.com/share/2ef6f927e2294f38b40d9746e31e5403)

## Installation

```bash
npm i @manufosela/theme-toggle
```

## Usage

```html

import 'theme-toggle/theme-toggle.js';

```

## Linting and formatting

To scan the project for linting and formatting errors, run

```bash
npm run lint
```

To automatically fix linting and formatting errors, run

```bash
npm run format
```

## Testing with Web Test Runner

To execute a single test run:

```bash
npm run test
```

To run the tests in interactive watch mode 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 minimize 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 `web-dev-server`

```bash
npm start
```

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