reflex 0.8.0a6__py3-none-any.whl → 0.8.1__py3-none-any.whl

reflex/components/radix/themes/typography/link.pyi

@@ -11,315 +11,12 @@ from reflex.components.core.breakpoints import Breakpoints
 from reflex.components.el.elements.inline import A
 from reflex.components.markdown.markdown import MarkdownComponentMap
 from reflex.components.radix.themes.base import RadixThemesComponent
+from reflex.components.react_router.dom import ReactRouterLink
 from reflex.event import EventType, PointerEventInfo
 from reflex.utils.imports import ImportDict
 from reflex.vars.base import Var
 
 LiteralLinkUnderline = Literal["auto", "hover", "always", "none"]
-LiteralLinkDiscover = Literal["none", "render"]
-
-class ReactRouterLink(A):
-    @classmethod
-    def create(
-        cls,
-        *children,
-        to: Var[str] | str | None = None,
-        replace: Var[bool] | bool | None = None,
-        reload_document: Var[bool] | bool | None = None,
-        prevent_scroll_reset: Var[bool] | bool | None = None,
-        discover: Literal["none", "render"]
-        | Var[Literal["none", "render"]]
-        | None = None,
-        view_transition: Var[bool] | bool | None = None,
-        download: Var[bool | str] | bool | str | None = None,
-        href: Var[str] | str | None = None,
-        href_lang: Var[str] | str | None = None,
-        media: Var[str] | str | None = None,
-        ping: Var[str] | str | None = None,
-        referrer_policy: Literal[
-            "",
-            "no-referrer",
-            "no-referrer-when-downgrade",
-            "origin",
-            "origin-when-cross-origin",
-            "same-origin",
-            "strict-origin",
-            "strict-origin-when-cross-origin",
-            "unsafe-url",
-        ]
-        | Var[
-            Literal[
-                "",
-                "no-referrer",
-                "no-referrer-when-downgrade",
-                "origin",
-                "origin-when-cross-origin",
-                "same-origin",
-                "strict-origin",
-                "strict-origin-when-cross-origin",
-                "unsafe-url",
-            ]
-        ]
-        | None = None,
-        rel: Var[str] | str | None = None,
-        target: Literal["_blank", "_parent", "_self", "_top"]
-        | Var[Literal["_blank", "_parent", "_self", "_top"] | str]
-        | str
-        | None = None,
-        access_key: Var[str] | str | None = None,
-        auto_capitalize: Literal[
-            "characters", "none", "off", "on", "sentences", "words"
-        ]
-        | Var[Literal["characters", "none", "off", "on", "sentences", "words"]]
-        | None = None,
-        content_editable: Literal["inherit", "plaintext-only", False, True]
-        | Var[Literal["inherit", "plaintext-only", False, True]]
-        | None = None,
-        context_menu: Var[str] | str | None = None,
-        dir: Var[str] | str | None = None,
-        draggable: Var[bool] | bool | None = None,
-        enter_key_hint: Literal[
-            "done", "enter", "go", "next", "previous", "search", "send"
-        ]
-        | Var[Literal["done", "enter", "go", "next", "previous", "search", "send"]]
-        | None = None,
-        hidden: Var[bool] | bool | None = None,
-        input_mode: Literal[
-            "decimal", "email", "none", "numeric", "search", "tel", "text", "url"
-        ]
-        | Var[
-            Literal[
-                "decimal", "email", "none", "numeric", "search", "tel", "text", "url"
-            ]
-        ]
-        | None = None,
-        item_prop: Var[str] | str | None = None,
-        lang: Var[str] | str | None = None,
-        role: Literal[
-            "alert",
-            "alertdialog",
-            "application",
-            "article",
-            "banner",
-            "button",
-            "cell",
-            "checkbox",
-            "columnheader",
-            "combobox",
-            "complementary",
-            "contentinfo",
-            "definition",
-            "dialog",
-            "directory",
-            "document",
-            "feed",
-            "figure",
-            "form",
-            "grid",
-            "gridcell",
-            "group",
-            "heading",
-            "img",
-            "link",
-            "list",
-            "listbox",
-            "listitem",
-            "log",
-            "main",
-            "marquee",
-            "math",
-            "menu",
-            "menubar",
-            "menuitem",
-            "menuitemcheckbox",
-            "menuitemradio",
-            "navigation",
-            "none",
-            "note",
-            "option",
-            "presentation",
-            "progressbar",
-            "radio",
-            "radiogroup",
-            "region",
-            "row",
-            "rowgroup",
-            "rowheader",
-            "scrollbar",
-            "search",
-            "searchbox",
-            "separator",
-            "slider",
-            "spinbutton",
-            "status",
-            "switch",
-            "tab",
-            "table",
-            "tablist",
-            "tabpanel",
-            "term",
-            "textbox",
-            "timer",
-            "toolbar",
-            "tooltip",
-            "tree",
-            "treegrid",
-            "treeitem",
-        ]
-        | Var[
-            Literal[
-                "alert",
-                "alertdialog",
-                "application",
-                "article",
-                "banner",
-                "button",
-                "cell",
-                "checkbox",
-                "columnheader",
-                "combobox",
-                "complementary",
-                "contentinfo",
-                "definition",
-                "dialog",
-                "directory",
-                "document",
-                "feed",
-                "figure",
-                "form",
-                "grid",
-                "gridcell",
-                "group",
-                "heading",
-                "img",
-                "link",
-                "list",
-                "listbox",
-                "listitem",
-                "log",
-                "main",
-                "marquee",
-                "math",
-                "menu",
-                "menubar",
-                "menuitem",
-                "menuitemcheckbox",
-                "menuitemradio",
-                "navigation",
-                "none",
-                "note",
-                "option",
-                "presentation",
-                "progressbar",
-                "radio",
-                "radiogroup",
-                "region",
-                "row",
-                "rowgroup",
-                "rowheader",
-                "scrollbar",
-                "search",
-                "searchbox",
-                "separator",
-                "slider",
-                "spinbutton",
-                "status",
-                "switch",
-                "tab",
-                "table",
-                "tablist",
-                "tabpanel",
-                "term",
-                "textbox",
-                "timer",
-                "toolbar",
-                "tooltip",
-                "tree",
-                "treegrid",
-                "treeitem",
-            ]
-        ]
-        | None = None,
-        slot: Var[str] | str | None = None,
-        spell_check: Var[bool] | bool | None = None,
-        tab_index: Var[int] | int | None = None,
-        title: Var[str] | str | None = None,
-        style: Sequence[Mapping[str, Any]]
-        | Mapping[str, Any]
-        | Var[Mapping[str, Any]]
-        | Breakpoints
-        | None = None,
-        key: Any | None = None,
-        id: Any | None = None,
-        ref: Var | None = None,
-        class_name: Any | None = None,
-        autofocus: bool | None = None,
-        custom_attrs: dict[str, Var | Any] | None = None,
-        on_blur: EventType[()] | None = None,
-        on_click: EventType[()] | EventType[PointerEventInfo] | None = None,
-        on_context_menu: EventType[()] | EventType[PointerEventInfo] | None = None,
-        on_double_click: EventType[()] | EventType[PointerEventInfo] | None = None,
-        on_focus: EventType[()] | None = None,
-        on_mount: EventType[()] | None = None,
-        on_mouse_down: EventType[()] | None = None,
-        on_mouse_enter: EventType[()] | None = None,
-        on_mouse_leave: EventType[()] | None = None,
-        on_mouse_move: EventType[()] | None = None,
-        on_mouse_out: EventType[()] | None = None,
-        on_mouse_over: EventType[()] | None = None,
-        on_mouse_up: EventType[()] | None = None,
-        on_scroll: EventType[()] | None = None,
-        on_scroll_end: EventType[()] | None = None,
-        on_unmount: EventType[()] | None = None,
-        **props,
-    ) -> ReactRouterLink:
-        """Create the component.
-
-        Args:
-            *children: The children of the component.
-            to: The page to link to.
-            replace: Replaces the current entry in the history stack instead of pushing a new one onto it.
-            reload_document: Will use document navigation instead of client side routing when the link is clicked: the browser will handle the transition normally (as if it were an <a href>).
-            prevent_scroll_reset: Prevents the scroll position from being reset to the top of the window when the link is clicked and the app is using ScrollRestoration. This only prevents new locations resetting scroll to the top, scroll position will be restored for back/forward button navigation.
-            discover: Defines the link discovery behavior
-            view_transition: Enables a View Transition for this navigation.
-            download: Specifies that the target (the file specified in the href attribute) will be downloaded when a user clicks on the hyperlink.
-            href: Specifies the URL of the page the link goes to
-            href_lang: Specifies the language of the linked document
-            media: Specifies what media/device the linked document is optimized for
-            ping: Specifies which referrer is sent when fetching the resource
-            referrer_policy: Specifies the relationship between the current document and the linked document
-            rel: Specifies the relationship between the linked document and the current document
-            target: Specifies where to open the linked document
-            access_key: Provides a hint for generating a keyboard shortcut for the current element.
-            auto_capitalize: Controls whether and how text input is automatically capitalized as it is entered/edited by the user.
-            content_editable: Indicates whether the element's content is editable.
-            context_menu: Defines the ID of a <menu> element which will serve as the element's context menu.
-            dir: Defines the text direction. Allowed values are ltr (Left-To-Right) or rtl (Right-To-Left)
-            draggable: Defines whether the element can be dragged.
-            enter_key_hint: Hints what media types the media element is able to play.
-            hidden: Defines whether the element is hidden.
-            input_mode: Defines the type of the element.
-            item_prop: Defines the name of the element for metadata purposes.
-            lang: Defines the language used in the element.
-            role: Defines the role of the element.
-            slot: Assigns a slot in a shadow DOM shadow tree to an element.
-            spell_check: Defines whether the element may be checked for spelling errors.
-            tab_index: Defines the position of the current element in the tabbing order.
-            title: Defines a tooltip for the element.
-            style: The style of the component.
-            key: A unique key for the component.
-            id: The id for the component.
-            ref: The Var to pass as the ref to 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.
-        """
-
 _KNOWN_REACT_ROUTER_LINK_PROPS = frozenset(ReactRouterLink.get_props())
 
 class Link(RadixThemesComponent, A, MemoizationLeaf, MarkdownComponentMap):

