563 lines
24 KiB
Python
563 lines
24 KiB
Python
"""Stub file for reflex/components/radix/primitives/drawer.py"""
|
|
|
|
# ------------------- DO NOT EDIT ----------------------
|
|
# This file was generated by `reflex/utils/pyi_generator.py`!
|
|
# ------------------------------------------------------
|
|
from typing import Any, Dict, List, Literal, Optional, Union, overload
|
|
|
|
from reflex.components.component import ComponentNamespace
|
|
from reflex.components.radix.primitives.base import RadixPrimitiveComponent
|
|
from reflex.event import EventType
|
|
from reflex.style import Style
|
|
from reflex.vars.base import Var
|
|
|
|
class DrawerComponent(RadixPrimitiveComponent):
|
|
@overload
|
|
@classmethod
|
|
def create( # type: ignore
|
|
cls,
|
|
*children,
|
|
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[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,
|
|
) -> "DrawerComponent":
|
|
"""Create the component.
|
|
|
|
Args:
|
|
*children: The children of the component.
|
|
as_child: Change the default rendered element for the one passed as a child.
|
|
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.
|
|
"""
|
|
...
|
|
|
|
LiteralDirectionType = Literal["top", "bottom", "left", "right"]
|
|
|
|
class DrawerRoot(DrawerComponent):
|
|
@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[
|
|
Literal["bottom", "left", "right", "top"],
|
|
Var[Literal["bottom", "left", "right", "top"]],
|
|
]
|
|
] = 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[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[bool]] = None,
|
|
on_scroll: Optional[EventType[[]]] = None,
|
|
on_unmount: Optional[EventType[[]]] = None,
|
|
**props,
|
|
) -> "DrawerRoot":
|
|
"""Create the component.
|
|
|
|
Args:
|
|
*children: The children of the component.
|
|
open: Whether the drawer is open or not.
|
|
should_scale_background: Enable background scaling, it requires an element with [vaul-drawer-wrapper] data attribute to scale its background.
|
|
close_threshold: Number between 0 and 1 that determines when the drawer should be closed.
|
|
snap_points: Array of numbers from 0 to 100 that corresponds to % of the screen a given snap point should take up. Should go from least visible. Also Accept px values, which doesn't take screen height into account.
|
|
fade_from_index: Index of a snapPoint from which the overlay fade should be applied. Defaults to the last snap point.
|
|
scroll_lock_timeout: Duration for which the drawer is not draggable after scrolling content inside of the drawer. Defaults to 500ms
|
|
modal: When `False`, it allows to interact with elements outside of the drawer without closing it. Defaults to `True`.
|
|
direction: Direction of the drawer. Defaults to `"bottom"`
|
|
preventScrollRestoration: When `True`, it prevents scroll restoration. Defaults to `True`.
|
|
on_open_change: Fires when the drawer is opened or closed.
|
|
as_child: Change the default rendered element for the one passed as a child.
|
|
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 DrawerTrigger(DrawerComponent):
|
|
@overload
|
|
@classmethod
|
|
def create( # type: ignore
|
|
cls,
|
|
*children,
|
|
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[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,
|
|
) -> "DrawerTrigger":
|
|
"""Create a new DrawerTrigger instance.
|
|
|
|
Args:
|
|
*children: The children of the element.
|
|
as_child: Change the default rendered element for the one passed as a child.
|
|
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 properties of the element.
|
|
|
|
Returns:
|
|
The new DrawerTrigger instance.
|
|
"""
|
|
...
|
|
|
|
class DrawerPortal(DrawerComponent):
|
|
@overload
|
|
@classmethod
|
|
def create( # type: ignore
|
|
cls,
|
|
*children,
|
|
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[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,
|
|
) -> "DrawerPortal":
|
|
"""Create the component.
|
|
|
|
Args:
|
|
*children: The children of the component.
|
|
as_child: Change the default rendered element for the one passed as a child.
|
|
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 DrawerContent(DrawerComponent):
|
|
@overload
|
|
@classmethod
|
|
def create( # type: ignore
|
|
cls,
|
|
*children,
|
|
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[EventType[[]]] = None,
|
|
on_click: Optional[EventType[[]]] = None,
|
|
on_close_auto_focus: Optional[EventType[[]]] = None,
|
|
on_context_menu: Optional[EventType[[]]] = None,
|
|
on_double_click: Optional[EventType[[]]] = None,
|
|
on_escape_key_down: Optional[EventType[[]]] = None,
|
|
on_focus: Optional[EventType[[]]] = None,
|
|
on_interact_outside: 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_auto_focus: Optional[EventType[[]]] = None,
|
|
on_pointer_down_outside: Optional[EventType[[]]] = None,
|
|
on_scroll: Optional[EventType[[]]] = None,
|
|
on_unmount: Optional[EventType[[]]] = None,
|
|
**props,
|
|
) -> "DrawerContent":
|
|
"""Create a Drawer Content.
|
|
We wrap the Drawer content in an `rx.theme` to make radix themes definitions available to
|
|
rendered div in the DOM. This is because Vaul Drawer injects the Drawer overlay content in a sibling
|
|
div to the root div rendered by radix which contains styling definitions. Wrapping in `rx.theme`
|
|
makes the styling available to the overlay.
|
|
|
|
Args:
|
|
*children: The list of children to use.
|
|
as_child: Change the default rendered element for the one passed as a child.
|
|
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: Additional properties to apply to the drawer content.
|
|
|
|
Returns:
|
|
The drawer content.
|
|
"""
|
|
...
|
|
|
|
class DrawerOverlay(DrawerComponent):
|
|
@overload
|
|
@classmethod
|
|
def create( # type: ignore
|
|
cls,
|
|
*children,
|
|
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[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,
|
|
) -> "DrawerOverlay":
|
|
"""Create the component.
|
|
|
|
Args:
|
|
*children: The children of the component.
|
|
as_child: Change the default rendered element for the one passed as a child.
|
|
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 DrawerClose(DrawerTrigger):
|
|
@overload
|
|
@classmethod
|
|
def create( # type: ignore
|
|
cls,
|
|
*children,
|
|
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[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,
|
|
) -> "DrawerClose":
|
|
"""Create a new DrawerTrigger instance.
|
|
|
|
Args:
|
|
*children: The children of the element.
|
|
as_child: Change the default rendered element for the one passed as a child.
|
|
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 properties of the element.
|
|
|
|
Returns:
|
|
The new DrawerTrigger instance.
|
|
"""
|
|
...
|
|
|
|
class DrawerTitle(DrawerComponent):
|
|
@overload
|
|
@classmethod
|
|
def create( # type: ignore
|
|
cls,
|
|
*children,
|
|
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[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,
|
|
) -> "DrawerTitle":
|
|
"""Create the component.
|
|
|
|
Args:
|
|
*children: The children of the component.
|
|
as_child: Change the default rendered element for the one passed as a child.
|
|
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 DrawerDescription(DrawerComponent):
|
|
@overload
|
|
@classmethod
|
|
def create( # type: ignore
|
|
cls,
|
|
*children,
|
|
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[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,
|
|
) -> "DrawerDescription":
|
|
"""Create the component.
|
|
|
|
Args:
|
|
*children: The children of the component.
|
|
as_child: Change the default rendered element for the one passed as a child.
|
|
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 Drawer(ComponentNamespace):
|
|
root = staticmethod(DrawerRoot.create)
|
|
trigger = staticmethod(DrawerTrigger.create)
|
|
portal = staticmethod(DrawerPortal.create)
|
|
content = staticmethod(DrawerContent.create)
|
|
overlay = staticmethod(DrawerOverlay.create)
|
|
close = staticmethod(DrawerClose.create)
|
|
title = staticmethod(DrawerTitle.create)
|
|
description = staticmethod(DrawerDescription.create)
|
|
|
|
@staticmethod
|
|
def __call__(
|
|
*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[
|
|
Literal["bottom", "left", "right", "top"],
|
|
Var[Literal["bottom", "left", "right", "top"]],
|
|
]
|
|
] = 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[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[bool]] = None,
|
|
on_scroll: Optional[EventType[[]]] = None,
|
|
on_unmount: Optional[EventType[[]]] = None,
|
|
**props,
|
|
) -> "DrawerRoot":
|
|
"""Create the component.
|
|
|
|
Args:
|
|
*children: The children of the component.
|
|
open: Whether the drawer is open or not.
|
|
should_scale_background: Enable background scaling, it requires an element with [vaul-drawer-wrapper] data attribute to scale its background.
|
|
close_threshold: Number between 0 and 1 that determines when the drawer should be closed.
|
|
snap_points: Array of numbers from 0 to 100 that corresponds to % of the screen a given snap point should take up. Should go from least visible. Also Accept px values, which doesn't take screen height into account.
|
|
fade_from_index: Index of a snapPoint from which the overlay fade should be applied. Defaults to the last snap point.
|
|
scroll_lock_timeout: Duration for which the drawer is not draggable after scrolling content inside of the drawer. Defaults to 500ms
|
|
modal: When `False`, it allows to interact with elements outside of the drawer without closing it. Defaults to `True`.
|
|
direction: Direction of the drawer. Defaults to `"bottom"`
|
|
preventScrollRestoration: When `True`, it prevents scroll restoration. Defaults to `True`.
|
|
on_open_change: Fires when the drawer is opened or closed.
|
|
as_child: Change the default rendered element for the one passed as a child.
|
|
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.
|
|
"""
|
|
...
|
|
|
|
drawer = Drawer()
|