Code Monkey home page Code Monkey logo

svelte-dark-mode's Introduction

svelte-dark-mode

NPM

Support dark mode in your Svelte apps.

This component sets the theme based on the user’s preferred color scheme using window.matchMedia.

The preferred theme is persisted using the window.localStorage API.


Installation

# Yarn
yarn add -D svelte-dark-mode

# npm
npm i -D svelte-dark-mode

# pnpm
pnpm i -D svelte-dark-mode

Usage

Basic

The theme is set to either "dark" or "light" based on the user’s system preference.

<script>
  import DarkMode from "svelte-dark-mode";

  let theme;

  $: switchTheme = theme === "dark" ? "light" : "dark";
  $: document.body.className = theme;
</script>

<DarkMode bind:theme />

<h1>This is {theme} mode.</h1>
<p>Change the theme and reload the page.</p>

<button on:click={() => (theme = switchTheme)}>
  Switch to {switchTheme} mode
</button>

<style>
  :global(.dark) {
    background: #032f62;
    color: #f1f8ff;
  }
</style>

Server-side rendering (SSR)

When using server-side rendering (SSR), employ the afterUpdate lifecycle to access document.body or document.documentElement.

<script>
  import DarkMode from "svelte-dark-mode";
  import { afterUpdate } from "svelte";

  let theme;

  afterUpdate(() => {
    document.body.className = theme; // "dark" or "light"
  });
</script>

<DarkMode bind:theme />

An alternative to the afterUpdate lifecycle hook is to check if the type of window is undefined.

$: if (typeof window !== "undefined") {
  document.body.className = theme;
}

System preference change

The theme will automatically be updated if the user changes their color scheme preference at the system level.

Custom localStorage key

Use the key prop to customize the local storage key used to track the persisted theme.

By default, the key is "theme".

<DarkMode key="custom-theme-key" />

Use the localStorage.getItem API to programmatically access the stored value.

localStorage.getItem("custom-theme-key"); // "dark" || "light"

API

Props

Name Type Default value
theme "dark" or "light" "dark"
key string "theme"

Dispatched events

  • on:change: dispatched when theme is updated
<DarkMode
  on:change={(e) => {
    console.log(e.detail); // "dark" | "light"
  }}
/>

Changelog

CHANGELOG.md

License

MIT

svelte-dark-mode's People

Contributors

dependabot[bot] avatar metonym avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

svelte-dark-mode's Issues

Event id not been dispatch

<DarkMode on:change={(e) => { console.log(e.detail); // "dark" | "light" }} />

The event is not dispatched only after a full browser reloads then I see the console log.
Using this repo with the latest SvelteKit

Provide function to programmatically toggle theme

It would be nice to have a function (provided through the let: directive or as an accessor) to programmatically update the theme. This way, the consumer wouldn't need to maintain the theme prop by themselves.

let: directive

<DarkMode let:theme let:toggleTheme>
  <button on:click={toggleTheme}>Toggle</button>

   Current theme: {theme}
</DarkMode>

Accessor

<script>
  let darkMode;
  let theme;
</script>

<DarkMode bind:this={darkMode} bind:theme />

<button on:click={darkMode?.toggleTheme}>Toggle</button>

Current theme: {theme}

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.