reflex/components/react_router/__init__.py

@@ -0,0 +1,5 @@
+"""React-router internal components."""
+
+from .dom import ReactRouterLink
+
+link = ReactRouterLink.create

reflex/components/react_router/dom.py

@@ -0,0 +1,69 @@
+"""Components for client side navigation within React Router applications."""
+
+from __future__ import annotations
+
+from typing import ClassVar, Literal, TypedDict
+
+from reflex.components.el.elements.inline import A
+from reflex.vars.base import Var
+
+LiteralLinkDiscover = Literal["none", "render"]
+
+
+class To(TypedDict):
+    """Structured object for navigating via the `to` prop."""
+
+    # A URL pathname, beginning with a /
+    pathname: str
+
+    # A URL search string, beginning with a ?.
+    search: str
+
+    # A URL fragment identifier, beginning with a #.
+    hash: str
+
+
+class ReactRouterLink(A):
+    """Links are accessible elements used primarily for navigation. This component is styled to resemble a hyperlink and semantically renders an <a>."""
+
+    library = "react-router"
+
+    tag = "Link"
+
+    alias = "ReactRouterLink"
+
+    # The page to link to.
+    to: Var[str | To]
+
+    # Replaces the current entry in the history stack instead of pushing a new one onto it.
+    replace: Var[bool]
+
+    # Will use document navigation instead of client side routing when the link is clicked: the browser will handle the transition normally (as if it were an <a href>).
+    reload_document: Var[bool]
+
+    # Prevents the scroll position from being reset to the top of the window when the link is clicked and the app is using ScrollRestoration. This only prevents new locations resetting scroll to the top, scroll position will be restored for back/forward button navigation.
+    prevent_scroll_reset: Var[bool]
+
+    # Defines the link discovery behavior
+    discover: Var[LiteralLinkDiscover]
+
+    # Enables a View Transition for this navigation.
+    view_transition: Var[bool]
+
+    @classmethod
+    def create(cls, *children, **props):
+        """Create a ReactRouterLink component for client-side navigation.
+
+        Args:
+            *children: The children of the component.
+            **props: The props of the component.
+
+        Returns:
+            The ReactRouterLink component.
+        """
+        # React Router special behavior is triggered on the `to` prop, not href.
+        if "to" not in props and "href" in props:
+            props["to"] = props.pop("href")
+        return super().create(*children, **props)
+
+    _invalid_children: ClassVar[list[str]] = ["A", "ReactRouterLink"]