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

@chrisburnell/theme-selector

v1.0.1

Published

A Web Component to set a site-wide theme preference using a native select element, saved to local storage.

Downloads

10

Readme

theme-selector

A Web Component for setting a website theme using a select element.

Demo | Further reading

Examples

General usage example:

<script type="module" src="theme-selector.js"></script>

<theme-selector>
    <select autocomplete="off">
        <option value="light">
            Light
        </option>
        <option value="dark">
            Dark
        </option>
    </select>
</theme-selector>

<style>
    theme-selector:not(:defined) {
        display: none;
    }
</style>

Example using a custom storage key:

<script type="module" src="theme-selector.js"></script>

<theme-selector data-key="color-scheme">
    <select autocomplete="off">
        <option value="light">
            Light
        </option>
        <option value="dark">
            Dark
        </option>
    </select>
</theme-selector>

<style>
    theme-selector:not(:defined) {
        display: none;
    }
</style>

Example using a custom dark theme key:

<script type="module" src="theme-selector.js"></script>

<theme-selector data-dark-theme="white-on-black">
    <select autocomplete="off">
        <option value="black-on-white">
            Black on White
        </option>
        <option value="white-on-black">
            White on Black
        </option>
    </select>
</theme-selector>

<style>
    theme-selector:not(:defined) {
        display: none;
    }
</style>

Example with a custom transition class and duration to keep the class applied:

<script type="module" src="theme-selector.js"></script>

<theme-selector data-transition-class="transitioning" data-transition-duration="100">
    <select autocomplete="off">
        <option value="light">
            Light
        </option>
        <option value="dark">
            Dark
        </option>
    </select>
</theme-selector>

<style>
    theme-selector:not(:defined) {
        display: none;
    }
</style>

Example targeting a specific element to apply the theme to:

<script type="module" src="theme-selector.js"></script>

<theme-selector data-root-element=".content">
    <select autocomplete="off">
        <option value="light">
            Light
        </option>
        <option value="dark">
            Dark
        </option>
    </select>
</theme-selector>

<style>
    theme-selector:not(:defined) {
        display: none;
    }
</style>

Features

This Web Component allows you to use a select element to control user-preferred theming across your website by setting a data attribute against the root element (or a defined selector query). Additionally saves the preference to local storage so that it can be applied on new page loads and maintained between user visits.

Installation

You have a few options (choose one of these):

  1. Install via npm: npm install @chrisburnell/theme-selector
  2. Download the source manually from GitHub into your project.
  3. Skip this step and use the script directly via a 3rd party CDN (not recommended for production use)

Usage

Make sure you include the <script> in your project (choose one of these):

<!-- Host yourself -->
<script type="module" src="theme-selector.js"></script>
<!-- 3rd party CDN, not recommended for production use -->
<script
  type="module"
  src="https://www.unpkg.com/@chrisburnell/[email protected]/theme-selector.js"
></script>
<!-- 3rd party CDN, not recommended for production use -->
<script
  type="module"
  src="https://esm.sh/@chrisburnell/[email protected]"
></script>

Credit

With thanks to the following people: