reflex 0.4.9a1__py3-none-any.whl → 0.5.0__py3-none-any.whl

reflex/components/sonner/toast.py

@@ -0,0 +1,267 @@
+"""Sonner toast component."""
+
+from __future__ import annotations
+
+from typing import Literal
+
+from reflex.base import Base
+from reflex.components.component import Component, ComponentNamespace
+from reflex.components.lucide.icon import Icon
+from reflex.event import EventSpec, call_script
+from reflex.style import Style, color_mode
+from reflex.utils import format
+from reflex.utils.imports import ImportVar
+from reflex.utils.serializers import serialize
+from reflex.vars import Var, VarData
+
+LiteralPosition = Literal[
+    "top-left",
+    "top-center",
+    "top-right",
+    "bottom-left",
+    "bottom-center",
+    "bottom-right",
+]
+
+
+toast_ref = Var.create_safe("refs['__toast']")
+
+
+class PropsBase(Base):
+    """Base class for all props classes."""
+
+    def json(self) -> str:
+        """Convert the object to a json string.
+
+        Returns:
+            The object as a json string.
+        """
+        from reflex.utils.serializers import serialize
+
+        return self.__config__.json_dumps(
+            {format.to_camel_case(key): value for key, value in self.dict().items()},
+            default=serialize,
+        )
+
+
+class ToastProps(PropsBase):
+    """Props for the toast component."""
+
+    # Toast's description, renders underneath the title.
+    description: str = ""
+
+    # Whether to show the close button.
+    close_button: bool = False
+
+    # Dark toast in light mode and vice versa.
+    invert: bool = False
+
+    # Control the sensitivity of the toast for screen readers
+    important: bool = False
+
+    # Time in milliseconds that should elapse before automatically closing the toast.
+    duration: int = 4000
+
+    # Position of the toast.
+    position: LiteralPosition = "bottom-right"
+
+    # If false, it'll prevent the user from dismissing the toast.
+    dismissible: bool = True
+
+    # TODO: fix serialization of icons for toast? (might not be possible yet)
+    # Icon displayed in front of toast's text, aligned vertically.
+    # icon: Optional[Icon] = None
+
+    # TODO: fix implementation for action / cancel buttons
+    # Renders a primary button, clicking it will close the toast.
+    # action: str = ""
+
+    # Renders a secondary button, clicking it will close the toast.
+    # cancel: str = ""
+
+    # Custom id for the toast.
+    id: str = ""
+
+    # Removes the default styling, which allows for easier customization.
+    unstyled: bool = False
+
+    # Custom style for the toast.
+    style: Style = Style()
+
+    # Custom style for the toast primary button.
+    # action_button_styles: Style = Style()
+
+    # Custom style for the toast secondary button.
+    # cancel_button_styles: Style = Style()
+
+
+class Toaster(Component):
+    """A Toaster Component for displaying toast notifications."""
+
+    library = "sonner@1.4.41"
+
+    tag = "Toaster"
+
+    # the theme of the toast
+    theme: Var[str] = color_mode
+
+    # whether to show rich colors
+    rich_colors: Var[bool] = Var.create_safe(True)
+
+    # whether to expand the toast
+    expand: Var[bool] = Var.create_safe(True)
+
+    # the number of toasts that are currently visible
+    visible_toasts: Var[int]
+
+    # the position of the toast
+    position: Var[LiteralPosition] = Var.create_safe("bottom-right")
+
+    # whether to show the close button
+    close_button: Var[bool] = Var.create_safe(False)
+
+    # offset of the toast
+    offset: Var[str]
+
+    # directionality of the toast (default: ltr)
+    dir: Var[str]
+
+    # Keyboard shortcut that will move focus to the toaster area.
+    hotkey: Var[str]
+
+    # Dark toasts in light mode and vice versa.
+    invert: Var[bool]
+
+    # These will act as default options for all toasts. See toast() for all available options.
+    toast_options: Var[ToastProps]
+
+    # Gap between toasts when expanded
+    gap: Var[int]
+
+    # Changes the default loading icon
+    loading_icon: Var[Icon]
+
+    # Pauses toast timers when the page is hidden, e.g., when the tab is backgrounded, the browser is minimized, or the OS is locked.
+    pause_when_page_is_hidden: Var[bool]
+
+    def _get_hooks(self) -> Var[str]:
+        hook = Var.create_safe(f"{toast_ref} = toast", _var_is_local=True)
+        hook._var_data = VarData(  # type: ignore
+            imports={
+                "/utils/state": [ImportVar(tag="refs")],
+                self.library: [ImportVar(tag="toast", install=False)],
+            }
+        )
+        return hook
+
+    @staticmethod
+    def send_toast(message: str, level: str | None = None, **props) -> EventSpec:
+        """Send a toast message.
+
+        Args:
+            message: The message to display.
+            level: The level of the toast.
+            **props: The options for the toast.
+
+        Returns:
+            The toast event.
+        """
+        toast_command = f"{toast_ref}.{level}" if level is not None else toast_ref
+        if props:
+            args = serialize(ToastProps(**props))
+            toast = f"{toast_command}(`{message}`, {args})"
+        else:
+            toast = f"{toast_command}(`{message}`)"
+
+        toast_action = Var.create(toast, _var_is_string=False, _var_is_local=True)
+        return call_script(toast_action)  # type: ignore
+
+    @staticmethod
+    def toast_info(message: str, **kwargs):
+        """Display an info toast message.
+
+        Args:
+            message: The message to display.
+            kwargs: Additional toast props.
+
+        Returns:
+            The toast event.
+        """
+        return Toaster.send_toast(message, level="info", **kwargs)
+
+    @staticmethod
+    def toast_warning(message: str, **kwargs):
+        """Display a warning toast message.
+
+        Args:
+            message: The message to display.
+            kwargs: Additional toast props.
+
+        Returns:
+            The toast event.
+        """
+        return Toaster.send_toast(message, level="warning", **kwargs)
+
+    @staticmethod
+    def toast_error(message: str, **kwargs):
+        """Display an error toast message.
+
+        Args:
+            message: The message to display.
+            kwargs: Additional toast props.
+
+        Returns:
+            The toast event.
+        """
+        return Toaster.send_toast(message, level="error", **kwargs)
+
+    @staticmethod
+    def toast_success(message: str, **kwargs):
+        """Display a success toast message.
+
+        Args:
+            message: The message to display.
+            kwargs: Additional toast props.
+
+        Returns:
+            The toast event.
+        """
+        return Toaster.send_toast(message, level="success", **kwargs)
+
+    def toast_dismiss(self, id: str | None):
+        """Dismiss a toast.
+
+        Args:
+            id: The id of the toast to dismiss.
+
+        Returns:
+            The toast dismiss event.
+        """
+        if id is None:
+            dismiss = f"{toast_ref}.dismiss()"
+        else:
+            dismiss = f"{toast_ref}.dismiss({id})"
+        dismiss_action = Var.create(dismiss, _var_is_string=False, _var_is_local=True)
+        return call_script(dismiss_action)  # type: ignore
+
+
+# TODO: figure out why loading toast stay open forever
+# def toast_loading(message: str, **kwargs):
+#     return _toast(message, level="loading", **kwargs)
+
+
+class ToastNamespace(ComponentNamespace):
+    """Namespace for toast components."""
+
+    provider = staticmethod(Toaster.create)
+    options = staticmethod(ToastProps)
+    info = staticmethod(Toaster.toast_info)
+    warning = staticmethod(Toaster.toast_warning)
+    error = staticmethod(Toaster.toast_error)
+    success = staticmethod(Toaster.toast_success)
+    dismiss = staticmethod(Toaster.toast_dismiss)
+    # loading = staticmethod(toast_loading)
+    __call__ = staticmethod(Toaster.send_toast)
+
+
+toast = ToastNamespace()

reflex/components/sonner/toast.pyi

@@ -0,0 +1,205 @@
+"""Stub file for reflex/components/sonner/toast.py"""
+# ------------------- DO NOT EDIT ----------------------
+# This file was generated by `reflex/utils/pyi_generator.py`!
+# ------------------------------------------------------
+
+from typing import Any, Dict, Literal, Optional, Union, overload
+from reflex.vars import Var, BaseVar, ComputedVar
+from reflex.event import EventChain, EventHandler, EventSpec
+from reflex.style import Style
+from typing import Literal
+from reflex.base import Base
+from reflex.components.component import Component, ComponentNamespace
+from reflex.components.lucide.icon import Icon
+from reflex.event import EventSpec, call_script
+from reflex.style import Style, color_mode
+from reflex.utils import format
+from reflex.utils.imports import ImportVar
+from reflex.utils.serializers import serialize
+from reflex.vars import Var, VarData
+
+LiteralPosition = Literal[
+    "top-left",
+    "top-center",
+    "top-right",
+    "bottom-left",
+    "bottom-center",
+    "bottom-right",
+]
+toast_ref = Var.create_safe("refs['__toast']")
+
+class PropsBase(Base):
+    def json(self) -> str: ...
+
+class ToastProps(PropsBase):
+    description: str
+    close_button: bool
+    invert: bool
+    important: bool
+    duration: int
+    position: LiteralPosition
+    dismissible: bool
+    id: str
+    unstyled: bool
+    style: Style
+
+class Toaster(Component):
+    @staticmethod
+    def send_toast(message: str, level: str | None = None, **props) -> EventSpec: ...
+    @staticmethod
+    def toast_info(message: str, **kwargs): ...
+    @staticmethod
+    def toast_warning(message: str, **kwargs): ...
+    @staticmethod
+    def toast_error(message: str, **kwargs): ...
+    @staticmethod
+    def toast_success(message: str, **kwargs): ...
+    def toast_dismiss(self, id: str | None): ...
+    @overload
+    @classmethod
+    def create(  # type: ignore
+        cls,
+        *children,
+        theme: Optional[Union[Var[str], str]] = None,
+        rich_colors: Optional[Union[Var[bool], bool]] = None,
+        expand: Optional[Union[Var[bool], bool]] = None,
+        visible_toasts: Optional[Union[Var[int], int]] = None,
+        position: Optional[
+            Union[
+                Var[
+                    Literal[
+                        "top-left",
+                        "top-center",
+                        "top-right",
+                        "bottom-left",
+                        "bottom-center",
+                        "bottom-right",
+                    ]
+                ],
+                Literal[
+                    "top-left",
+                    "top-center",
+                    "top-right",
+                    "bottom-left",
+                    "bottom-center",
+                    "bottom-right",
+                ],
+            ]
+        ] = None,
+        close_button: Optional[Union[Var[bool], bool]] = None,
+        offset: Optional[Union[Var[str], str]] = None,
+        dir: Optional[Union[Var[str], str]] = None,
+        hotkey: Optional[Union[Var[str], str]] = None,
+        invert: Optional[Union[Var[bool], bool]] = None,
+        toast_options: Optional[Union[Var[ToastProps], ToastProps]] = None,
+        gap: Optional[Union[Var[int], int]] = None,
+        loading_icon: Optional[Union[Var[Icon], Icon]] = None,
+        pause_when_page_is_hidden: Optional[Union[Var[bool], bool]] = None,
+        style: Optional[Style] = None,
+        key: Optional[Any] = None,
+        id: Optional[Any] = None,
+        class_name: Optional[Any] = None,
+        autofocus: Optional[bool] = None,
+        custom_attrs: Optional[Dict[str, Union[Var, str]]] = None,
+        on_blur: Optional[
+            Union[EventHandler, EventSpec, list, function, BaseVar]
+        ] = None,
+        on_click: Optional[
+            Union[EventHandler, EventSpec, list, function, BaseVar]
+        ] = None,
+        on_context_menu: Optional[
+            Union[EventHandler, EventSpec, list, function, BaseVar]
+        ] = None,
+        on_double_click: Optional[
+            Union[EventHandler, EventSpec, list, function, BaseVar]
+        ] = None,
+        on_focus: Optional[
+            Union[EventHandler, EventSpec, list, function, BaseVar]
+        ] = None,
+        on_mount: Optional[
+            Union[EventHandler, EventSpec, list, function, BaseVar]
+        ] = None,
+        on_mouse_down: Optional[
+            Union[EventHandler, EventSpec, list, function, BaseVar]
+        ] = None,
+        on_mouse_enter: Optional[
+            Union[EventHandler, EventSpec, list, function, BaseVar]
+        ] = None,
+        on_mouse_leave: Optional[
+            Union[EventHandler, EventSpec, list, function, BaseVar]
+        ] = None,
+        on_mouse_move: Optional[
+            Union[EventHandler, EventSpec, list, function, BaseVar]
+        ] = None,
+        on_mouse_out: Optional[
+            Union[EventHandler, EventSpec, list, function, BaseVar]
+        ] = None,
+        on_mouse_over: Optional[
+            Union[EventHandler, EventSpec, list, function, BaseVar]
+        ] = None,
+        on_mouse_up: Optional[
+            Union[EventHandler, EventSpec, list, function, BaseVar]
+        ] = None,
+        on_scroll: Optional[
+            Union[EventHandler, EventSpec, list, function, BaseVar]
+        ] = None,
+        on_unmount: Optional[
+            Union[EventHandler, EventSpec, list, function, BaseVar]
+        ] = None,
+        **props
+    ) -> "Toaster":
+        """Create the component.
+
+        Args:
+            *children: The children of the component.
+            theme: the theme of the toast
+            rich_colors: whether to show rich colors
+            expand: whether to expand the toast
+            visible_toasts: the number of toasts that are currently visible
+            position: the position of the toast
+            close_button: whether to show the close button
+            offset: offset of the toast
+            dir: directionality of the toast (default: ltr)
+            hotkey: Keyboard shortcut that will move focus to the toaster area.
+            invert: Dark toasts in light mode and vice versa.
+            toast_options: These will act as default options for all toasts. See toast() for all available options.
+            gap: Gap between toasts when expanded
+            loading_icon: Changes the default loading icon
+            pause_when_page_is_hidden: Pauses toast timers when the page is hidden, e.g., when the tab is backgrounded, the browser is minimized, or the OS is locked.
+            style: The style of the component.
+            key: A unique key for the component.
+            id: The id for the component.
+            class_name: The class name for the component.
+            autofocus: Whether the component should take the focus once the page is loaded
+            custom_attrs: custom attribute
+            **props: The props of the component.
+
+        Returns:
+            The component.
+        """
+        ...
+
+class ToastNamespace(ComponentNamespace):
+    provider = staticmethod(Toaster.create)
+    options = staticmethod(ToastProps)
+    info = staticmethod(Toaster.toast_info)
+    warning = staticmethod(Toaster.toast_warning)
+    error = staticmethod(Toaster.toast_error)
+    success = staticmethod(Toaster.toast_success)
+    dismiss = staticmethod(Toaster.toast_dismiss)
+
+    @staticmethod
+    def __call__(message: str, level: Optional[str], **props) -> "Optional[EventSpec]":
+        """Send a toast message.
+
+        Args:
+            message: The message to display.
+            level: The level of the toast.
+            **props: The options for the toast.
+
+        Returns:
+            The toast event.
+        """
+        ...
+
+toast = ToastNamespace()

