reflex 0.5.9.dev1__py3-none-any.whl → 0.5.10a1__py3-none-any.whl

reflex/components/chakra/forms/button.py

@@ -1,83 +0,0 @@
-"""A button component."""
-
-from typing import List
-
-from reflex.components.chakra import (
-    ChakraComponent,
-    LiteralButtonSize,
-    LiteralButtonVariant,
-    LiteralColorScheme,
-    LiteralSpinnerPlacement,
-)
-from reflex.vars import Var
-
-
-class Button(ChakraComponent):
-    """The Button component is used to trigger an event or event, such as submitting a form, opening a dialog, canceling an event, or performing a delete operation."""
-
-    tag = "Button"
-
-    # The space between the button icon and label.
-    icon_spacing: Var[int]
-
-    # If true, the button will be styled in its active state.
-    is_active: Var[bool]
-
-    # If true, the button will be styled in its disabled state.
-    is_disabled: Var[bool]
-
-    # If true, the button will take up the full width of its container.
-    is_full_width: Var[bool]
-
-    # If true, the button will show a spinner.
-    is_loading: Var[bool]
-
-    # The label to show in the button when isLoading is true If no text is passed, it only shows the spinner.
-    loading_text: Var[str]
-
-    # "lg" | "md" | "sm" | "xs"
-    size: Var[LiteralButtonSize]
-
-    # "ghost" | "outline" | "solid" | "link" | "unstyled"
-    variant: Var[LiteralButtonVariant]
-
-    # 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"
-    color_scheme: Var[LiteralColorScheme]
-
-    # Position of the loading spinner.
-    # Options:
-    # "start" | "end"
-    spinner_placement: Var[LiteralSpinnerPlacement]
-
-    # The type of button.
-    type_: Var[str]
-
-    # Components that are not allowed as children.
-    _invalid_children: List[str] = ["Button", "MenuButton"]
-
-    # The name of the form field
-    name: Var[str]
-
-
-class ButtonGroup(ChakraComponent):
-    """A group of buttons."""
-
-    tag = "ButtonGroup"
-
-    # If true, the borderRadius of button that are direct children will be altered to look flushed together.
-    is_attached: Var[bool]
-
-    # If true, all wrapped button will be disabled.
-    is_disabled: Var[bool]
-
-    # The spacing between the buttons.
-    spacing: Var[int]
-
-    # "lg" | "md" | "sm" | "xs"
-    size: Var[LiteralButtonSize]
-
-    # "ghost" | "outline" | "solid" | "link" | "unstyled"
-    variant: Var[LiteralButtonVariant]

reflex/components/chakra/forms/button.pyi

