reflex/reflex/experimental/layout.pyi
2025-02-18 15:31:07 -08:00

794 lines
24 KiB
Python

"""Stub file for reflex/experimental/layout.py"""
# ------------------- DO NOT EDIT ----------------------
# This file was generated by `reflex/utils/pyi_generator.py`!
# ------------------------------------------------------
from typing import Any, Literal, Optional, overload
from reflex import color
from reflex.components.base.fragment import Fragment
from reflex.components.component import Component, ComponentNamespace, MemoizationLeaf
from reflex.components.radix.primitives.drawer import DrawerRoot
from reflex.components.radix.themes.layout.box import Box
from reflex.event import EventType
from reflex.state import ComponentState
from reflex.style import Style
from reflex.vars.base import Var
class Sidebar(Box, MemoizationLeaf):
@overload
@classmethod
def create( # type: ignore
cls,
*children,
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: Style | None = None,
key: Any | None = None,
id: Any | None = None,
class_name: Any | None = None,
autofocus: bool | None = None,
custom_attrs: dict[str, Var | Any] | None = None,
on_blur: Optional[EventType[()]] = None,
on_click: Optional[EventType[()]] = None,
on_context_menu: Optional[EventType[()]] = None,
on_double_click: Optional[EventType[()]] = None,
on_focus: Optional[EventType[()]] = None,
on_mount: Optional[EventType[()]] = None,
on_mouse_down: Optional[EventType[()]] = None,
on_mouse_enter: Optional[EventType[()]] = None,
on_mouse_leave: Optional[EventType[()]] = None,
on_mouse_move: Optional[EventType[()]] = None,
on_mouse_out: Optional[EventType[()]] = None,
on_mouse_over: Optional[EventType[()]] = None,
on_mouse_up: Optional[EventType[()]] = None,
on_scroll: Optional[EventType[()]] = None,
on_unmount: Optional[EventType[()]] = None,
**props,
) -> "Sidebar":
"""Create the sidebar component.
Args:
children: The children components.
props: The properties of the sidebar.
Returns:
The sidebar component.
"""
...
def add_style(self) -> dict[str, Any] | None: ...
def add_hooks(self) -> list[Var]: ...
class StatefulSidebar(ComponentState):
open: bool
def toggle(self): ...
@classmethod
def get_component(cls, *children, **props): ...
class DrawerSidebar(DrawerRoot):
@overload
@classmethod
def create( # type: ignore
cls,
*children,
default_open: Var[bool] | bool | None = None,
open: Var[bool] | bool | None = None,
modal: Var[bool] | bool | None = None,
direction: Literal["bottom", "left", "right", "top"]
| Var[Literal["bottom", "left", "right", "top"]]
| None = None,
dismissible: Var[bool] | bool | None = None,
handle_only: Var[bool] | bool | None = None,
snap_points: list[float | str] | None = None,
fade_from_index: Var[int] | int | None = None,
scroll_lock_timeout: Var[int] | int | None = None,
prevent_scroll_restoration: Var[bool] | bool | None = None,
should_scale_background: Var[bool] | bool | None = None,
close_threshold: Var[float] | float | None = None,
as_child: Var[bool] | bool | None = None,
style: Style | None = None,
key: Any | None = None,
id: Any | None = None,
class_name: Any | None = None,
autofocus: bool | None = None,
custom_attrs: dict[str, Var | Any] | None = None,
on_animation_end: Optional[EventType[()] | EventType[bool]] = None,
on_blur: Optional[EventType[()]] = None,
on_click: Optional[EventType[()]] = None,
on_context_menu: Optional[EventType[()]] = None,
on_double_click: Optional[EventType[()]] = None,
on_focus: Optional[EventType[()]] = None,
on_mount: Optional[EventType[()]] = None,
on_mouse_down: Optional[EventType[()]] = None,
on_mouse_enter: Optional[EventType[()]] = None,
on_mouse_leave: Optional[EventType[()]] = None,
on_mouse_move: Optional[EventType[()]] = None,
on_mouse_out: Optional[EventType[()]] = None,
on_mouse_over: Optional[EventType[()]] = None,
on_mouse_up: Optional[EventType[()]] = None,
on_open_change: Optional[EventType[()] | EventType[bool]] = None,
on_scroll: Optional[EventType[()]] = None,
on_unmount: Optional[EventType[()]] = None,
**props,
) -> "DrawerSidebar":
"""Create the sidebar component.
Args:
children: The children components.
props: The properties of the sidebar.
Returns:
The drawer sidebar component.
"""
...
sidebar_trigger_style = {
"position": "fixed",
"z_index": "15",
"color": color("accent", 12),
"background_color": "transparent",
"padding": "0",
}
class SidebarTrigger(Fragment):
@overload
@classmethod
def create( # type: ignore
cls,
*children,
style: Style | None = None,
key: Any | None = None,
id: Any | None = None,
class_name: Any | None = None,
autofocus: bool | None = None,
custom_attrs: dict[str, Var | Any] | None = None,
on_blur: Optional[EventType[()]] = None,
on_click: Optional[EventType[()]] = None,
on_context_menu: Optional[EventType[()]] = None,
on_double_click: Optional[EventType[()]] = None,
on_focus: Optional[EventType[()]] = None,
on_mount: Optional[EventType[()]] = None,
on_mouse_down: Optional[EventType[()]] = None,
on_mouse_enter: Optional[EventType[()]] = None,
on_mouse_leave: Optional[EventType[()]] = None,
on_mouse_move: Optional[EventType[()]] = None,
on_mouse_out: Optional[EventType[()]] = None,
on_mouse_over: Optional[EventType[()]] = None,
on_mouse_up: Optional[EventType[()]] = None,
on_scroll: Optional[EventType[()]] = None,
on_unmount: Optional[EventType[()]] = None,
**props,
) -> "SidebarTrigger":
"""Create the sidebar trigger component.
Args:
sidebar: The sidebar component.
props: The properties of the sidebar trigger.
Returns:
The sidebar trigger component.
"""
...
class Layout(Box):
@overload
@classmethod
def create( # type: ignore
cls,
*children,
sidebar: Component | 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: Style | None = None,
key: Any | None = None,
id: Any | None = None,
class_name: Any | None = None,
autofocus: bool | None = None,
custom_attrs: dict[str, Var | Any] | None = None,
on_blur: Optional[EventType[()]] = None,
on_click: Optional[EventType[()]] = None,
on_context_menu: Optional[EventType[()]] = None,
on_double_click: Optional[EventType[()]] = None,
on_focus: Optional[EventType[()]] = None,
on_mount: Optional[EventType[()]] = None,
on_mouse_down: Optional[EventType[()]] = None,
on_mouse_enter: Optional[EventType[()]] = None,
on_mouse_leave: Optional[EventType[()]] = None,
on_mouse_move: Optional[EventType[()]] = None,
on_mouse_out: Optional[EventType[()]] = None,
on_mouse_over: Optional[EventType[()]] = None,
on_mouse_up: Optional[EventType[()]] = None,
on_scroll: Optional[EventType[()]] = None,
on_unmount: Optional[EventType[()]] = None,
**props,
) -> "Layout":
"""Create the layout component.
Args:
content: The content component.
sidebar: The sidebar component.
props: The properties of the layout.
Returns:
The layout component.
"""
...
class LayoutNamespace(ComponentNamespace):
drawer_sidebar = staticmethod(DrawerSidebar.create)
stateful_sidebar = staticmethod(StatefulSidebar.create)
sidebar = staticmethod(Sidebar.create)
@staticmethod
def __call__(
*children,
sidebar: Component | 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: Style | None = None,
key: Any | None = None,
id: Any | None = None,
class_name: Any | None = None,
autofocus: bool | None = None,
custom_attrs: dict[str, Var | Any] | None = None,
on_blur: Optional[EventType[()]] = None,
on_click: Optional[EventType[()]] = None,
on_context_menu: Optional[EventType[()]] = None,
on_double_click: Optional[EventType[()]] = None,
on_focus: Optional[EventType[()]] = None,
on_mount: Optional[EventType[()]] = None,
on_mouse_down: Optional[EventType[()]] = None,
on_mouse_enter: Optional[EventType[()]] = None,
on_mouse_leave: Optional[EventType[()]] = None,
on_mouse_move: Optional[EventType[()]] = None,
on_mouse_out: Optional[EventType[()]] = None,
on_mouse_over: Optional[EventType[()]] = None,
on_mouse_up: Optional[EventType[()]] = None,
on_scroll: Optional[EventType[()]] = None,
on_unmount: Optional[EventType[()]] = None,
**props,
) -> "Layout":
"""Create the layout component.
Args:
content: The content component.
sidebar: The sidebar component.
props: The properties of the layout.
Returns:
The layout component.
"""
...
layout = LayoutNamespace()