reflex/reflex/components/chakra/forms/button.pyi
Thomas Brandého 0af4770180
generate pyi files when building/publishing 3rd party component (#2945)
* build pyi files when building/publishing 3rd party

* fix typo in workflow

* add future annotation

* add tests to pass coverage check

* add more unit tests

* omit pyi_generator from test coverage

* change black from dev deps to direct deps

* remake all pyi

* format pyi if black is present, return as if otherwise

* fix requested changes

---------

Co-authored-by: Masen Furer <m_github@0x26.net>
2024-03-29 09:54:21 -07:00

274 lines
10 KiB
Python

"""Stub file for reflex/components/chakra/forms/button.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.vars import Var, BaseVar, ComputedVar
from reflex.event import EventChain, EventHandler, EventSpec
from reflex.style import Style
from typing import List
from reflex.components.chakra import (
ChakraComponent,
LiteralButtonSize,
LiteralButtonVariant,
LiteralColorScheme,
LiteralSpinnerPlacement,
)
from reflex.vars import Var
class Button(ChakraComponent):
@overload
@classmethod
def create( # type: ignore
cls,
*children,
icon_spacing: Optional[Union[Var[int], int]] = None,
is_active: Optional[Union[Var[bool], bool]] = None,
is_disabled: Optional[Union[Var[bool], bool]] = None,
is_full_width: Optional[Union[Var[bool], bool]] = None,
is_loading: Optional[Union[Var[bool], bool]] = None,
loading_text: Optional[Union[Var[str], str]] = None,
size: Optional[
Union[Var[Literal["sm", "md", "lg", "xs"]], Literal["sm", "md", "lg", "xs"]]
] = None,
variant: Optional[
Union[
Var[Literal["ghost", "outline", "solid", "link", "unstyled"]],
Literal["ghost", "outline", "solid", "link", "unstyled"],
]
] = None,
color_scheme: Optional[
Union[
Var[
Literal[
"none",
"gray",
"red",
"orange",
"yellow",
"green",
"teal",
"blue",
"cyan",
"purple",
"pink",
"whiteAlpha",
"blackAlpha",
"linkedin",
"facebook",
"messenger",
"whatsapp",
"twitter",
"telegram",
]
],
Literal[
"none",
"gray",
"red",
"orange",
"yellow",
"green",
"teal",
"blue",
"cyan",
"purple",
"pink",
"whiteAlpha",
"blackAlpha",
"linkedin",
"facebook",
"messenger",
"whatsapp",
"twitter",
"telegram",
],
]
] = None,
spinner_placement: Optional[
Union[Var[Literal["start", "end"]], Literal["start", "end"]]
] = None,
type_: Optional[Union[Var[str], str]] = None,
name: 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, 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
) -> "Button":
"""Create the component.
Args:
*children: The children of the component.
icon_spacing: The space between the button icon and label.
is_active: If true, the button will be styled in its active state.
is_disabled: If true, the button will be styled in its disabled state.
is_full_width: If true, the button will take up the full width of its container.
is_loading: If true, the button will show a spinner.
loading_text: The label to show in the button when isLoading is true If no text is passed, it only shows the spinner.
size: "lg" | "md" | "sm" | "xs"
variant: "ghost" | "outline" | "solid" | "link" | "unstyled"
color_scheme: Built in color scheme for ease of use. Options: "whiteAlpha" | "blackAlpha" | "gray" | "red" | "orange" | "yellow" | "green" | "teal" | "blue" | "cyan" | "purple" | "pink" | "linkedin" | "facebook" | "messenger" | "whatsapp" | "twitter" | "telegram"
spinner_placement: Position of the loading spinner. Options: "start" | "end"
type_: The type of button.
name: The name of the form field
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.
Raises:
TypeError: If an invalid child is passed.
"""
...
class ButtonGroup(ChakraComponent):
@overload
@classmethod
def create( # type: ignore
cls,
*children,
is_attached: Optional[Union[Var[bool], bool]] = None,
is_disabled: Optional[Union[Var[bool], bool]] = None,
spacing: Optional[Union[Var[int], int]] = None,
size: Optional[
Union[Var[Literal["sm", "md", "lg", "xs"]], Literal["sm", "md", "lg", "xs"]]
] = None,
variant: Optional[
Union[
Var[Literal["ghost", "outline", "solid", "link", "unstyled"]],
Literal["ghost", "outline", "solid", "link", "unstyled"],
]
] = 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
) -> "ButtonGroup":
"""Create the component.
Args:
*children: The children of the component.
is_attached: If true, the borderRadius of button that are direct children will be altered to look flushed together.
is_disabled: If true, all wrapped button will be disabled.
spacing: The spacing between the buttons.
size: "lg" | "md" | "sm" | "xs"
variant: "ghost" | "outline" | "solid" | "link" | "unstyled"
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.
Raises:
TypeError: If an invalid child is passed.
"""
...