npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@jaydanurwin/theme-toggle-button

v0.1.6

Published

## [Watch the YouTube Tutorial](https://youtu.be/dL9KlnnWOhI)

Downloads

26

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

jaydanurwinjaydanurwin

Keywords

Readme

theme-toggle-button Lit Web Component

Watch the YouTube Tutorial

Run the Demo

  1. npm i
  2. npm start

Attributes

  • remember-setting - This will use localStorage to remember what the user set as their preference. If this isn't set on the component it will default back to automatic CSS theme preference detection.

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;
}

/* Important! Be sure to use the variables on your body tag */
body {
  background-color: var(--theme-bg);
  color: var(--theme-on-bg);
}

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 @jaydanurwin/theme-toggle-button

Import the package

import '@jaydanurwin/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/@jaydanurwin/theme-toggle-button'
</script>

Place the button on page

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

How to build a bundled package file

  1. npm i
  2. npm run build