dash-startup-loading-plugin 1.0.3__tar.gz → 1.0.4__tar.gz

{dash_startup_loading_plugin-1.0.3/src/dash_startup_loading_plugin.egg-info → dash_startup_loading_plugin-1.0.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dash-startup-loading-plugin
-Version: 1.0.3
+Version: 1.0.4
 Summary: A configurable full-screen startup loading overlay for Dash apps, packaged as a Dash Hooks plugin.
 Author-email: Ethan Zhang <ethan.zhang2016@gmail.com>
 License-Expression: MIT
@@ -34,7 +34,7 @@ document.
 ## Installation
 
 ```bash
-pip install "dash-startup-loading-plugin>=1.0.3"
+pip install "dash-startup-loading-plugin>=1.0.4"
 ```
 
 Dash discovers the plugin through its `dash_hooks` entry point. Installing the
@@ -89,6 +89,30 @@ app.layout = html.Main(
 )
 ```
 
+### Theme behavior
+
+With the default `theme_mode="auto"`, the startup overlay follows an explicit
+application theme from, in order, the root HTML element (including Tailwind's
+`dark`/`light` classes and common theme data attributes), a persisted Dash
+theme component, or conventional theme keys in local storage. If the
+application has not declared a theme preference, the overlay uses the light
+theme; it does not infer a preference from the operating system.
+
+Set the mode explicitly when the application does not expose its preference,
+or when the loading screen should always use one theme:
+
+```python
+configure(theme_mode="light")  # or "dark"
+```
+
+An application preference explicitly set to `"system"` or `"auto"` still
+uses `prefers-color-scheme`. Use `dash_theme_component_id` to prefer one Dash
+component when multiple persisted theme values exist:
+
+```python
+configure(theme_mode="auto", dash_theme_component_id="theme-provider")
+```
+
 ## Component-library integrations
 
 Component libraries are not dependencies of this package. Install only the
@@ -221,7 +245,7 @@ configure(pending_selector=None)
 | `dark_background` | `"#0f0f0f"` | Dark background. |
 | `color` | `"#1677ff"` | Light spinner color. |
 | `dark_color` | `"#4096ff"` | Dark spinner color. |
-| `theme_mode` | `"auto"` | `"auto"`, `"light"`, or `"dark"`. |
+| `theme_mode` | `"auto"` | `"auto"` detects application theme signals and otherwise uses light; `"light"` and `"dark"` force a mode. |
 | `dash_theme_component_id` | `None` | Preferred persisted Dash theme component. |
 | `spinner_size_px` | `28` | Spinner width and height. |
 | `spinner_stroke_px` | `3` | Spinner stroke width. |

{dash_startup_loading_plugin-1.0.3/src/dash_startup_loading_plugin → dash_startup_loading_plugin-1.0.4}/README.md

@@ -20,7 +20,7 @@ document.
 ## Installation
 
 ```bash
-pip install "dash-startup-loading-plugin>=1.0.3"
+pip install "dash-startup-loading-plugin>=1.0.4"
 ```
 
 Dash discovers the plugin through its `dash_hooks` entry point. Installing the
@@ -75,6 +75,30 @@ app.layout = html.Main(
 )
 ```
 
+### Theme behavior
+
+With the default `theme_mode="auto"`, the startup overlay follows an explicit
+application theme from, in order, the root HTML element (including Tailwind's
+`dark`/`light` classes and common theme data attributes), a persisted Dash
+theme component, or conventional theme keys in local storage. If the
+application has not declared a theme preference, the overlay uses the light
+theme; it does not infer a preference from the operating system.
+
+Set the mode explicitly when the application does not expose its preference,
+or when the loading screen should always use one theme:
+
+```python
+configure(theme_mode="light")  # or "dark"
+```
+
+An application preference explicitly set to `"system"` or `"auto"` still
+uses `prefers-color-scheme`. Use `dash_theme_component_id` to prefer one Dash
+component when multiple persisted theme values exist:
+
+```python
+configure(theme_mode="auto", dash_theme_component_id="theme-provider")
+```
+
 ## Component-library integrations
 
 Component libraries are not dependencies of this package. Install only the
@@ -207,7 +231,7 @@ configure(pending_selector=None)
 | `dark_background` | `"#0f0f0f"` | Dark background. |
 | `color` | `"#1677ff"` | Light spinner color. |
 | `dark_color` | `"#4096ff"` | Dark spinner color. |
-| `theme_mode` | `"auto"` | `"auto"`, `"light"`, or `"dark"`. |
+| `theme_mode` | `"auto"` | `"auto"` detects application theme signals and otherwise uses light; `"light"` and `"dark"` force a mode. |
 | `dash_theme_component_id` | `None` | Preferred persisted Dash theme component. |
 | `spinner_size_px` | `28` | Spinner width and height. |
 | `spinner_stroke_px` | `3` | Spinner stroke width. |

{dash_startup_loading_plugin-1.0.3 → dash_startup_loading_plugin-1.0.4}/README.zh-CN.md

@@ -18,7 +18,7 @@
 ## 安装
 
 ```bash
-pip install "dash-startup-loading-plugin>=1.0.3"
+pip install "dash-startup-loading-plugin>=1.0.4"
 ```
 
 Dash 会通过 `dash_hooks` entry point 自动发现插件。安装后，默认 loading
@@ -72,6 +72,27 @@ app.layout = html.Main(
 )
 ```
 
+### 主题行为
+
+默认的 `theme_mode="auto"` 会按顺序读取应用显式提供的主题：HTML 根节点
+（包括 Tailwind 的 `dark`/`light` 类及常见主题 data 属性）、Dash 组件的
+持久化主题值，以及 local storage 中的常见主题键。如果应用没有声明主题
+偏好，loading 遮罩会使用亮色主题，不会根据操作系统配色自动推断。
+
+当应用没有暴露主题偏好，或 loading 页面需要固定主题时，可手动配置：
+
+```python
+configure(theme_mode="light")  # 或 "dark"
+```
+
+如果应用主题偏好明确设置为 `"system"` 或 `"auto"`，插件仍会读取
+`prefers-color-scheme`。当页面中存在多个持久化主题值时，可用
+`dash_theme_component_id` 指定优先读取的 Dash 组件：
+
+```python
+configure(theme_mode="auto", dash_theme_component_id="theme-provider")
+```
+
 ## 组件库集成
 
 各组件库不是本插件的依赖。应用只需单独安装实际使用的组件库。
@@ -198,7 +219,7 @@ configure(pending_selector=None)
 | `dark_background` | `"#0f0f0f"` | 暗色背景。 |
 | `color` | `"#1677ff"` | 亮色 spinner 颜色。 |
 | `dark_color` | `"#4096ff"` | 暗色 spinner 颜色。 |
-| `theme_mode` | `"auto"` | 可选 `"auto"`、`"light"` 或 `"dark"`。 |
+| `theme_mode` | `"auto"` | `"auto"` 自动检测应用主题，未检测到时使用亮色；`"light"` 和 `"dark"` 用于强制指定主题。 |
 | `dash_theme_component_id` | `None` | 优先读取主题状态的 Dash 持久化组件 ID。 |
 | `spinner_size_px` | `28` | Spinner 宽度和高度。 |
 | `spinner_stroke_px` | `3` | Spinner 描边宽度。 |

{dash_startup_loading_plugin-1.0.3 → dash_startup_loading_plugin-1.0.4}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "dash-startup-loading-plugin"
-version = "1.0.3"
+version = "1.0.4"
 description = "A configurable full-screen startup loading overlay for Dash apps, packaged as a Dash Hooks plugin."
 readme = "README.md"
 requires-python = ">=3.9"

{dash_startup_loading_plugin-1.0.3 → dash_startup_loading_plugin-1.0.4/src/dash_startup_loading_plugin}/README.md

@@ -20,7 +20,7 @@ document.
 ## Installation
 
 ```bash
-pip install "dash-startup-loading-plugin>=1.0.3"
+pip install "dash-startup-loading-plugin>=1.0.4"
 ```
 
 Dash discovers the plugin through its `dash_hooks` entry point. Installing the
@@ -75,6 +75,30 @@ app.layout = html.Main(
 )
 ```
 
+### Theme behavior
+
+With the default `theme_mode="auto"`, the startup overlay follows an explicit
+application theme from, in order, the root HTML element (including Tailwind's
+`dark`/`light` classes and common theme data attributes), a persisted Dash
+theme component, or conventional theme keys in local storage. If the
+application has not declared a theme preference, the overlay uses the light
+theme; it does not infer a preference from the operating system.
+
+Set the mode explicitly when the application does not expose its preference,
+or when the loading screen should always use one theme:
+
+```python
+configure(theme_mode="light")  # or "dark"
+```
+
+An application preference explicitly set to `"system"` or `"auto"` still
+uses `prefers-color-scheme`. Use `dash_theme_component_id` to prefer one Dash
+component when multiple persisted theme values exist:
+
+```python
+configure(theme_mode="auto", dash_theme_component_id="theme-provider")
+```
+
 ## Component-library integrations
 
 Component libraries are not dependencies of this package. Install only the
@@ -207,7 +231,7 @@ configure(pending_selector=None)
 | `dark_background` | `"#0f0f0f"` | Dark background. |
 | `color` | `"#1677ff"` | Light spinner color. |
 | `dark_color` | `"#4096ff"` | Dark spinner color. |
-| `theme_mode` | `"auto"` | `"auto"`, `"light"`, or `"dark"`. |
+| `theme_mode` | `"auto"` | `"auto"` detects application theme signals and otherwise uses light; `"light"` and `"dark"` force a mode. |
 | `dash_theme_component_id` | `None` | Preferred persisted Dash theme component. |
 | `spinner_size_px` | `28` | Spinner width and height. |
 | `spinner_stroke_px` | `3` | Spinner stroke width. |

{dash_startup_loading_plugin-1.0.3 → dash_startup_loading_plugin-1.0.4}/src/dash_startup_loading_plugin/README.zh-CN.md

@@ -18,7 +18,7 @@
 ## 安装
 
 ```bash
-pip install "dash-startup-loading-plugin>=1.0.3"
+pip install "dash-startup-loading-plugin>=1.0.4"
 ```
 
 Dash 会通过 `dash_hooks` entry point 自动发现插件。安装后，默认 loading
@@ -72,6 +72,27 @@ app.layout = html.Main(
 )
 ```
 
+### 主题行为
+
+默认的 `theme_mode="auto"` 会按顺序读取应用显式提供的主题：HTML 根节点
+（包括 Tailwind 的 `dark`/`light` 类及常见主题 data 属性）、Dash 组件的
+持久化主题值，以及 local storage 中的常见主题键。如果应用没有声明主题
+偏好，loading 遮罩会使用亮色主题，不会根据操作系统配色自动推断。
+
+当应用没有暴露主题偏好，或 loading 页面需要固定主题时，可手动配置：
+
+```python
+configure(theme_mode="light")  # 或 "dark"
+```
+
+如果应用主题偏好明确设置为 `"system"` 或 `"auto"`，插件仍会读取
+`prefers-color-scheme`。当页面中存在多个持久化主题值时，可用
+`dash_theme_component_id` 指定优先读取的 Dash 组件：
+
+```python
+configure(theme_mode="auto", dash_theme_component_id="theme-provider")
+```
+
 ## 组件库集成
 
 各组件库不是本插件的依赖。应用只需单独安装实际使用的组件库。
@@ -198,7 +219,7 @@ configure(pending_selector=None)
 | `dark_background` | `"#0f0f0f"` | 暗色背景。 |
 | `color` | `"#1677ff"` | 亮色 spinner 颜色。 |
 | `dark_color` | `"#4096ff"` | 暗色 spinner 颜色。 |
-| `theme_mode` | `"auto"` | 可选 `"auto"`、`"light"` 或 `"dark"`。 |
+| `theme_mode` | `"auto"` | `"auto"` 自动检测应用主题，未检测到时使用亮色；`"light"` 和 `"dark"` 用于强制指定主题。 |
 | `dash_theme_component_id` | `None` | 优先读取主题状态的 Dash 持久化组件 ID。 |
 | `spinner_size_px` | `28` | Spinner 宽度和高度。 |
 | `spinner_stroke_px` | `3` | Spinner 描边宽度。 |

{dash_startup_loading_plugin-1.0.3 → dash_startup_loading_plugin-1.0.4}/src/dash_startup_loading_plugin/__init__.py

@@ -5,7 +5,7 @@ from importlib.metadata import PackageNotFoundError, version
 try:
     __version__ = version("dash-startup-loading-plugin")
 except PackageNotFoundError:  # pragma: no cover - source tree fallback
-    __version__ = "1.0.3"
+    __version__ = "1.0.4"
 
 from .plugin import (
     StartupLoadingConfig,

{dash_startup_loading_plugin-1.0.3 → dash_startup_loading_plugin-1.0.4}/src/dash_startup_loading_plugin/resources/theme.js

@@ -92,7 +92,7 @@
         theme = dashPersistenceTheme();
     }
     if (!theme) {
-        theme = rootTheme() || dashPersistenceTheme() || conventionalStoredTheme() || "system";
+        theme = rootTheme() || dashPersistenceTheme() || conventionalStoredTheme() || "light";
     }
     if (theme === "system") {
         theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "dark" : "light";

{dash_startup_loading_plugin-1.0.3 → dash_startup_loading_plugin-1.0.4/src/dash_startup_loading_plugin.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dash-startup-loading-plugin
-Version: 1.0.3
+Version: 1.0.4
 Summary: A configurable full-screen startup loading overlay for Dash apps, packaged as a Dash Hooks plugin.
 Author-email: Ethan Zhang <ethan.zhang2016@gmail.com>
 License-Expression: MIT
@@ -34,7 +34,7 @@ document.
 ## Installation
 
 ```bash
-pip install "dash-startup-loading-plugin>=1.0.3"
+pip install "dash-startup-loading-plugin>=1.0.4"
 ```
 
 Dash discovers the plugin through its `dash_hooks` entry point. Installing the
@@ -89,6 +89,30 @@ app.layout = html.Main(
 )
 ```
 
+### Theme behavior
+
+With the default `theme_mode="auto"`, the startup overlay follows an explicit
+application theme from, in order, the root HTML element (including Tailwind's
+`dark`/`light` classes and common theme data attributes), a persisted Dash
+theme component, or conventional theme keys in local storage. If the
+application has not declared a theme preference, the overlay uses the light
+theme; it does not infer a preference from the operating system.
+
+Set the mode explicitly when the application does not expose its preference,
+or when the loading screen should always use one theme:
+
+```python
+configure(theme_mode="light")  # or "dark"
+```
+
+An application preference explicitly set to `"system"` or `"auto"` still
+uses `prefers-color-scheme`. Use `dash_theme_component_id` to prefer one Dash
+component when multiple persisted theme values exist:
+
+```python
+configure(theme_mode="auto", dash_theme_component_id="theme-provider")
+```
+
 ## Component-library integrations
 
 Component libraries are not dependencies of this package. Install only the
@@ -221,7 +245,7 @@ configure(pending_selector=None)
 | `dark_background` | `"#0f0f0f"` | Dark background. |
 | `color` | `"#1677ff"` | Light spinner color. |
 | `dark_color` | `"#4096ff"` | Dark spinner color. |
-| `theme_mode` | `"auto"` | `"auto"`, `"light"`, or `"dark"`. |
+| `theme_mode` | `"auto"` | `"auto"` detects application theme signals and otherwise uses light; `"light"` and `"dark"` force a mode. |
 | `dash_theme_component_id` | `None` | Preferred persisted Dash theme component. |
 | `spinner_size_px` | `28` | Spinner width and height. |
 | `spinner_stroke_px` | `3` | Spinner stroke width. |

{dash_startup_loading_plugin-1.0.3 → dash_startup_loading_plugin-1.0.4}/tests/test_documentation.py

@@ -28,6 +28,9 @@ def test_readmes_use_current_selector_and_installation_examples():
         assert "usage-sidebar-menu" not in readme
         assert "dash-ant-design  # Python 3.10+" not in readme
         assert "feffery-antd-components>=0.4.0" not in readme
+        assert 'theme_mode="auto"' in readme
+        assert 'theme_mode="light"' in readme
+        assert "dash_theme_component_id" in readme
 
 
 def test_readmes_link_to_each_other():

{dash_startup_loading_plugin-1.0.3 → dash_startup_loading_plugin-1.0.4}/tests/test_plugin.py

@@ -211,6 +211,22 @@ def test_theme_bootstrap_supports_dash_tailwind_and_mantine_conventions():
     assert 'name === "system" || name === "auto"' in script
 
 
+def test_theme_bootstrap_defaults_to_light_without_an_app_preference():
+    script = (
+        files("dash_startup_loading_plugin")
+        .joinpath("resources/theme.js")
+        .read_text(encoding="utf-8")
+    )
+
+    assert (
+        'rootTheme() || dashPersistenceTheme() || conventionalStoredTheme() || "light"'
+        in script
+    )
+    assert 'conventionalStoredTheme() || "system"' not in script
+    assert 'theme === "system"' in script
+    assert 'matchMedia("(prefers-color-scheme: dark)")' in script
+
+
 def test_theme_bootstrap_serializes_component_id_and_explicit_mode():
     configure(theme_mode="dark", dash_theme_component_id="theme-provider")