0.1.3 • Published 3 years ago

theme-toggle-button v0.1.3

Weekly downloads
-
License
MIT
Repository
github
Last release
3 years ago

theme-toggle-button Lit Web Component

Links

Prerequisites

  • Node.js Environment (12+)
  • NPM (6.0+)

Run the Demo

  1. npm i
  2. npm start

How to build the package file

  1. npm i
  2. npm run build

How to use the web component

CSS Setup

Below is an example of what your CSS variables and media query could look like. The colors are entirely up to you but the schemes light and dark are required. The CSS variable --theme-offset-bg is the only other requirment. This is the color of the shadow of the button while hovered over.

:root {
  color-scheme: light;
  --theme-bg: #fafafa;
  --theme-on-bg: #000000;
  --theme-offset-bg: #bebebe;
}

@media (prefers-color-scheme: dark) {
  :root {
    color-scheme: dark;
    --theme-bg: #000000;
    --theme-on-bg: #fafafa;
    --theme-offset-bg: #7a7a7a;
  }
}

[color-scheme="light"] {
  color-scheme: light;
  --theme-bg: #fafafa;
  --theme-on-bg: #000000;
  --theme-offset-bg: #bebebe;
}

[color-scheme="dark"] {
  color-scheme: dark;
  --theme-bg: #000000;
  --theme-on-bg: #fafafa;
  --theme-offset-bg: #7a7a7a;
}

NPM Package Usage

To install the web component on your website you also have choices. If you have NPM in your website environment you can use the NPM package

Install the NPM Package

npm i theme-toggle-button

Import the package

import 'theme-toggle-button';

Place the button on page

<theme-toggle-button></theme-toggle-button>

OR

CDN Usage

If you don't have NPM on your site enviroment or you simply prefer a CDN you can add one of the following scripts as high up in the <head> tag of your website as possible.

Script Tag

<script type="module">
  import 'https://cdn.skypack.dev/theme-toggle-button'
</script>

Place the button on page

<theme-toggle-button></theme-toggle-button>
lit
0.1.3

3 years ago

0.1.2

3 years ago

0.1.1

3 years ago

0.1.0

3 years ago