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

qwik-theme-toggle

v1.0.11

Published

The Qwik-Theme-Toggle Library is a lightweight, user-friendly JavaScript library developed as a Qwik component. It provides an efficient theme toggle button for web applications, enabling users to switch between light, dark, and auto modes, enhancing thei

Downloads

45

Readme

Qwik-Theme-Toggle Library ⚡️

The Qwik-Theme-Toggle Library is a lightweight, user-friendly JavaScript library developed as a Qwik component. It provides an efficient theme toggle button for web applications, enabling users to switch between light, dark, and auto modes, enhancing their browsing experience.

Works with Tailwind CSS and DaisyUI.

Leveraging the power and flexibility of Tailwind CSS and its DaisyUI plugin, the library allows for a utility-first framework approach and usage of a robust UI toolkit to create aesthetically pleasing and responsive designs.


Installation

NPM package

npm install qwik-theme-toggle

or if you use bun:

bun install qwik-theme-toggle

Project Structure

Inside Qwik-Theme-Toggle project, you'll find the following directories and files:

└── src/
    ├── components/theme-toggle
    │              └── ...
    └── index.ts
  • src/components/theme-toggle: This directory is a location for Qwik-Theme-Toggle components.

  • index.ts: The entry point of your Qwik-Theme-Toggle library.

  • example/: Contains an example showcasing the usage of Qwik-Theme-Toggle.

Development

During development, Qwik-Theme-Toggle uses Vite's development server with server-side rendering (SSR) capabilities provided by Qwik and Bun. Bun is an all-in-one JavaScript runtime & toolkit designed for speed, complete with a bundler, test runner, and Node.js-compatible package manager.

Start development:

bun install
bun start

Production

For production, the Qwik-Theme-Toggle library should generate the production build in the ./lib directory, along with TypeScript type definitions in ./lib-types.

bun run build

Example

Qwik-Theme-Toggle in action.

Codesandbox

Qwik-Theme-Toggle Example Video

Add daisyUI to your tailwind.config.js files, add darkMode: "class" for pure Tailwind CSS:

module.exports = {
  content: [
    //...
    "./node_modules/qwik-theme-toggle/**/*.{cjs,mjs}"
  ],
  //..
  darkMode: "class", // for Tailwind
  //...
  plugins: [require("daisyui")], // for DaisyUI
}

Add <ThemeScript /> into head

 <head>
    //...
     <ThemeScript
        themeStorageKey="theme" // name of the local storage theme key
        themeQuery="theme"      // (Optional) name of the query param to reflect theme
      />
 </head>

Use toggle button in your code: Set icon size and/or add your own class.

<ThemeToggle
  themeStorageKey="theme"           // name of the local storage theme key
  themeQuery="theme"                // (Optional) name of the query param to reflect theme
  textSize="text-2xl"               // Size of the toggle button
  myClass={"hover:text-secondary"}  // Apply a custom class
/>

Install dependencies:

bun install

Run:

bun start