1.0.2 • Published 1 year ago

dom-theme v1.0.2

Weekly downloads
-
License
ISC
Repository
github
Last release
1 year ago

dom-theme

Basic theme management tool for any kind of app


Example:

/* app.js */

import DOMTheme from 'dom-theme'

const theme = new DOMTheme()
theme.run()

Installation

  • with npm
npm i dom-theme
  • with yarn
yarn add dom-theme
  • with pnpm
pnpm add dom-theme

Advanced Usages:

import DOMTheme from 'dom-theme'

const options = {
  root: document.querySelector(`:root`), // Element where should add attr
  init: 'auto' | 'light' | 'dark', // Start this theme if any theme is not stored
  modeAtt: 'theme-mode', // where to write the theme mode
  themeAtt: 'theme', // where to write the theme
  storeKey: 'app-theme', // Localstorage key for saving theme mode
  watch: true, // If should watch for system theme changes in auto theme mode
}
const theme = new DOMTheme(options)
theme.run() // start theme

theme.mode // get current mode: 'auto' | 'light' | 'dark'
theme.isAutoMode // theme.mode === 'auto'
theme.isLightMode // theme.mode === 'light'
theme.isDarkMode // theme.mode === 'dark'

theme.theme // get current theme: 'light' | 'dark'
theme.isLight // theme.theme === 'light'
theme.isDark // theme.theme === 'dark'

theme.auto() // Set theme to auto
theme.light() // Set theme to light
theme.dark() // Set theme to dark
theme.toggle() // Toggle theme
theme.toggle(true) // Toggle theme but after dark theme start auto theme

Made by Nazmus Sayad with ❤️.