ex4nicegui 0.4.6__tar.gz → 0.4.7__tar.gz

{ex4nicegui-0.4.6 → ex4nicegui-0.4.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ex4nicegui
-Version: 0.4.6
+Version: 0.4.7
 Summary: ...
 Home-page: 
 Author: carson_jia

{ex4nicegui-0.4.6 → ex4nicegui-0.4.7}/README.md

@@ -159,6 +159,93 @@ ui.run()
 ```
 
 
+## 组件功能
+
+### 绑定类名
+
+所有的组件类提供 `bind_classes` 用于绑定 `class`，支持三种不同的数据结构。
+
+绑定字典
+
+```python
+bg_color = to_ref(False)
+has_error = to_ref(False)
+
+rxui.label("test").bind_classes({"bg-blue": bg_color, "text-red": has_error})
+
+rxui.switch("bg_color", value=bg_color)
+rxui.switch("has_error", value=has_error)
+```
+
+字典键值为类名,对应值为 bool 的响应式变量。当响应式值为 `True`，类名应用到组件 class
+
+
+---
+
+绑定返回值为字典的响应式变量
+
+```python
+bg_color = to_ref(False)
+has_error = to_ref(False)
+
+class_obj = ref_computed(
+    lambda: {"bg-blue": bg_color.value, "text-red": has_error.value}
+)
+
+rxui.switch("bg_color", value=bg_color)
+rxui.switch("has_error", value=has_error)
+rxui.label("bind to ref_computed").bind_classes(class_obj)
+```
+
+---
+
+绑定为列表
+
+```python
+bg_color = to_ref("red")
+bg_color_class = ref_computed(lambda: f"bg-{bg_color.value}")
+
+text_color = to_ref("green")
+text_color_class = ref_computed(lambda: f"text-{text_color.value}")
+
+rxui.select(["red", "green", "yellow"], label="bg color", value=bg_color)
+rxui.select(["red", "green", "yellow"], label="text color", value=text_color)
+
+rxui.label("binding to arrays").bind_classes([bg_color_class, text_color_class])
+
+```
+
+列表中每个元素为返回类名的响应式变量
+
+---
+
+### bind-style
+
+```python
+from nicegui import ui
+from ex4nicegui.reactive import rxui
+from ex4nicegui.utils.signals import to_ref
+
+
+bg_color = to_ref("blue")
+text_color = to_ref("red")
+
+rxui.label("test").bind_style(
+    {
+        "background-color": bg_color,
+        "color": text_color,
+    }
+)
+
+rxui.select(["blue", "green", "yellow"], label="bg color", value=bg_color)
+rxui.select(["red", "green", "yellow"], label="text color", value=text_color)
+```
+
+`bind_style` 传入字典，`key` 为样式名字，`value` 为样式值，响应式字符串
+
+
+---
+
 ## 响应式
 
 ```python
@@ -174,6 +261,8 @@ from ex4nicegui import (
 ```
 常用 `to_ref`,`effect`,`ref_computed`,`on`
 
+---
+
 ### `to_ref`
 定义响应式对象,通过 `.value` 读写
 ```python
@@ -186,6 +275,8 @@ b.value = 'new text'
 print(a.value)
 ```
 
+---
+
 ### `effect`
 接受一个函数,自动监控函数中使用到的响应式对象变化,从而自动执行函数
 
@@ -209,6 +300,7 @@ ui.button("change", on_click=change_value)
 
 首次执行 effect ,函数`auto_run_when_ref_value`将被执行一次.之后点击按钮,改变 `a` 的值(通过 `a.value`),函数`auto_run_when_ref_value`再次执行
 
+---
 
 ### `ref_computed`
 与 `effect` 具备一样的功能，`ref_computed` 还能从函数中返回结果。一般用于从 `to_ref` 中进行二次计算
@@ -234,6 +326,8 @@ ui.button("change", on_click=change_value)
 
 > `ref_computed` 是只读的 `to_ref`
 
+---
+
 ### `on`
 类似 `effect` 的功能,但是 `on` 需要明确指定监控的响应式对象
 
@@ -281,6 +375,7 @@ ui.button("change b", on_click=change_b)
 
 - 参数 `onchanges` 为 True 时(默认值为 False),指定的函数不会在绑定时执行 
 
+---
 
 ## BI 模块
 

{ex4nicegui-0.4.6 → ex4nicegui-0.4.7}/ex4nicegui/__init__.py

@@ -19,4 +19,4 @@ from ex4nicegui.experimental_ import (
 )
 
 
-__version__ = "0.4.6"
+__version__ = "0.4.7"

{ex4nicegui-0.4.6 → ex4nicegui-0.4.7}/ex4nicegui/bi/index.py

@@ -10,7 +10,7 @@ _TData = TypeVar("_TData")
 def data_source(data: Union[Callable[..., _TData], _TData]) -> DataSourceFacade[_TData]:
     """Create a data source
 
-    @see - https://github.com/CrystalWindSnake/ex4nicegui/blob/docs/apis/README.en.md#bidata_source
+    @see - https://github.com/CrystalWindSnake/ex4nicegui/blob/main/README.en.md#bidata_source
     @中文文档 - https://gitee.com/carson_add/ex4nicegui/tree/main/#bidata_source
 
     Args:

{ex4nicegui-0.4.6 → ex4nicegui-0.4.7}/ex4nicegui/reactive/officials/base.py

@@ -3,12 +3,13 @@ from __future__ import annotations
 from typing import (
     Any,
     Callable,
+    Dict,
     List,
     Optional,
     TypeVar,
     Generic,
+    Union,
     cast,
-    overload,
 )
 from typing_extensions import Self
 from ex4nicegui.utils.signals import (
@@ -18,6 +19,10 @@ from ex4nicegui.utils.signals import (
     ref_computed,
     _TMaybeRef as TMaybeRef,
     effect,
+    to_value,
+    is_ref,
+    on,
+    signe_utils,
 )
 from nicegui import Tailwind, ui
 from nicegui.elements.mixins.color_elements import (
@@ -26,11 +31,22 @@ from nicegui.elements.mixins.color_elements import (
     TAILWIND_COLORS,
 )
 from nicegui.elements.mixins.text_element import TextElement
+from nicegui.elements.mixins.disableable_element import DisableableElement
+
 
 T = TypeVar("T")
 
 TWidget = TypeVar("TWidget", bound=ui.element)
 
+_T_bind_classes_type_dict = Dict[str, TMaybeRef[bool]]
+_T_bind_classes_type_ref_dict = ReadonlyRef[Dict[str, bool]]
+_T_bind_classes_type_array = List[Union[ReadonlyRef[str], Ref[str]]]
+
+
+_T_bind_classes_type = Union[
+    _T_bind_classes_type_dict, _T_bind_classes_type_ref_dict, _T_bind_classes_type_array
+]
+
 
 class BindableUi(Generic[TWidget]):
     def __init__(self, element: TWidget) -> None:
@@ -144,6 +160,68 @@ class BindableUi(Generic[TWidget]):
     def clear(self) -> None:
         cast(ui.element, self.element).clear()
 
+    def bind_classes(self, classes: _T_bind_classes_type):
+        """data binding is manipulating an element's class list
+
+        @see - https://github.com/CrystalWindSnake/ex4nicegui/blob/main/README.en.md#bind-class-names
+        @中文文档 - https://gitee.com/carson_add/ex4nicegui/tree/main/#%E7%BB%91%E5%AE%9A%E7%B1%BB%E5%90%8D
+
+        Args:
+            classes (_T_bind_classes_type):
+        """
+        if isinstance(classes, dict):
+            for name, ref_obj in classes.items():
+
+                @effect
+                def _(name=name, ref_obj=ref_obj):
+                    if to_value(ref_obj):
+                        self.classes(add=name)
+                    else:
+                        self.classes(remove=name)
+
+        elif isinstance(classes, (Ref, ReadonlyRef)):
+            ref_obj = to_value(classes)
+            assert isinstance(ref_obj, dict)
+
+            @effect
+            def _():
+                for name, value in to_value(classes).items():
+                    if value:
+                        self.classes(add=name)
+                    else:
+                        self.classes(remove=name)
+        elif isinstance(classes, list):
+            for ref_name in classes:
+                if is_ref(ref_name):
+
+                    @on(ref_name)
+                    def _(state: signe_utils.WatchedState):
+                        self.classes(add=state.current, remove=state.previous)
+                else:
+                    self.classes(ref_name)  # type: ignore
+
+        return self
+
+    def bind_style(self, style: Dict[str, Union[ReadonlyRef[str], Ref[str]]]):
+        """data binding is manipulating an element's style
+
+        @see - https://github.com/CrystalWindSnake/ex4nicegui/blob/main/README.en.md#bind-style
+        @中文文档 - https://gitee.com/carson_add/ex4nicegui/tree/main/#bind-style
+
+        Args:
+            style (Dict[str, Union[ReadonlyRef[str], Ref[str]]]): _description_
+        """
+        if isinstance(style, dict):
+            for name, ref_obj in style.items():
+                if is_ref(ref_obj):
+
+                    @effect
+                    def _(name=name, ref_obj=ref_obj):
+                        self.element._style[name] = ref_obj.value
+                        self.element.update()
+
+        return self
+
 
 class SingleValueBindableUi(BindableUi[TWidget], Generic[T, TWidget]):
     def __init__(self, value: TMaybeRef[T], element: TWidget) -> None:
@@ -162,9 +240,6 @@ class SingleValueBindableUi(BindableUi[TWidget], Generic[T, TWidget]):
         return self
 
 
-from nicegui.elements.mixins.disableable_element import DisableableElement
-
-
 _T_DisableableBinder = TypeVar("_T_DisableableBinder", bound=DisableableElement)
 
 

{ex4nicegui-0.4.6 → ex4nicegui-0.4.7}/ex4nicegui/utils/signals.py

@@ -96,7 +96,7 @@ def to_value(maybe_ref: _TMaybeRef[T]) -> T:
 def to_ref(maybe_ref: _TMaybeRef[T]):
     """Takes an inner value and returns a reactive and mutable ref object, which has a single property .value that points to the inner value.
 
-    @see - https://github.com/CrystalWindSnake/ex4nicegui/blob/docs/apis/README.en.md#to_ref
+    @see - https://github.com/CrystalWindSnake/ex4nicegui/blob/main/README.en.md#to_ref
     @中文文档 - https://gitee.com/carson_add/ex4nicegui/tree/main/#to_ref
 
 
@@ -141,7 +141,7 @@ def effect(
 ) -> signe_utils._TEffect_Fn[None]:
     """Runs a function immediately while reactively tracking its dependencies and re-runs it whenever the dependencies are changed.
 
-    @see - https://github.com/CrystalWindSnake/ex4nicegui/blob/docs/apis/README.en.md#effect
+    @see - https://github.com/CrystalWindSnake/ex4nicegui/blob/main/README.en.md#effect
     @中文文档 - https://gitee.com/carson_add/ex4nicegui/tree/main/#effect
 
 
@@ -192,7 +192,7 @@ def ref_computed(
 ) -> ReadonlyRef[T]:
     """Takes a getter function and returns a readonly reactive ref object for the returned value from the getter. It can also take an object with get and set functions to create a writable ref object.
 
-    @see - https://github.com/CrystalWindSnake/ex4nicegui/blob/docs/apis/README.en.md#ref_computed
+    @see - https://github.com/CrystalWindSnake/ex4nicegui/blob/main/README.en.md#ref_computed
     @中文文档 - https://gitee.com/carson_add/ex4nicegui/tree/main/#ref_computed
 
 
@@ -291,7 +291,7 @@ def on(
 ):
     """Watches one or more reactive data sources and invokes a callback function when the sources change.
 
-    @see - https://github.com/CrystalWindSnake/ex4nicegui/blob/docs/apis/README.en.md#on
+    @see - https://github.com/CrystalWindSnake/ex4nicegui/blob/main/README.en.md#on
     @中文文档 - https://gitee.com/carson_add/ex4nicegui/tree/main/#on
 
 

{ex4nicegui-0.4.6 → ex4nicegui-0.4.7}/ex4nicegui.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ex4nicegui
-Version: 0.4.6
+Version: 0.4.7
 Summary: ...
 Home-page: 
 Author: carson_jia

{ex4nicegui-0.4.6 → ex4nicegui-0.4.7}/ex4nicegui.egg-info/requires.txt

@@ -1,3 +1,3 @@
-signe>=0.2.5
+signe>=0.2.6
 nicegui>=1.4.0
 typing_extensions

{ex4nicegui-0.4.6 → ex4nicegui-0.4.7}/setup.py

@@ -21,7 +21,7 @@ def get_data_files(base):
 with open("README.md", encoding="utf8") as readme_file:
     readme = readme_file.read()
 
-requirements = ["signe>=0.2.5", "nicegui>=1.4.0", "typing_extensions"]
+requirements = ["signe>=0.2.6", "nicegui>=1.4.0", "typing_extensions"]
 
 test_requirements = ["pytest>=3", "playwright", "pandas"]