433 lines
18 KiB
Python
433 lines
18 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, Callable, Dict, List, Literal, Optional, Union, 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 EventHandler, EventSpec
|
|
from reflex.state import ComponentState
|
|
from reflex.style import Style
|
|
from reflex.vars import Var
|
|
|
|
class Sidebar(Box, MemoizationLeaf):
|
|
@overload
|
|
@classmethod
|
|
def create( # type: ignore
|
|
cls,
|
|
*children,
|
|
access_key: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
|
|
auto_capitalize: Optional[
|
|
Union[Var[Union[bool, int, str]], str, int, bool]
|
|
] = None,
|
|
content_editable: Optional[
|
|
Union[Var[Union[bool, int, str]], str, int, bool]
|
|
] = None,
|
|
context_menu: Optional[
|
|
Union[Var[Union[bool, int, str]], str, int, bool]
|
|
] = None,
|
|
dir: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
|
|
draggable: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
|
|
enter_key_hint: Optional[
|
|
Union[Var[Union[bool, int, str]], str, int, bool]
|
|
] = None,
|
|
hidden: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
|
|
input_mode: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
|
|
item_prop: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
|
|
lang: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
|
|
role: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
|
|
slot: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
|
|
spell_check: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
|
|
tab_index: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
|
|
title: Optional[Union[Var[Union[bool, int, str]], str, int, 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, Callable, Var]] = None,
|
|
on_click: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
|
|
on_context_menu: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, Var]
|
|
] = None,
|
|
on_double_click: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, Var]
|
|
] = None,
|
|
on_focus: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
|
|
on_mount: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
|
|
on_mouse_down: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, Var]
|
|
] = None,
|
|
on_mouse_enter: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, Var]
|
|
] = None,
|
|
on_mouse_leave: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, Var]
|
|
] = None,
|
|
on_mouse_move: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, Var]
|
|
] = None,
|
|
on_mouse_out: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, Var]
|
|
] = None,
|
|
on_mouse_over: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, Var]
|
|
] = None,
|
|
on_mouse_up: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, Var]
|
|
] = None,
|
|
on_scroll: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
|
|
on_unmount: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, Var]
|
|
] = 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,
|
|
open: Optional[Union[Var[bool], bool]] = None,
|
|
should_scale_background: Optional[Union[Var[bool], bool]] = None,
|
|
close_threshold: Optional[Union[Var[float], float]] = None,
|
|
snap_points: Optional[List[Union[float, str]]] = None,
|
|
fade_from_index: Optional[Union[Var[int], int]] = None,
|
|
scroll_lock_timeout: Optional[Union[Var[int], int]] = None,
|
|
modal: Optional[Union[Var[bool], bool]] = None,
|
|
direction: Optional[
|
|
Union[
|
|
Var[Literal["top", "bottom", "left", "right"]],
|
|
Literal["top", "bottom", "left", "right"],
|
|
]
|
|
] = None,
|
|
preventScrollRestoration: Optional[Union[Var[bool], bool]] = None,
|
|
as_child: 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, Callable, Var]] = None,
|
|
on_click: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
|
|
on_context_menu: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, Var]
|
|
] = None,
|
|
on_double_click: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, Var]
|
|
] = None,
|
|
on_focus: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
|
|
on_mount: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
|
|
on_mouse_down: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, Var]
|
|
] = None,
|
|
on_mouse_enter: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, Var]
|
|
] = None,
|
|
on_mouse_leave: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, Var]
|
|
] = None,
|
|
on_mouse_move: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, Var]
|
|
] = None,
|
|
on_mouse_out: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, Var]
|
|
] = None,
|
|
on_mouse_over: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, Var]
|
|
] = None,
|
|
on_mouse_up: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, Var]
|
|
] = None,
|
|
on_open_change: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, Var]
|
|
] = None,
|
|
on_scroll: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
|
|
on_unmount: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, Var]
|
|
] = 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: 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, Callable, Var]] = None,
|
|
on_click: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
|
|
on_context_menu: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, Var]
|
|
] = None,
|
|
on_double_click: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, Var]
|
|
] = None,
|
|
on_focus: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
|
|
on_mount: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
|
|
on_mouse_down: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, Var]
|
|
] = None,
|
|
on_mouse_enter: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, Var]
|
|
] = None,
|
|
on_mouse_leave: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, Var]
|
|
] = None,
|
|
on_mouse_move: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, Var]
|
|
] = None,
|
|
on_mouse_out: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, Var]
|
|
] = None,
|
|
on_mouse_over: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, Var]
|
|
] = None,
|
|
on_mouse_up: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, Var]
|
|
] = None,
|
|
on_scroll: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
|
|
on_unmount: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, Var]
|
|
] = 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: Optional[Component] = None,
|
|
access_key: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
|
|
auto_capitalize: Optional[
|
|
Union[Var[Union[bool, int, str]], str, int, bool]
|
|
] = None,
|
|
content_editable: Optional[
|
|
Union[Var[Union[bool, int, str]], str, int, bool]
|
|
] = None,
|
|
context_menu: Optional[
|
|
Union[Var[Union[bool, int, str]], str, int, bool]
|
|
] = None,
|
|
dir: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
|
|
draggable: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
|
|
enter_key_hint: Optional[
|
|
Union[Var[Union[bool, int, str]], str, int, bool]
|
|
] = None,
|
|
hidden: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
|
|
input_mode: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
|
|
item_prop: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
|
|
lang: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
|
|
role: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
|
|
slot: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
|
|
spell_check: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
|
|
tab_index: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
|
|
title: Optional[Union[Var[Union[bool, int, str]], str, int, 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, Callable, Var]] = None,
|
|
on_click: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
|
|
on_context_menu: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, Var]
|
|
] = None,
|
|
on_double_click: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, Var]
|
|
] = None,
|
|
on_focus: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
|
|
on_mount: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
|
|
on_mouse_down: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, Var]
|
|
] = None,
|
|
on_mouse_enter: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, Var]
|
|
] = None,
|
|
on_mouse_leave: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, Var]
|
|
] = None,
|
|
on_mouse_move: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, Var]
|
|
] = None,
|
|
on_mouse_out: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, Var]
|
|
] = None,
|
|
on_mouse_over: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, Var]
|
|
] = None,
|
|
on_mouse_up: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, Var]
|
|
] = None,
|
|
on_scroll: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
|
|
on_unmount: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, Var]
|
|
] = 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: Optional[Component] = None,
|
|
access_key: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
|
|
auto_capitalize: Optional[
|
|
Union[Var[Union[bool, int, str]], str, int, bool]
|
|
] = None,
|
|
content_editable: Optional[
|
|
Union[Var[Union[bool, int, str]], str, int, bool]
|
|
] = None,
|
|
context_menu: Optional[
|
|
Union[Var[Union[bool, int, str]], str, int, bool]
|
|
] = None,
|
|
dir: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
|
|
draggable: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
|
|
enter_key_hint: Optional[
|
|
Union[Var[Union[bool, int, str]], str, int, bool]
|
|
] = None,
|
|
hidden: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
|
|
input_mode: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
|
|
item_prop: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
|
|
lang: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
|
|
role: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
|
|
slot: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
|
|
spell_check: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
|
|
tab_index: Optional[Union[Var[Union[bool, int, str]], str, int, bool]] = None,
|
|
title: Optional[Union[Var[Union[bool, int, str]], str, int, 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, Callable, Var]] = None,
|
|
on_click: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
|
|
on_context_menu: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, Var]
|
|
] = None,
|
|
on_double_click: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, Var]
|
|
] = None,
|
|
on_focus: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
|
|
on_mount: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
|
|
on_mouse_down: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, Var]
|
|
] = None,
|
|
on_mouse_enter: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, Var]
|
|
] = None,
|
|
on_mouse_leave: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, Var]
|
|
] = None,
|
|
on_mouse_move: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, Var]
|
|
] = None,
|
|
on_mouse_out: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, Var]
|
|
] = None,
|
|
on_mouse_over: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, Var]
|
|
] = None,
|
|
on_mouse_up: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, Var]
|
|
] = None,
|
|
on_scroll: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
|
|
on_unmount: Optional[
|
|
Union[EventHandler, EventSpec, list, Callable, Var]
|
|
] = 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()
|