@lalomartins/shoestring-theme-selector
v1.0.1
Published
A web component for toggling dark mode that uses Shoelace buttons for consistent UI
Downloads
5
Maintainers
Readme
<shoestring-theme-selector>
A web component for theme-selector that uses Shoelace buttons for consistent UI.
Written with Lit 3.0, but you can use it anywhere you can use Shoelace!
Usage
<shoestring-theme-selector></shoestring-theme-selector>
If you're using Shoelace in your own project and you want to avoid loading two different copies, import like this:
import '@shoelace-style/shoelace/dist/components/switch/switch.js';
import '@shoelace-style/shoelace/dist/components/icon/icon.js';
import '@lalomartins/shoestring-theme-selector/shoestring-theme-selector.js';
Otherwise, if you want to use the bundled Shoelace:
import {setBasePath} '@lalomartins/shoestring-theme-selector';
// …
setBasePath("node_modules/@lalomartins/shoestring-theme-selector/node_modules/@shoelace-style/shoelace/dist/");
(You can also use CDNed Shoelace if you prefer.)
API
Attributes:
- size - Size to pass down to sl-switch
Slots:
If you provide contents (default slot), they will be used for the label; otherwise, <sl-icon name="moon" alt="Dark mode"></sl-icon>
Events:
- theme-change - Indicates when the theme changes;
event.detail.isDark
is true when dark mode
Install
npm i @lalomartins/shoestring-theme-selector
You don't need to import Shoelace on your own code if you're not using it, but you do need to load your own CSS, whether it's from CDN, or from node_modules
, or copying it into your build. You can check the Shoelace install instructions for details.
CDN
<link
rel="stylesheet"
href="https://cdn.jsdelivr.net/npm/@shoelace-style/[email protected]/cdn/themes/light.css"
/>
<link
rel="stylesheet"
href="https://cdn.jsdelivr.net/npm/@shoelace-style/[email protected]/cdn/themes/dark.css"
/>
<script
type="module"
src="https://cdn.jsdelivr.net/npm/@shoelace-style/[email protected]/cdn/shoelace-autoloader.js"
></script>
<script
type="module"
src="https://cdn.jsdelivr.net/npm/@lalomartins/[email protected]/cdn/shoestring-theme-selector.js"
></script>
If the icon doen't show up, tweak your import order to make sure you have the Shoelace base path set before Theme Selector loads.