reflex/components/tags/iter_tag.py

@@ -2,7 +2,7 @@
 from __future__ import annotations
 
 import inspect
-from typing import TYPE_CHECKING, Any, Callable, List, Type
+from typing import TYPE_CHECKING, Any, Callable, List, Tuple, Type, Union, get_args
 
 from reflex.components.tags.tag import Tag
 from reflex.vars import BaseVar, Var
@@ -33,11 +33,14 @@ class IterTag(Tag):
             The type of the iterable var.
         """
         try:
-            return (
-                self.iterable._var_type
-                if self.iterable._var_type.mro()[0] == dict
-                else self.iterable._var_type.__args__[0]
-            )
+            if self.iterable._var_type.mro()[0] == dict:
+                # Arg is a tuple of (key, value).
+                return Tuple[get_args(self.iterable._var_type)]  # type: ignore
+            elif self.iterable._var_type.mro()[0] == tuple:
+                # Arg is a union of any possible values in the tuple.
+                return Union[get_args(self.iterable._var_type)]  # type: ignore
+            else:
+                return get_args(self.iterable._var_type)[0]
         except Exception:
             return Any
 

reflex/config.py

@@ -6,16 +6,10 @@ import importlib
 import os
 import sys
 import urllib.parse
-from typing import TYPE_CHECKING, Any, Dict, List, Optional, Set
+from typing import Any, Dict, List, Optional, Set
 
 try:
-    # TODO The type checking guard can be removed once
-    # reflex-hosting-cli tools are compatible with pydantic v2
-
-    if not TYPE_CHECKING:
-        import pydantic.v1 as pydantic
-    else:
-        raise ModuleNotFoundError
+    import pydantic.v1 as pydantic
 except ModuleNotFoundError:
     import pydantic
 
@@ -135,29 +129,47 @@ class DBConfig(Base):
 
 
 class Config(Base):
-    """A Reflex config."""
+    """The config defines runtime settings for the app.
+
+    By default, the config is defined in an `rxconfig.py` file in the root of the app.
+
+    ```python
+    # rxconfig.py
+    import reflex as rx
+
+    config = rx.Config(
+        app_name="myapp",
+        api_url="http://localhost:8000",
+    )
+    ```
+
+    Every config value can be overridden by an environment variable with the same name in uppercase.
+    For example, `db_url` can be overridden by setting the `DB_URL` environment variable.
+
+    See the [configuration](https://reflex.dev/docs/getting-started/configuration/) docs for more info.
+    """
 
     class Config:
         """Pydantic config for the config."""
 
         validate_assignment = True
 
-    # The name of the app.
+    # The name of the app (should match the name of the app directory).
     app_name: str
 
     # The log level to use.
     loglevel: constants.LogLevel = constants.LogLevel.INFO
 
-    # The port to run the frontend on.
+    # The port to run the frontend on. NOTE: When running in dev mode, the next available port will be used if this is taken.
     frontend_port: int = 3000
 
-    # The path to run the frontend on.
+    # The path to run the frontend on. For example, "/app" will run the frontend on http://localhost:3000/app
     frontend_path: str = ""
 
-    # The port to run the backend on.
+    # The port to run the backend on. NOTE: When running in dev mode, the next available port will be used if this is taken.
     backend_port: int = 8000
 
-    # The backend url the frontend will connect to.
+    # The backend url the frontend will connect to. This must be updated if the backend is hosted elsewhere, or in production.
     api_url: str = f"http://localhost:{backend_port}"
 
     # The url the frontend will be hosted on.
@@ -166,10 +178,10 @@ class Config(Base):
     # The url the backend will be hosted on.
     backend_host: str = "0.0.0.0"
 
-    # The database url.
+    # The database url used by rx.Model.
     db_url: Optional[str] = "sqlite:///reflex.db"
 
-    # The redis url.
+    # The redis url
     redis_url: Optional[str] = None
 
     # Telemetry opt-in.
@@ -190,9 +202,6 @@ class Config(Base):
     # Whether to enable or disable nextJS gzip compression.
     next_compression: bool = True
 
-    # The event namespace for ws connection
-    event_namespace: Optional[str] = None
-
     # Additional frontend packages to install.
     frontend_packages: List[str] = []
 
@@ -216,9 +225,6 @@ class Config(Base):
         """
         super().__init__(*args, **kwargs)
 
-        # Check for deprecated values.
-        self.check_deprecated_values(**kwargs)
-
         # Update the config from environment variables.
         env_kwargs = self.update_from_env()
         for key, env_value in env_kwargs.items():
@@ -238,29 +244,8 @@ class Config(Base):
         """
         return ".".join([self.app_name, self.app_name])
 
-    @staticmethod
-    def check_deprecated_values(**kwargs):
-        """Check for deprecated config values.
-
-        Args:
-            **kwargs: The kwargs passed to the config.
-
-        Raises:
-            ValueError: If a deprecated config value is found.
-        """
-        if "db_config" in kwargs:
-            raise ValueError("db_config is deprecated - use db_url instead")
-        if "admin_dash" in kwargs:
-            raise ValueError(
-                "admin_dash is deprecated in the config - pass it as a param to rx.App instead"
-            )
-        if "env_path" in kwargs:
-            raise ValueError(
-                "env_path is deprecated - use environment variables instead"
-            )
-
     def update_from_env(self) -> dict[str, Any]:
-        """Update the config from environment variables.
+        """Update the config values based on set environment variables.
 
         Returns:
             The updated config values.
@@ -300,20 +285,11 @@ class Config(Base):
         return updated_values
 
     def get_event_namespace(self) -> str:
-        """Get the websocket event namespace.
+        """Get the path that the backend Websocket server lists on.
 
         Returns:
             The namespace for websocket.
         """
-        if self.event_namespace:
-            console.deprecate(
-                feature_name="Passing event_namespace in the config",
-                reason="",
-                deprecation_version="0.3.5",
-                removal_version="0.5.0",
-            )
-            return f'/{self.event_namespace.strip("/")}'
-
         event_url = constants.Endpoint.EVENT.get_url()
         return urllib.parse.urlsplit(event_url).path
 

reflex/constants/__init__.py

@@ -4,7 +4,6 @@ from .base import (
     COOKIES,
     ENV_MODE_ENV_VAR,
     IS_WINDOWS,
-    IS_WINDOWS_BUN_SUPPORTED_MACHINE,  # type: ignore
     LOCAL_STORAGE,
     POLLING_MAX_HTTP_BUFFER_SIZE,
     PYTEST_CURRENT_TEST,
@@ -87,7 +86,6 @@ __ALL__ = [
     Hooks,
     Imports,
     IS_WINDOWS,
-    IS_WINDOWS_BUN_SUPPORTED_MACHINE,
     LOCAL_STORAGE,
     LogLevel,
     MemoizationDisposition,

reflex/constants/base.py

@@ -11,11 +11,6 @@ from types import SimpleNamespace
 from platformdirs import PlatformDirs
 
 IS_WINDOWS = platform.system() == "Windows"
-# https://github.com/oven-sh/bun/blob/main/src/cli/install.ps1
-IS_WINDOWS_BUN_SUPPORTED_MACHINE = IS_WINDOWS and platform.machine() in [
-    "AMD64",
-    "x86_64",
-]  # filter out 32 bit + ARM
 
 
 class Dirs(SimpleNamespace):

reflex/constants/colors.py

@@ -37,6 +37,8 @@ ColorType = Literal[
     "bronze",
     "gray",
     "accent",
+    "black",
+    "white",
 ]
 
 ShadeType = Literal[1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12]