49 lines
1.6 KiB
Python
49 lines
1.6 KiB
Python
from ..defaults import DEFAULT_PROP, resolve_defaults
|
|
from ..events import Handler, ValueChangeEventArguments
|
|
from .mixins.value_element import ValueElement
|
|
|
|
|
|
class DarkMode(ValueElement, component='dark_mode.js'):
|
|
VALUE_PROP = 'value'
|
|
|
|
@resolve_defaults
|
|
def __init__(self,
|
|
value: bool | None = DEFAULT_PROP | False, *,
|
|
on_change: Handler[ValueChangeEventArguments] | None = None,
|
|
) -> None:
|
|
"""Dark mode
|
|
|
|
You can use this element to enable, disable or toggle dark mode on the page.
|
|
The value `None` represents auto mode, which uses the client's system preference.
|
|
|
|
Note that this element overrides the `dark` parameter of the `ui.run` function and page decorators.
|
|
|
|
:param value: Whether dark mode is enabled. If None, dark mode is set to auto.
|
|
:param on_change: Callback that is invoked when the value changes.
|
|
"""
|
|
super().__init__(value=value, on_value_change=on_change)
|
|
|
|
def enable(self) -> None:
|
|
"""Enable dark mode."""
|
|
self.value = True
|
|
|
|
def disable(self) -> None:
|
|
"""Disable dark mode."""
|
|
self.value = False
|
|
|
|
def toggle(self) -> None:
|
|
"""Toggle dark mode.
|
|
|
|
This method will raise a ValueError if dark mode is set to auto.
|
|
"""
|
|
if self.value is None:
|
|
raise ValueError('Cannot toggle dark mode when it is set to auto.')
|
|
self.value = not self.value
|
|
|
|
def auto(self) -> None:
|
|
"""Set dark mode to auto.
|
|
|
|
This will use the client's system preference.
|
|
"""
|
|
self.value = None
|