DarkMode

Enum DarkMode 

Source
pub enum DarkMode {
    Class(Cow<'static, str>),
    Media,
}
Expand description

Configuration for the Theme::dark_mode field.

It defines how the dark: variant should behave.

The default value is DarkMode::Media which enables the automatic detection of the theme based on user preference.

Variants§

§

Class(Cow<'static, str>)

The dark: variant will modify the class of the selector. You’ll then need to toggle this class to enable the dark theme.

§Example

use encre_css::{Config, config::DarkMode};

let mut config = Config::default();
config.theme.dark_mode = DarkMode::new_class("body.dark");

let generated = encre_css::generate(
    ["dark:text-white"],
    &config,
);

assert!(generated.ends_with(r#"body.dark .dark\:text-white {
  color: #fff;
}"#));
§

Media

The dark: variant will generates a @media (prefers-color-scheme: dark) rule to enable the dark theme following user preference.

This is the default value.

§Example

use encre_css::{Config, config::DarkMode};

let mut config = Config::default();
config.theme.dark_mode = DarkMode::Media;

let generated = encre_css::generate(
    ["dark:text-white"],
    &config,
);

assert!(generated.ends_with(r#"@media (prefers-color-scheme: dark) {
  .dark\:text-white {
    color: #fff;
  }
}"#));

Implementations§

Source§

impl DarkMode

Source

pub fn new_class<T: Into<Cow<'static, str>>>(class: T) -> Self

Quickly build a DarkMode::Class value.

Trait Implementations§

Source§

impl Clone for DarkMode

Source§

fn clone(&self) -> DarkMode

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for DarkMode

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for DarkMode

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for DarkMode

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for DarkMode

Source§

fn eq(&self, other: &DarkMode) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for DarkMode

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl Eq for DarkMode

Source§

impl StructuralPartialEq for DarkMode

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,