gbr_js - v1.0.4

gbr/js/darkmode

🌒 Browser dark mode module

The easy way to manage your dark mode web app.

Types

BrowserDarkMode

opaque </>

Browser dark mode type

  • name: Name of key storage in local storage
  • selector: Where is the class setting dark mode
  • class: Class style setting dark mode
pub opaque type BrowserDarkMode

Values

class

</> 
pub fn class(
  in: BrowserDarkMode,
  class: String,
) -> BrowserDarkMode

Set class that set dark mode in your app

  • in: Dark mode info
  • class: Class style to set dark mode, e.g. class=“dark”

from_media

</> 
pub fn from_media(in: BrowserDarkMode) -> Result(Bool, String)

Set dark mode from user media class

is_enabled

</> 
pub fn is_enabled(in: BrowserDarkMode) -> Result(Bool, String)

Is enabled dark mode from match media class

  • in: Dark mode info

name

</> 
pub fn name(in: BrowserDarkMode, name: String) -> BrowserDarkMode

Set name to storage state to toggle dark mode in your app

  • in: Dark mode info
  • name: Local storage key name to manage state dark mode, e.g. selector=“browser/darkmode”

new

</> 
pub fn new() -> BrowserDarkMode

New default browser dark mode type

selector

</> 
pub fn selector(
  in: BrowserDarkMode,
  selector: String,
) -> BrowserDarkMode

Set selector that set class to toggle dark mode in your app

  • in: Dark mode info
  • selector: Selector element to set dark mode, e.g. selector=“body”

toggle

</> 
pub fn toggle(
  in: BrowserDarkMode,
  force: option.Option(Bool),
) -> Result(Bool, String)

Toggle dark mode

  • force: If included, turns the toggle into a one way-only operation.
✨ Search Document