"""Stub file for reflex/components/chakra/overlay/menu.py""" # ------------------- DO NOT EDIT ---------------------- # This file was generated by `reflex/utils/pyi_generator.py`! # ------------------------------------------------------ from typing import Any, Dict, Literal, Optional, Union, overload import reflex from reflex.vars import Var, BaseVar, ComputedVar from reflex.event import EventChain, EventHandler, EventSpec from reflex.style import Style from typing import List, Optional from reflex.components.chakra import ( ChakraComponent, LiteralChakraDirection, LiteralMenuOption, LiteralMenuStrategy, ) from reflex.components.chakra.forms.button import Button from reflex.components.component import Component from reflex.event import EventHandler from reflex.vars import Var class Menu(ChakraComponent): @overload @classmethod def create( # type: ignore cls, *children, button: Optional[Component] = None, items: Optional[List] = None, arrow_padding: Optional[Union[reflex.vars.Var[int], int]] = None, auto_select: Optional[Union[reflex.vars.Var[bool], bool]] = None, boundary: Optional[Union[reflex.vars.Var[str], str]] = None, close_on_blur: Optional[Union[reflex.vars.Var[bool], bool]] = None, close_on_select: Optional[Union[reflex.vars.Var[bool], bool]] = None, default_is_open: Optional[Union[reflex.vars.Var[bool], bool]] = None, direction: Optional[ Union[reflex.vars.Var[Literal["ltr", "rtl"]], Literal["ltr", "rtl"]] ] = None, flip: Optional[Union[reflex.vars.Var[bool], bool]] = None, gutter: Optional[Union[reflex.vars.Var[int], int]] = None, is_lazy: Optional[Union[reflex.vars.Var[bool], bool]] = None, lazy_behavior: Optional[Union[reflex.vars.Var[str], str]] = None, is_open: Optional[Union[reflex.vars.Var[bool], bool]] = None, match_width: Optional[Union[reflex.vars.Var[bool], bool]] = None, placement: Optional[Union[reflex.vars.Var[str], str]] = None, prevent_overflow: Optional[Union[reflex.vars.Var[bool], bool]] = None, strategy: Optional[ Union[ reflex.vars.Var[Literal["fixed", "absolute"]], Literal["fixed", "absolute"], ] ] = 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_close: 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_open: 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 ) -> "Menu": """Create a menu component. Args: *children: The children of the component. button: the button that open the menu. items (list): The items of the menu. arrow_padding: The padding required to prevent the arrow from reaching the very edge of the popper. auto_select: If true, the first enabled menu item will receive focus and be selected when the menu opens. boundary: The boundary area for the popper. Used within the preventOverflow modifier close_on_blur: If true, the menu will close when you click outside the menu list close_on_select: If true, the menu will close when a menu item is clicked default_is_open: If by default the menu is open. direction: If rtl, popper placement positions will be flipped i.e. 'top-right' will become 'top-left' and vice-verse ("ltr" | "rtl") flip: If true, the popper will change its placement and flip when it's about to overflow its boundary area. gutter: The distance or margin between the reference and popper. It is used internally to create an offset modifier. NB: If you define offset prop, it'll override the gutter. is_lazy: Performance 🚀: If true, the MenuItem rendering will be deferred until the menu is open. lazy_behavior: Performance 🚀: The lazy behavior of menu's content when not visible. Only works when `isLazy={true}` - "unmount": The menu's content is always unmounted when not open. - "keepMounted": The menu's content initially unmounted, but stays mounted when menu is open. is_open: Determines if the menu is open or not. match_width: If true, the popper will match the width of the reference at all times. It's useful for autocomplete, `date-picker` and select patterns. placement: The placement of the popper relative to its reference. prevent_overflow: If true, will prevent the popper from being cut off and ensure it's visible within the boundary area. strategy: The CSS positioning strategy to use. ("fixed" | "absolute") 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 component. Returns: The menu component. """ ... class MenuButton(ChakraComponent): @overload @classmethod def create( # type: ignore cls, *children, variant: Optional[Union[reflex.vars.Var[str], str]] = None, as_: Optional[Union[reflex.vars.Var[str], str]] = 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 ) -> "MenuButton": """Create the component. Args: *children: The children of the component. variant: The variant of the menu button. as_: The tag to use for the menu button. 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 MenuList(ChakraComponent): @overload @classmethod def create( # type: ignore cls, *children, items: Optional[list] = 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 ) -> "MenuList": """Create a MenuList component, and automatically wrap in MenuItem if not already one. Args: *children: The children of the component. items: A list of item to add as child of the component. 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 component. Returns: The MenuList component. """ ... class MenuItem(ChakraComponent): @overload @classmethod def create( # type: ignore cls, *children, close_on_select: Optional[Union[reflex.vars.Var[bool], bool]] = None, command: Optional[Union[reflex.vars.Var[str], str]] = None, command_spacing: Optional[Union[reflex.vars.Var[int], int]] = None, is_disabled: Optional[Union[reflex.vars.Var[bool], bool]] = None, is_focusable: Optional[Union[reflex.vars.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 ) -> "MenuItem": """Create the component. Args: *children: The children of the component. close_on_select: Overrides the parent menu's closeOnSelect prop. command: Right-aligned label text content, useful for displaying hotkeys. command_spacing: The spacing between the command and menu item's label. is_disabled: If true, the menuitem will be disabled. is_focusable: If true and the menuitem is disabled, it'll remain keyboard-focusable 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 MenuItemOption(ChakraComponent): @overload @classmethod def create( # type: ignore cls, *children, close_on_select: Optional[Union[reflex.vars.Var[bool], bool]] = None, command: Optional[Union[reflex.vars.Var[str], str]] = None, command_spacing: Optional[Union[reflex.vars.Var[int], int]] = None, is_checked: Optional[Union[reflex.vars.Var[bool], bool]] = None, is_disabled: Optional[Union[reflex.vars.Var[bool], bool]] = None, is_focusable: Optional[Union[reflex.vars.Var[bool], bool]] = None, type_: Optional[ Union[ reflex.vars.Var[Literal["checkbox", "radio"]], Literal["checkbox", "radio"], ] ] = None, value: Optional[Union[reflex.vars.Var[str], str]] = 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 ) -> "MenuItemOption": """Create the component. Args: *children: The children of the component. close_on_select: Overrides the parent menu's closeOnSelect prop. command: Right-aligned label text content, useful for displaying hotkeys. command_spacing: The spacing between the command and menu item's label. is_checked: Determines if menu item is checked. is_disabled: If true, the menuitem will be disabled. is_focusable: If true and the menuitem is disabled, it'll remain keyboard-focusable type_: "checkbox" | "radio" value: Value of the menu item. 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 MenuGroup(ChakraComponent): @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, 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 ) -> "MenuGroup": """Create the component. Args: *children: The children of the component. 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 MenuOptionGroup(ChakraComponent): @overload @classmethod def create( # type: ignore cls, *children, type_: Optional[ Union[ reflex.vars.Var[Literal["checkbox", "radio"]], Literal["checkbox", "radio"], ] ] = None, value: Optional[Union[reflex.vars.Var[str], str]] = 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 ) -> "MenuOptionGroup": """Create the component. Args: *children: The children of the component. type_: "checkbox" | "radio" value: Value of the option group. 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 MenuDivider(ChakraComponent): @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, 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 ) -> "MenuDivider": """Create the component. Args: *children: The children of the component. 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. """ ...