378 lines
13 KiB
Python
378 lines
13 KiB
Python
"""Stub file for reflex/components/radix/themes/components/badge.py"""
|
|
|
|
# ------------------- DO NOT EDIT ----------------------
|
|
# This file was generated by `reflex/utils/pyi_generator.py`!
|
|
# ------------------------------------------------------
|
|
from typing import Any, Dict, Literal, Optional, Union, overload
|
|
|
|
from reflex.components.core.breakpoints import Breakpoints
|
|
from reflex.components.el import elements
|
|
from reflex.event import EventType
|
|
from reflex.style import Style
|
|
from reflex.vars.base import Var
|
|
|
|
from ..base import RadixThemesComponent
|
|
|
|
class Badge(elements.Span, RadixThemesComponent):
|
|
@overload
|
|
@classmethod
|
|
def create( # type: ignore
|
|
cls,
|
|
*children,
|
|
variant: Optional[
|
|
Union[
|
|
Literal["outline", "soft", "solid", "surface"],
|
|
Var[Literal["outline", "soft", "solid", "surface"]],
|
|
]
|
|
] = None,
|
|
size: Optional[
|
|
Union[
|
|
Breakpoints[str, Literal["1", "2", "3"]],
|
|
Literal["1", "2", "3"],
|
|
Var[
|
|
Union[
|
|
Breakpoints[str, Literal["1", "2", "3"]], Literal["1", "2", "3"]
|
|
]
|
|
],
|
|
]
|
|
] = None,
|
|
color_scheme: Optional[
|
|
Union[
|
|
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,
|
|
high_contrast: Optional[Union[Var[bool], bool]] = None,
|
|
radius: Optional[
|
|
Union[
|
|
Literal["full", "large", "medium", "none", "small"],
|
|
Var[Literal["full", "large", "medium", "none", "small"]],
|
|
]
|
|
] = None,
|
|
access_key: Optional[Union[Var[str], str]] = None,
|
|
auto_capitalize: Optional[
|
|
Union[
|
|
Literal["characters", "none", "off", "on", "sentences", "words"],
|
|
Var[Literal["characters", "none", "off", "on", "sentences", "words"]],
|
|
]
|
|
] = None,
|
|
content_editable: Optional[
|
|
Union[
|
|
Literal["inherit", "plaintext-only", False, True],
|
|
Var[Literal["inherit", "plaintext-only", False, True]],
|
|
]
|
|
] = None,
|
|
context_menu: Optional[Union[Var[str], str]] = None,
|
|
dir: Optional[Union[Var[str], str]] = None,
|
|
draggable: Optional[Union[Var[bool], bool]] = None,
|
|
enter_key_hint: Optional[
|
|
Union[
|
|
Literal["done", "enter", "go", "next", "previous", "search", "send"],
|
|
Var[
|
|
Literal["done", "enter", "go", "next", "previous", "search", "send"]
|
|
],
|
|
]
|
|
] = None,
|
|
hidden: Optional[Union[Var[bool], bool]] = None,
|
|
input_mode: Optional[
|
|
Union[
|
|
Literal[
|
|
"decimal",
|
|
"email",
|
|
"none",
|
|
"numeric",
|
|
"search",
|
|
"tel",
|
|
"text",
|
|
"url",
|
|
],
|
|
Var[
|
|
Literal[
|
|
"decimal",
|
|
"email",
|
|
"none",
|
|
"numeric",
|
|
"search",
|
|
"tel",
|
|
"text",
|
|
"url",
|
|
]
|
|
],
|
|
]
|
|
] = None,
|
|
item_prop: Optional[Union[Var[str], str]] = None,
|
|
lang: Optional[Union[Var[str], str]] = None,
|
|
role: Optional[
|
|
Union[
|
|
Literal[
|
|
"alert",
|
|
"alertdialog",
|
|
"application",
|
|
"article",
|
|
"banner",
|
|
"button",
|
|
"cell",
|
|
"checkbox",
|
|
"columnheader",
|
|
"combobox",
|
|
"complementary",
|
|
"contentinfo",
|
|
"definition",
|
|
"dialog",
|
|
"directory",
|
|
"document",
|
|
"feed",
|
|
"figure",
|
|
"form",
|
|
"grid",
|
|
"gridcell",
|
|
"group",
|
|
"heading",
|
|
"img",
|
|
"link",
|
|
"list",
|
|
"listbox",
|
|
"listitem",
|
|
"log",
|
|
"main",
|
|
"marquee",
|
|
"math",
|
|
"menu",
|
|
"menubar",
|
|
"menuitem",
|
|
"menuitemcheckbox",
|
|
"menuitemradio",
|
|
"navigation",
|
|
"none",
|
|
"note",
|
|
"option",
|
|
"presentation",
|
|
"progressbar",
|
|
"radio",
|
|
"radiogroup",
|
|
"region",
|
|
"row",
|
|
"rowgroup",
|
|
"rowheader",
|
|
"scrollbar",
|
|
"search",
|
|
"searchbox",
|
|
"separator",
|
|
"slider",
|
|
"spinbutton",
|
|
"status",
|
|
"switch",
|
|
"tab",
|
|
"table",
|
|
"tablist",
|
|
"tabpanel",
|
|
"term",
|
|
"textbox",
|
|
"timer",
|
|
"toolbar",
|
|
"tooltip",
|
|
"tree",
|
|
"treegrid",
|
|
"treeitem",
|
|
],
|
|
Var[
|
|
Literal[
|
|
"alert",
|
|
"alertdialog",
|
|
"application",
|
|
"article",
|
|
"banner",
|
|
"button",
|
|
"cell",
|
|
"checkbox",
|
|
"columnheader",
|
|
"combobox",
|
|
"complementary",
|
|
"contentinfo",
|
|
"definition",
|
|
"dialog",
|
|
"directory",
|
|
"document",
|
|
"feed",
|
|
"figure",
|
|
"form",
|
|
"grid",
|
|
"gridcell",
|
|
"group",
|
|
"heading",
|
|
"img",
|
|
"link",
|
|
"list",
|
|
"listbox",
|
|
"listitem",
|
|
"log",
|
|
"main",
|
|
"marquee",
|
|
"math",
|
|
"menu",
|
|
"menubar",
|
|
"menuitem",
|
|
"menuitemcheckbox",
|
|
"menuitemradio",
|
|
"navigation",
|
|
"none",
|
|
"note",
|
|
"option",
|
|
"presentation",
|
|
"progressbar",
|
|
"radio",
|
|
"radiogroup",
|
|
"region",
|
|
"row",
|
|
"rowgroup",
|
|
"rowheader",
|
|
"scrollbar",
|
|
"search",
|
|
"searchbox",
|
|
"separator",
|
|
"slider",
|
|
"spinbutton",
|
|
"status",
|
|
"switch",
|
|
"tab",
|
|
"table",
|
|
"tablist",
|
|
"tabpanel",
|
|
"term",
|
|
"textbox",
|
|
"timer",
|
|
"toolbar",
|
|
"tooltip",
|
|
"tree",
|
|
"treegrid",
|
|
"treeitem",
|
|
]
|
|
],
|
|
]
|
|
] = None,
|
|
slot: Optional[Union[Var[str], str]] = None,
|
|
spell_check: Optional[Union[Var[bool], bool]] = None,
|
|
tab_index: Optional[Union[Var[int], int]] = None,
|
|
title: Optional[Union[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, Any]]] = 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,
|
|
) -> "Badge":
|
|
"""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.
|
|
variant: The variant of the badge
|
|
size: The size of the badge
|
|
color_scheme: Color theme of the badge
|
|
high_contrast: Whether to render the badge with higher contrast color against background
|
|
radius: Override theme radius for badge: "none" | "small" | "medium" | "large" | "full"
|
|
access_key: Provides a hint for generating a keyboard shortcut for the current element.
|
|
auto_capitalize: Controls whether and how text input is automatically capitalized as it is entered/edited by the user.
|
|
content_editable: Indicates whether the element's content is editable.
|
|
context_menu: Defines the ID of a <menu> element which will serve as the element's context menu.
|
|
dir: Defines the text direction. Allowed values are ltr (Left-To-Right) or rtl (Right-To-Left)
|
|
draggable: Defines whether the element can be dragged.
|
|
enter_key_hint: Hints what media types the media element is able to play.
|
|
hidden: Defines whether the element is hidden.
|
|
input_mode: Defines the type of the element.
|
|
item_prop: Defines the name of the element for metadata purposes.
|
|
lang: Defines the language used in the element.
|
|
role: Defines the role of the element.
|
|
slot: Assigns a slot in a shadow DOM shadow tree to an element.
|
|
spell_check: Defines whether the element may be checked for spelling errors.
|
|
tab_index: Defines the position of the current element in the tabbing order.
|
|
title: Defines a tooltip for the element.
|
|
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.
|
|
"""
|
|
...
|
|
|
|
badge = Badge.create
|