#783 renaming dark to dark_mode

nicegui/elements/dark.py

@@ -1,22 +0,0 @@
-from typing import Optional
-
-from ..dependencies import register_component
-from .mixins.value_element import ValueElement
-
-register_component('dark', __file__, 'dark.js')
-
-
-class Dark(ValueElement):
-    VALUE_PROP = 'value'
-
-    def __init__(self, value: Optional[bool] = False) -> None:
-        super().__init__(tag='dark', value=value, on_value_change=None)
-
-    def turn_on(self) -> None:
-        self.value = True
-
-    def turn_off(self) -> None:
-        self.value = False
-
-    def auto(self) -> None:
-        self.value = None

nicegui/elements/dark_mode.py

@@ -0,0 +1,27 @@
+from typing import Optional
+
+from ..dependencies import register_component
+from .mixins.value_element import ValueElement
+
+register_component('dark_mode', __file__, 'dark_mode.js')
+
+
+class DarkMode(ValueElement):
+    VALUE_PROP = 'value'
+
+    def __init__(self, value: Optional[bool] = False) -> None:
+        super().__init__(tag='dark_mode', value=value, on_value_change=None)
+
+    def enable(self) -> None:
+        self.value = True
+
+    def disable(self) -> None:
+        self.value = False
+
+    def toggle(self) -> None:
+        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:
+        self.value = None

nicegui/templates/index.html

@@ -189,11 +189,11 @@
       {{ vue_scripts | safe }}
       {{ js_imports | safe }}
 
-      const dark_mode = {{ dark }};
-      Quasar.Dark.set(dark_mode === None ? "auto" : dark);
+      const dark = {{ dark }};
+      Quasar.Dark.set(dark === None ? "auto" : dark);
       {% if tailwind %}
-      if (dark_mode !== None) tailwind.config.darkMode = "class";
-      if (dark_mode === True) document.body.classList.add("dark");
+      if (dark !== None) tailwind.config.darkMode = "class";
+      if (dark === True) document.body.classList.add("dark");
       {% endif %}
 
       app.mount("#app");

nicegui/ui.py

@@ -16,7 +16,7 @@ from .elements.color_input import ColorInput as color_input
 from .elements.color_picker import ColorPicker as color_picker
 from .elements.colors import Colors as colors
 from .elements.column import Column as column
-from .elements.dark import Dark as dark
+from .elements.dark_mode import DarkMode as dark_mode
 from .elements.date import Date as date
 from .elements.dialog import Dialog as dialog
 from .elements.expansion import Expansion as expansion