reflex/reflex/components/chakra/forms/switch.pyi
Masen Furer f1dafc0373
pyi_generator cleanup: ruff, remove fully qualified reflex. names (#3591)
* pyi_generator: avoid fully qualified names for reflex. types

The previous method added quite a large line diff to the pyi files, so for now,
lets just add the `Breakpoints` import to the default set along with Var,
EventHandler, Style and others.

* pyi_generator: fix generated files using ruff

also generate updated pyi files in reflex/experimental namespace

* remove black from dev dependencies

* poetry.lock: relock deps

* Update all pyi files with new formatting

* pre-commit fixes

* pyi_generator: fix __init__.pyi files again
2024-06-29 08:48:01 -07:00

160 lines
6.2 KiB
Python

"""Stub file for reflex/components/chakra/forms/switch.py"""
# ------------------- DO NOT EDIT ----------------------
# This file was generated by `reflex/utils/pyi_generator.py`!
# ------------------------------------------------------
from typing import Any, Callable, Dict, Literal, Optional, Union, overload
from reflex.components.chakra import ChakraComponent
from reflex.event import EventHandler, EventSpec
from reflex.style import Style
from reflex.vars import BaseVar, Var
class Switch(ChakraComponent):
@overload
@classmethod
def create( # type: ignore
cls,
*children,
is_checked: Optional[Union[Var[bool], bool]] = None,
is_disabled: Optional[Union[Var[bool], bool]] = None,
is_focusable: Optional[Union[Var[bool], bool]] = None,
is_invalid: Optional[Union[Var[bool], bool]] = None,
is_read_only: Optional[Union[Var[bool], bool]] = None,
is_required: Optional[Union[Var[bool], bool]] = None,
name: Optional[Union[Var[str], str]] = None,
value: Optional[Union[Var[str], str]] = None,
spacing: Optional[Union[Var[str], str]] = None,
placeholder: Optional[Union[Var[str], str]] = 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,
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, Callable, BaseVar]
] = None,
on_change: Optional[
Union[EventHandler, EventSpec, list, Callable, BaseVar]
] = None,
on_click: Optional[
Union[EventHandler, EventSpec, list, Callable, BaseVar]
] = None,
on_context_menu: Optional[
Union[EventHandler, EventSpec, list, Callable, BaseVar]
] = None,
on_double_click: Optional[
Union[EventHandler, EventSpec, list, Callable, BaseVar]
] = None,
on_focus: Optional[
Union[EventHandler, EventSpec, list, Callable, BaseVar]
] = None,
on_mount: Optional[
Union[EventHandler, EventSpec, list, Callable, BaseVar]
] = None,
on_mouse_down: Optional[
Union[EventHandler, EventSpec, list, Callable, BaseVar]
] = None,
on_mouse_enter: Optional[
Union[EventHandler, EventSpec, list, Callable, BaseVar]
] = None,
on_mouse_leave: Optional[
Union[EventHandler, EventSpec, list, Callable, BaseVar]
] = None,
on_mouse_move: Optional[
Union[EventHandler, EventSpec, list, Callable, BaseVar]
] = None,
on_mouse_out: Optional[
Union[EventHandler, EventSpec, list, Callable, BaseVar]
] = None,
on_mouse_over: Optional[
Union[EventHandler, EventSpec, list, Callable, BaseVar]
] = None,
on_mouse_up: Optional[
Union[EventHandler, EventSpec, list, Callable, BaseVar]
] = None,
on_scroll: Optional[
Union[EventHandler, EventSpec, list, Callable, BaseVar]
] = None,
on_unmount: Optional[
Union[EventHandler, EventSpec, list, Callable, BaseVar]
] = None,
**props,
) -> "Switch":
"""Create the component.
Args:
*children: The children of the component.
is_checked: If true, the switch will be checked. You'll need to set an on_change event handler to update its value (since it is now controlled)
is_disabled: If true, the switch will be disabled
is_focusable: If true and is_disabled prop is set, the switch will remain tabbable but not interactive.
is_invalid: If true, the switch is marked as invalid. Changes style of unchecked state.
is_read_only: If true, the switch will be readonly
is_required: If true, the switch will be required
name: The name of the input field in a switch (Useful for form submission).
value: The value of the input field when checked (use is_checked prop for a bool)
spacing: The spacing between the switch and its label text (0.5rem)
placeholder: The placeholder text.
color_scheme: The color scheme of the switch (e.g. "blue", "green", "red", etc.)
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.
"""
...