Struct UseColorModeOptions

pub struct UseColorModeOptions<El, T>
where
    El: Clone + Into<ElementMaybeSignal<T, Element>>,
    T: Into<Element> + Clone + 'static,
{ /* private fields */ }

Implementations

impl<El, T> UseColorModeOptions<El, T>

where El: Clone + Into<ElementMaybeSignal<T, Element>>, T: Into<Element> + Clone + 'static,

pub fn target<New__El, New__T>( self, value: New__El, ) -> UseColorModeOptions<New__El, New__T>

where New__El: Clone + Into<ElementMaybeSignal<New__T, Element>>, New__T: Into<Element> + Clone + 'static,

Element that the color mode will be applied to. Defaults to "html".

pub fn attribute(self, value: impl Into<String>) -> Self

HTML attribute applied to the target element. Defaults to "class".

pub fn initial_value(self, value: impl Into<MaybeRwSignal<ColorMode>>) -> Self

Initial value of the color mode. Defaults to "Auto".

pub fn initial_value_from_url_param<OptionInnerType>( self, value: impl Into<Option<OptionInnerType>>, ) -> Self

where OptionInnerType: Into<String>,

Discover the initial value of the color mode from an URL parameter. Defaults to None.

pub fn initial_value_from_url_param_to_storage(self, value: bool) -> Self

Write the initial value of the discovered color mode from URL parameter to storage. This only has an effect if initial_value_from_url_param is specified. Defaults to false.

pub fn custom_modes(self, value: Vec<String>) -> Self

Custom modes that you plan to use as ColorMode::Custom(x). Defaults to vec![].

pub fn on_changed( self, value: Rc<dyn Fn(ColorMode, Rc<dyn Fn(ColorMode)>)>, ) -> Self

Custom handler that is called on updates. If specified this will override the default behavior. To get the default behaviour back you can call the provided default_handler function. It takes two parameters:

• mode: ColorMode: The color mode to change to.
• default_handler: Rc<dyn Fn(ColorMode)>: The default handler that would have been called if the on_changed handler had not been specified.

pub fn storage_signal<OptionInnerType>( self, value: impl Into<Option<OptionInnerType>>, ) -> Self

where OptionInnerType: Into<RwSignal<ColorMode>>,

When provided, useStorage will be skipped. Defaults to None.

pub fn storage_key(self, value: impl Into<String>) -> Self

Key to persist the data into localStorage/sessionStorage. Defaults to "leptos-use-color-scheme".

pub fn storage(self, value: StorageType) -> Self

Storage type, can be Local or Session or custom. Defaults to Local.

pub fn storage_enabled(self, value: bool) -> Self

If the color mode should be persisted. Defaults to true.

pub fn cookie_name(self, value: impl Into<String>) -> Self

Name of the cookie that should be used to persist the color mode. Defaults to "leptos-use-color-scheme".

pub fn cookie_enabled(self, value: bool) -> Self

If the color mode should be persisted through a cookie. Defaults to false.

pub fn emit_auto(self, value: bool) -> Self

Emit auto mode from state

When set to true, preferred mode won’t be translated into light or dark. This is useful when the fact that auto mode was selected needs to be known.

Defaults to false.

pub fn transition_enabled(self, value: bool) -> Self

If transitions on color mode change are enabled. Defaults to false.

pub fn listen_to_storage_changes(self, value: bool) -> Self

Listen to changes to this storage key from somewhere else. Defaults to true.

pub fn ssr_color_header_getter( self, value: impl Fn() -> Option<String> + 'static, ) -> Self

Getter function to return the string value of the Sec-CH-Prefers-Color-Scheme header. When you use one of the features "axum", "actix" or "spin" there’s a valid default implementation provided.

Trait Implementations

impl Default for UseColorModeOptions<&'static str, Element>

fn default() -> Self

Returns the “default value” for a type.