@@ -1,262 +0,0 @@
-"""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, 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 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, 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,
-    ) -> "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.
-        """
-        ...
-
-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, 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,
-    ) -> "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.
-        """
-        ...

reflex/components/chakra/forms/checkbox.py

@@ -1,77 +0,0 @@
-"""A checkbox component."""
-
-from __future__ import annotations
-
-from reflex.components.chakra import (
-    ChakraComponent,
-    LiteralColorScheme,
-    LiteralTagSize,
-)
-from reflex.event import EventHandler
-from reflex.vars import Var
-
-
-class Checkbox(ChakraComponent):
-    """The Checkbox component is used in forms when a user needs to select multiple values from several options."""
-
-    tag = "Checkbox"
-
-    # Color scheme for checkbox.
-    # Options:
-    # "whiteAlpha" | "blackAlpha" | "gray" | "red" | "orange" | "yellow" | "green" | "teal" | "blue" | "cyan"
-    # | "purple" | "pink" | "linkedin" | "facebook" | "messenger" | "whatsapp" | "twitter" | "telegram"
-    color_scheme: Var[LiteralColorScheme]
-
-    # "sm" | "md" | "lg"
-    size: Var[LiteralTagSize]
-
-    # If true, the checkbox will be checked.
-    is_checked: Var[bool]
-
-    # If true, the checkbox will be disabled
-    is_disabled: Var[bool]
-
-    # If true and is_disabled is passed, the checkbox will remain tabbable but not interactive
-    is_focusable: Var[bool]
-
-    # If true, the checkbox will be indeterminate. This only affects the icon shown inside checkbox and does not modify the is_checked var.
-    is_indeterminate: Var[bool]
-
-    # If true, the checkbox is marked as invalid. Changes style of unchecked state.
-    is_invalid: Var[bool]
-
-    # If true, the checkbox will be readonly
-    is_read_only: Var[bool]
-
-    # If true, the checkbox input is marked as required, and required attribute will be added
-    is_required: Var[bool]
-
-    # The name of the input field in a checkbox (Useful for form submission).
-    name: Var[str]
-
-    # The value of the input field when checked (use is_checked prop for a bool)
-    value: Var[str] = Var.create("true", _var_is_string=True)  # type: ignore
-
-    # The spacing between the checkbox and its label text (0.5rem)
-    spacing: Var[str]
-
-    # Fired when the checkbox is checked or unchecked
-    on_change: EventHandler[lambda e0: [e0.target.checked]]
-
-
-class CheckboxGroup(ChakraComponent):
-    """A group of checkboxes."""
-
-    tag = "CheckboxGroup"
-
-    # The value of the checkbox group
-    value: Var[str]
-
-    # The initial value of the checkbox group
-    default_value: Var[str]
-
-    # If true, all wrapped checkbox inputs will be disabled
-    is_disabled: Var[bool]
-
-    # If true, input elements will receive checked attribute instead of isChecked. This assumes, you're using native radio inputs
-    is_native: Var[bool]

reflex/components/chakra/forms/checkbox.pyi

@@ -1,247 +0,0 @@
-"""Stub file for reflex/components/chakra/forms/checkbox.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 Checkbox(ChakraComponent):
-    @overload
-    @classmethod
-    def create(  # type: ignore
-        cls,
-        *children,
-        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,
-        size: Optional[
-            Union[Var[Literal["sm", "md", "lg"]], Literal["sm", "md", "lg"]]
-        ] = None,
-        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_indeterminate: 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,
-        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,
-    ) -> "Checkbox":
-        """Create the component.
-
-        Args:
-            *children: The children of the component.
-            color_scheme: Color scheme for checkbox.  Options:  "whiteAlpha" | "blackAlpha" | "gray" | "red" | "orange" | "yellow" | "green" | "teal" | "blue" | "cyan"  | "purple" | "pink" | "linkedin" | "facebook" | "messenger" | "whatsapp" | "twitter" | "telegram"
-            size: "sm" | "md" | "lg"
-            is_checked: If true, the checkbox will be checked.
-            is_disabled: If true, the checkbox will be disabled
-            is_focusable: If true and is_disabled is passed, the checkbox will remain tabbable but not interactive
-            is_indeterminate: If true, the checkbox will be indeterminate. This only affects the icon shown inside checkbox and does not modify the is_checked var.
-            is_invalid: If true, the checkbox is marked as invalid. Changes style of unchecked state.
-            is_read_only: If true, the checkbox will be readonly
-            is_required: If true, the checkbox input is marked as required, and required attribute will be added
-            name: The name of the input field in a checkbox (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 checkbox and its label text (0.5rem)
-            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 CheckboxGroup(ChakraComponent):
-    @overload
-    @classmethod
-    def create(  # type: ignore
-        cls,
-        *children,
-        value: Optional[Union[Var[str], str]] = None,
-        default_value: Optional[Union[Var[str], str]] = None,
-        is_disabled: Optional[Union[Var[bool], bool]] = None,
-        is_native: Optional[Union[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, 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,
-    ) -> "CheckboxGroup":
-        """Create the component.
-
-        Args:
-            *children: The children of the component.
-            value: The value of the checkbox group
-            default_value: The initial value of the checkbox group
-            is_disabled: If true, all wrapped checkbox inputs will be disabled
-            is_native: If true, input elements will receive checked attribute instead of isChecked. This assumes, you're using native radio inputs
-            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.
-        """
-        ...