12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103 |
- """Stub file for reflex/components/radix/themes/components/context_menu.py"""
- # ------------------- DO NOT EDIT ----------------------
- # This file was generated by `reflex/utils/pyi_generator.py`!
- # ------------------------------------------------------
- from typing import Any, Literal, Optional, Sequence, overload
- from reflex.components.component import ComponentNamespace
- from reflex.components.core.breakpoints import Breakpoints
- from reflex.event import EventType
- from reflex.style import Style
- from reflex.vars.base import Var
- from ..base import RadixThemesComponent
- from .checkbox import Checkbox
- from .radio_group import HighLevelRadioGroup
- LiteralDirType = Literal["ltr", "rtl"]
- LiteralSizeType = Literal["1", "2"]
- LiteralVariantType = Literal["solid", "soft"]
- LiteralSideType = Literal["top", "right", "bottom", "left"]
- LiteralAlignType = Literal["start", "center", "end"]
- LiteralStickyType = Literal["partial", "always"]
- class ContextMenuRoot(RadixThemesComponent):
- @overload
- @classmethod
- def create( # type: ignore
- cls,
- *children,
- modal: Var[bool] | bool | None = None,
- dir: Literal["ltr", "rtl"] | Var[Literal["ltr", "rtl"]] | 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_open_change: Optional[EventType[()] | EventType[bool]] = None,
- on_scroll: Optional[EventType[()]] = None,
- on_unmount: Optional[EventType[()]] = None,
- **props,
- ) -> "ContextMenuRoot":
- """Create a new component instance.
- Will prepend "RadixThemes" to the component tag to avoid conflicts with
- other UI libraries for common names, like Text and Button.
- Args:
- *children: Child components.
- modal: The modality of the context menu. When set to true, interaction with outside elements will be disabled and only menu content will be visible to screen readers.
- on_open_change: Fired when the open state changes.
- dir: The reading direction of submenus when applicable. If omitted, inherits globally from DirectionProvider or assumes LTR (left-to-right) reading mode.
- 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: Component properties.
- Returns:
- A new component instance.
- """
- ...
- class ContextMenuTrigger(RadixThemesComponent):
- @overload
- @classmethod
- def create( # type: ignore
- cls,
- *children,
- disabled: 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_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,
- ) -> "ContextMenuTrigger":
- """Create a new component instance.
- Will prepend "RadixThemes" to the component tag to avoid conflicts with
- other UI libraries for common names, like Text and Button.
- Args:
- *children: Child components.
- disabled: Whether the trigger is disabled
- 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: Component properties.
- Returns:
- A new component instance.
- """
- ...
- class ContextMenuContent(RadixThemesComponent):
- @overload
- @classmethod
- def create( # type: ignore
- cls,
- *children,
- size: Breakpoints[str, Literal["1", "2"]]
- | Literal["1", "2"]
- | Var[Breakpoints[str, Literal["1", "2"]] | Literal["1", "2"]]
- | None = None,
- variant: Literal["soft", "solid"] | Var[Literal["soft", "solid"]] | None = None,
- color_scheme: Literal[
- "amber",
- "blue",
- "bronze",
- "brown",
- "crimson",
- "cyan",
- "gold",
- "grass",
- "gray",
- "green",
- "indigo",
- "iris",
- "jade",
- "lime",
- "mint",
- "orange",
- "pink",
- "plum",
- "purple",
- "red",
- "ruby",
- "sky",
- "teal",
- "tomato",
- "violet",
- "yellow",
- ]
- | Var[
- Literal[
- "amber",
- "blue",
- "bronze",
- "brown",
- "crimson",
- "cyan",
- "gold",
- "grass",
- "gray",
- "green",
- "indigo",
- "iris",
- "jade",
- "lime",
- "mint",
- "orange",
- "pink",
- "plum",
- "purple",
- "red",
- "ruby",
- "sky",
- "teal",
- "tomato",
- "violet",
- "yellow",
- ]
- ]
- | None = None,
- high_contrast: Var[bool] | bool | None = None,
- as_child: Var[bool] | bool | None = None,
- loop: Var[bool] | bool | None = None,
- force_mount: Var[bool] | bool | None = None,
- side: Literal["bottom", "left", "right", "top"]
- | Var[Literal["bottom", "left", "right", "top"]]
- | None = None,
- side_offset: Var[float | int] | float | int | None = None,
- align: Literal["center", "end", "start"]
- | Var[Literal["center", "end", "start"]]
- | None = None,
- align_offset: Var[float | int] | float | int | None = None,
- avoid_collisions: Var[bool] | bool | None = None,
- collision_padding: Var[dict[str, float | int] | float | int]
- | dict[str, float | int]
- | float
- | int
- | None = None,
- sticky: Literal["always", "partial"]
- | Var[Literal["always", "partial"]]
- | None = None,
- hide_when_detached: 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_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_focus_outside: 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_pointer_down_outside: Optional[EventType[()]] = None,
- on_scroll: Optional[EventType[()]] = None,
- on_unmount: Optional[EventType[()]] = None,
- **props,
- ) -> "ContextMenuContent":
- """Create a new component instance.
- Will prepend "RadixThemes" to the component tag to avoid conflicts with
- other UI libraries for common names, like Text and Button.
- Args:
- *children: Child components.
- size: Dropdown Menu Content size "1" - "2"
- variant: Variant of Dropdown Menu Content: "solid" | "soft"
- color_scheme: Override theme color for Dropdown Menu Content
- high_contrast: Renders the Dropdown Menu Content in higher contrast
- as_child: Change the default rendered element for the one passed as a child, merging their props and behavior. Defaults to False.
- loop: When True, keyboard navigation will loop from last item to first, and vice versa. Defaults to False.
- force_mount: Used to force mounting when more control is needed. Useful when controlling animation with React animation libraries.
- side: The preferred side of the trigger to render against when open. Will be reversed when collisions occur and `avoid_collisions` is enabled.The position of the tooltip. Defaults to "top".
- side_offset: The distance in pixels from the trigger. Defaults to 0.
- align: The preferred alignment against the trigger. May change when collisions occur. Defaults to "center".
- align_offset: An offset in pixels from the "start" or "end" alignment options.
- avoid_collisions: When true, overrides the side and align preferences to prevent collisions with boundary edges. Defaults to True.
- collision_padding: The distance in pixels from the boundary edges where collision detection should occur. Accepts a number (same for all sides), or a partial padding object, for example: { "top": 20, "left": 20 }. Defaults to 0.
- sticky: The sticky behavior on the align axis. "partial" will keep the content in the boundary as long as the trigger is at least partially in the boundary whilst "always" will keep the content in the boundary regardless. Defaults to "partial".
- hide_when_detached: Whether to hide the content when the trigger becomes fully occluded. Defaults to False.
- on_close_auto_focus: Fired when focus moves back after closing.
- on_escape_key_down: Fired when the escape key is pressed.
- on_pointer_down_outside: Fired when a pointer down event happens outside the context menu.
- on_focus_outside: Fired when focus moves outside the context menu.
- on_interact_outside: Fired when the pointer interacts outside the context menu.
- 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: Component properties.
- Returns:
- A new component instance.
- """
- ...
- class ContextMenuSub(RadixThemesComponent):
- @overload
- @classmethod
- def create( # type: ignore
- cls,
- *children,
- open: Var[bool] | bool | None = None,
- default_open: 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_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,
- ) -> "ContextMenuSub":
- """Create a new component instance.
- Will prepend "RadixThemes" to the component tag to avoid conflicts with
- other UI libraries for common names, like Text and Button.
- Args:
- *children: Child components.
- open: The controlled open state of the submenu. Must be used in conjunction with `on_open_change`.
- default_open: The open state of the submenu when it is initially rendered. Use when you do not need to control its open state.
- on_open_change: Fired when the open state changes.
- 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: Component properties.
- Returns:
- A new component instance.
- """
- ...
- class ContextMenuSubTrigger(RadixThemesComponent):
- @overload
- @classmethod
- def create( # type: ignore
- cls,
- *children,
- as_child: Var[bool] | bool | None = None,
- disabled: Var[bool] | bool | None = None,
- text_value: 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,
- ) -> "ContextMenuSubTrigger":
- """Create a new component instance.
- Will prepend "RadixThemes" to the component tag to avoid conflicts with
- other UI libraries for common names, like Text and Button.
- Args:
- *children: Child components.
- as_child: Change the default rendered element for the one passed as a child, merging their props and behavior. Defaults to False.
- disabled: Whether the trigger is disabled
- text_value: Optional text used for typeahead purposes. By default the typeahead behavior will use the .textContent of the item. Use this when the content is complex, or you have non-textual content inside.
- 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: Component properties.
- Returns:
- A new component instance.
- """
- ...
- class ContextMenuSubContent(RadixThemesComponent):
- @overload
- @classmethod
- def create( # type: ignore
- cls,
- *children,
- as_child: Var[bool] | bool | None = None,
- loop: Var[bool] | bool | None = None,
- force_mount: Var[bool] | bool | None = None,
- side_offset: Var[float | int] | float | int | None = None,
- align_offset: Var[float | int] | float | int | None = None,
- avoid_collisions: Var[bool] | bool | None = None,
- collision_padding: Var[dict[str, float | int] | float | int]
- | dict[str, float | int]
- | float
- | int
- | None = None,
- sticky: Literal["always", "partial"]
- | Var[Literal["always", "partial"]]
- | None = None,
- hide_when_detached: 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_blur: Optional[EventType[()]] = None,
- on_click: 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_focus_outside: 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_pointer_down_outside: Optional[EventType[()]] = None,
- on_scroll: Optional[EventType[()]] = None,
- on_unmount: Optional[EventType[()]] = None,
- **props,
- ) -> "ContextMenuSubContent":
- """Create a new component instance.
- Will prepend "RadixThemes" to the component tag to avoid conflicts with
- other UI libraries for common names, like Text and Button.
- Args:
- *children: Child components.
- as_child: Change the default rendered element for the one passed as a child, merging their props and behavior. Defaults to False.
- loop: When True, keyboard navigation will loop from last item to first, and vice versa. Defaults to False.
- force_mount: Used to force mounting when more control is needed. Useful when controlling animation with React animation libraries.
- side_offset: The distance in pixels from the trigger. Defaults to 0.
- align_offset: An offset in pixels from the "start" or "end" alignment options.
- avoid_collisions: When true, overrides the side and align preferences to prevent collisions with boundary edges. Defaults to True.
- collision_padding: The distance in pixels from the boundary edges where collision detection should occur. Accepts a number (same for all sides), or a partial padding object, for example: { "top": 20, "left": 20 }. Defaults to 0.
- sticky: The sticky behavior on the align axis. "partial" will keep the content in the boundary as long as the trigger is at least partially in the boundary whilst "always" will keep the content in the boundary regardless. Defaults to "partial".
- hide_when_detached: Whether to hide the content when the trigger becomes fully occluded. Defaults to False.
- on_escape_key_down: Fired when the escape key is pressed.
- on_pointer_down_outside: Fired when a pointer down event happens outside the context menu.
- on_focus_outside: Fired when focus moves outside the context menu.
- on_interact_outside: Fired when interacting outside the context menu.
- 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: Component properties.
- Returns:
- A new component instance.
- """
- ...
- class ContextMenuItem(RadixThemesComponent):
- @overload
- @classmethod
- def create( # type: ignore
- cls,
- *children,
- color_scheme: Literal[
- "amber",
- "blue",
- "bronze",
- "brown",
- "crimson",
- "cyan",
- "gold",
- "grass",
- "gray",
- "green",
- "indigo",
- "iris",
- "jade",
- "lime",
- "mint",
- "orange",
- "pink",
- "plum",
- "purple",
- "red",
- "ruby",
- "sky",
- "teal",
- "tomato",
- "violet",
- "yellow",
- ]
- | Var[
- Literal[
- "amber",
- "blue",
- "bronze",
- "brown",
- "crimson",
- "cyan",
- "gold",
- "grass",
- "gray",
- "green",
- "indigo",
- "iris",
- "jade",
- "lime",
- "mint",
- "orange",
- "pink",
- "plum",
- "purple",
- "red",
- "ruby",
- "sky",
- "teal",
- "tomato",
- "violet",
- "yellow",
- ]
- ]
- | None = None,
- shortcut: Var[str] | str | None = None,
- as_child: Var[bool] | bool | None = None,
- disabled: Var[bool] | bool | None = None,
- text_value: 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_select: Optional[EventType[()]] = None,
- on_unmount: Optional[EventType[()]] = None,
- **props,
- ) -> "ContextMenuItem":
- """Create a new component instance.
- Will prepend "RadixThemes" to the component tag to avoid conflicts with
- other UI libraries for common names, like Text and Button.
- Args:
- *children: Child components.
- color_scheme: Override theme color for button
- shortcut: Shortcut to render a menu item as a link
- as_child: Change the default rendered element for the one passed as a child, merging their props and behavior. Defaults to False.
- disabled: When true, prevents the user from interacting with the item.
- text_value: Optional text used for typeahead purposes. By default the typeahead behavior will use the content of the item. Use this when the content is complex, or you have non-textual content inside.
- on_select: Fired when the item is selected.
- 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: Component properties.
- Returns:
- A new component instance.
- """
- ...
- class ContextMenuSeparator(RadixThemesComponent):
- @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,
- ) -> "ContextMenuSeparator":
- """Create a new component instance.
- Will prepend "RadixThemes" to the component tag to avoid conflicts with
- other UI libraries for common names, like Text and Button.
- Args:
- *children: Child components.
- 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: Component properties.
- Returns:
- A new component instance.
- """
- ...
- class ContextMenuCheckbox(Checkbox):
- @overload
- @classmethod
- def create( # type: ignore
- cls,
- *children,
- shortcut: Var[str] | str | None = None,
- as_child: Var[bool] | bool | None = None,
- size: Breakpoints[str, Literal["1", "2", "3"]]
- | Literal["1", "2", "3"]
- | Var[Breakpoints[str, Literal["1", "2", "3"]] | Literal["1", "2", "3"]]
- | None = None,
- variant: Literal["classic", "soft", "surface"]
- | Var[Literal["classic", "soft", "surface"]]
- | None = None,
- color_scheme: Literal[
- "amber",
- "blue",
- "bronze",
- "brown",
- "crimson",
- "cyan",
- "gold",
- "grass",
- "gray",
- "green",
- "indigo",
- "iris",
- "jade",
- "lime",
- "mint",
- "orange",
- "pink",
- "plum",
- "purple",
- "red",
- "ruby",
- "sky",
- "teal",
- "tomato",
- "violet",
- "yellow",
- ]
- | Var[
- Literal[
- "amber",
- "blue",
- "bronze",
- "brown",
- "crimson",
- "cyan",
- "gold",
- "grass",
- "gray",
- "green",
- "indigo",
- "iris",
- "jade",
- "lime",
- "mint",
- "orange",
- "pink",
- "plum",
- "purple",
- "red",
- "ruby",
- "sky",
- "teal",
- "tomato",
- "violet",
- "yellow",
- ]
- ]
- | None = None,
- high_contrast: Var[bool] | bool | None = None,
- default_checked: Var[bool] | bool | None = None,
- checked: Var[bool] | bool | None = None,
- disabled: Var[bool] | bool | None = None,
- required: Var[bool] | bool | None = None,
- name: Var[str] | str | None = None,
- value: 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_change: Optional[EventType[()] | EventType[bool]] = 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,
- ) -> "ContextMenuCheckbox":
- """Create a new component instance.
- Will prepend "RadixThemes" to the component tag to avoid conflicts with
- other UI libraries for common names, like Text and Button.
- Args:
- *children: Child components.
- shortcut: Text to render as shortcut.
- as_child: Change the default rendered element for the one passed as a child, merging their props and behavior.
- size: Checkbox size "1" - "3"
- variant: Variant of checkbox: "classic" | "surface" | "soft"
- color_scheme: Override theme color for checkbox
- high_contrast: Whether to render the checkbox with higher contrast color against background
- default_checked: Whether the checkbox is checked by default
- checked: Whether the checkbox is checked
- disabled: Whether the checkbox is disabled
- required: Whether the checkbox is required
- name: The name of the checkbox control when submitting the form.
- value: The value of the checkbox control when submitting the form.
- on_change: Fired when the checkbox is checked or unchecked.
- 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: Component properties.
- Returns:
- A new component instance.
- """
- ...
- class ContextMenuLabel(RadixThemesComponent):
- @overload
- @classmethod
- def create( # type: ignore
- cls,
- *children,
- 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_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,
- ) -> "ContextMenuLabel":
- """Create a new component instance.
- Will prepend "RadixThemes" to the component tag to avoid conflicts with
- other UI libraries for common names, like Text and Button.
- Args:
- *children: Child components.
- as_child: Change the default rendered element for the one passed as a child, merging their props and behavior. Defaults to False.
- 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: Component properties.
- Returns:
- A new component instance.
- """
- ...
- class ContextMenuGroup(RadixThemesComponent):
- @overload
- @classmethod
- def create( # type: ignore
- cls,
- *children,
- 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_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,
- ) -> "ContextMenuGroup":
- """Create a new component instance.
- Will prepend "RadixThemes" to the component tag to avoid conflicts with
- other UI libraries for common names, like Text and Button.
- Args:
- *children: Child components.
- as_child: Change the default rendered element for the one passed as a child, merging their props and behavior. Defaults to False.
- 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: Component properties.
- Returns:
- A new component instance.
- """
- ...
- class ContextMenuRadioGroup(RadixThemesComponent):
- @overload
- @classmethod
- def create( # type: ignore
- cls,
- *children,
- as_child: Var[bool] | bool | None = None,
- value: 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_change: Optional[EventType[()] | EventType[str]] = 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,
- ) -> "ContextMenuRadioGroup":
- """Create a new component instance.
- Will prepend "RadixThemes" to the component tag to avoid conflicts with
- other UI libraries for common names, like Text and Button.
- Args:
- *children: Child components.
- as_child: Change the default rendered element for the one passed as a child, merging their props and behavior. Defaults to False.
- value: The value of the selected item in the group.
- on_change: Fired when the value of the radio group changes.
- 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: Component properties.
- Returns:
- A new component instance.
- """
- ...
- class ContextMenuRadioItem(HighLevelRadioGroup):
- @overload
- @classmethod
- def create( # type: ignore
- cls,
- *children,
- color_scheme: Literal[
- "amber",
- "blue",
- "bronze",
- "brown",
- "crimson",
- "cyan",
- "gold",
- "grass",
- "gray",
- "green",
- "indigo",
- "iris",
- "jade",
- "lime",
- "mint",
- "orange",
- "pink",
- "plum",
- "purple",
- "red",
- "ruby",
- "sky",
- "teal",
- "tomato",
- "violet",
- "yellow",
- ]
- | Var[
- Literal[
- "amber",
- "blue",
- "bronze",
- "brown",
- "crimson",
- "cyan",
- "gold",
- "grass",
- "gray",
- "green",
- "indigo",
- "iris",
- "jade",
- "lime",
- "mint",
- "orange",
- "pink",
- "plum",
- "purple",
- "red",
- "ruby",
- "sky",
- "teal",
- "tomato",
- "violet",
- "yellow",
- ]
- ]
- | None = None,
- as_child: Var[bool] | bool | None = None,
- value: Var[str] | str | None = None,
- disabled: Var[bool] | bool | None = None,
- text_value: Var[str] | str | None = None,
- items: Sequence[str] | Var[Sequence[str]] | None = None,
- direction: Literal["column", "column-reverse", "row", "row-reverse"]
- | Var[Literal["column", "column-reverse", "row", "row-reverse"]]
- | None = None,
- spacing: Literal["0", "1", "2", "3", "4", "5", "6", "7", "8", "9"]
- | Var[Literal["0", "1", "2", "3", "4", "5", "6", "7", "8", "9"]]
- | None = None,
- size: Literal["1", "2", "3"] | Var[Literal["1", "2", "3"]] | None = None,
- variant: Literal["classic", "soft", "surface"]
- | Var[Literal["classic", "soft", "surface"]]
- | None = None,
- high_contrast: Var[bool] | bool | None = None,
- default_value: Var[str] | str | None = None,
- name: Var[str] | str | None = None,
- required: 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_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_select: Optional[EventType[()]] = None,
- on_unmount: Optional[EventType[()]] = None,
- **props,
- ) -> "ContextMenuRadioItem":
- """Create a radio group component.
- Args:
- items: The items of the radio group.
- color_scheme: The color of the radio group
- as_child: Change the default rendered element for the one passed as a child, merging their props and behavior. Defaults to False.
- value: The controlled value of the radio item to check. Should be used in conjunction with on_change.
- disabled: Whether the radio group is disabled
- on_select: Event handler called when the user selects an item (via mouse or keyboard). Calling event.preventDefault in this handler will prevent the context menu from closing when selecting that item.
- text_value: Optional text used for typeahead purposes. By default the typeahead behavior will use the .textContent of the item. Use this when the content is complex, or you have non-textual content inside.
- items: The items of the radio group.
- direction: The direction of the radio group.
- spacing: The gap between the items of the radio group.
- size: The size of the radio group.
- variant: The variant of the radio group
- high_contrast: Whether to render the radio group with higher contrast color against background
- default_value: The initial value of checked radio item. Should be used in conjunction with on_change.
- name: The name of the group. Submitted with its owning form as part of a name/value pair.
- required: Whether the radio group is required
- 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 accordion item.
- Returns:
- The created radio group component.
- Raises:
- TypeError: If the type of items is invalid.
- """
- ...
- class ContextMenu(ComponentNamespace):
- root = staticmethod(ContextMenuRoot.create)
- trigger = staticmethod(ContextMenuTrigger.create)
- content = staticmethod(ContextMenuContent.create)
- sub = staticmethod(ContextMenuSub.create)
- sub_trigger = staticmethod(ContextMenuSubTrigger.create)
- sub_content = staticmethod(ContextMenuSubContent.create)
- item = staticmethod(ContextMenuItem.create)
- separator = staticmethod(ContextMenuSeparator.create)
- checkbox = staticmethod(ContextMenuCheckbox.create)
- label = staticmethod(ContextMenuLabel.create)
- group = staticmethod(ContextMenuGroup.create)
- radio_group = staticmethod(ContextMenuRadioGroup.create)
- radio = staticmethod(ContextMenuRadioItem.create)
- context_menu = ContextMenu()
|