Fix some docstrings in pyi (#1773)

This commit is contained in:
Thomas Brandého 2023-09-07 21:55:49 +02:00 committed by GitHub
parent 0ed055598f
commit 2d570b3bcd
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
109 changed files with 490 additions and 287 deletions

View File

@ -3,7 +3,7 @@
# This file was generated by `scripts/pyi_generator.py`!
# ------------------------------------------------------
from typing import Union, overload, Optional
from typing import Optional, Union, overload
from reflex.components.component import Component
from reflex.vars import Var, BaseVar, ComputedVar
from reflex.event import EventHandler, EventChain, EventSpec

View File

@ -3,9 +3,9 @@
# This file was generated by `scripts/pyi_generator.py`!
# ------------------------------------------------------
from typing import Union, overload, Optional
from reflex.components.component import Component
from typing import Optional, Union, overload
from reflex.components.libs.chakra import ChakraComponent
from reflex.components.component import Component
from reflex.vars import Var, BaseVar, ComputedVar
from reflex.event import EventHandler, EventChain, EventSpec

View File

@ -3,7 +3,7 @@
# This file was generated by `scripts/pyi_generator.py`!
# ------------------------------------------------------
from typing import Union, overload, Optional
from typing import Optional, Union, overload
from reflex.components.component import Component
from reflex.vars import Var, BaseVar, ComputedVar
from reflex.event import EventHandler, EventChain, EventSpec

View File

@ -3,7 +3,7 @@
# This file was generated by `scripts/pyi_generator.py`!
# ------------------------------------------------------
from typing import Union, overload, Optional
from typing import Optional, Union, overload
from reflex.components.component import Component
from reflex.vars import Var, BaseVar, ComputedVar
from reflex.event import EventHandler, EventChain, EventSpec

View File

@ -3,7 +3,7 @@
# This file was generated by `scripts/pyi_generator.py`!
# ------------------------------------------------------
from typing import Union, overload, Optional
from typing import Optional, Union, overload
from reflex.components.component import Component
from reflex.vars import Var, BaseVar, ComputedVar
from reflex.event import EventHandler, EventChain, EventSpec

View File

@ -3,7 +3,7 @@
# This file was generated by `scripts/pyi_generator.py`!
# ------------------------------------------------------
from typing import Union, overload, Optional
from typing import Optional, Union, overload
from reflex.components.component import Component
from reflex.vars import Var, BaseVar, ComputedVar
from reflex.event import EventHandler, EventChain, EventSpec

View File

@ -3,9 +3,9 @@
# This file was generated by `scripts/pyi_generator.py`!
# ------------------------------------------------------
from typing import Union, overload, Optional
from reflex.components.component import Component
from typing import Optional, Union, overload
from reflex.components.libs.chakra import ChakraComponent
from reflex.components.component import Component
from reflex.vars import Var, BaseVar, ComputedVar
from reflex.event import EventHandler, EventChain, EventSpec

View File

@ -3,9 +3,9 @@
# This file was generated by `scripts/pyi_generator.py`!
# ------------------------------------------------------
from typing import Optional, Union, overload, Dict
from reflex.components.component import Component
from typing import Dict, Optional, Union, overload
from reflex.components.libs.chakra import ChakraComponent
from reflex.components.component import Component
from reflex.vars import Var, BaseVar, ComputedVar
from reflex.event import EventHandler, EventChain, EventSpec

View File

@ -3,7 +3,7 @@
# This file was generated by `scripts/pyi_generator.py`!
# ------------------------------------------------------
from typing import Any, Optional, Union, overload, Dict, List
from typing import Any, Dict, List, Optional, Union, overload
from reflex.components.component import Component
from reflex.vars import Var, BaseVar, ComputedVar
from reflex.event import EventHandler, EventChain, EventSpec

View File

@ -3,9 +3,9 @@
# This file was generated by `scripts/pyi_generator.py`!
# ------------------------------------------------------
from typing import Union, overload, Optional
from reflex.components.component import Component
from typing import Optional, Union, overload
from reflex.components.libs.chakra import ChakraComponent
from reflex.components.component import Component
from reflex.vars import Var, BaseVar, ComputedVar
from reflex.event import EventHandler, EventChain, EventSpec

View File

@ -3,9 +3,9 @@
# This file was generated by `scripts/pyi_generator.py`!
# ------------------------------------------------------
from typing import Union, overload, Optional
from reflex.components.component import Component
from typing import Optional, Union, overload
from reflex.components.libs.chakra import ChakraComponent
from reflex.components.component import Component
from reflex.vars import Var, BaseVar, ComputedVar
from reflex.event import EventHandler, EventChain, EventSpec

View File

@ -25,9 +25,9 @@ class List(ChakraComponent):
"""Create a list component.
Args:
children: The children of the component.
*children: The children of the component.
items: A list of items to add to the list.
props: The properties of the component.
**props: The properties of the component.
Returns:
The list component.

View File

@ -3,9 +3,9 @@
# This file was generated by `scripts/pyi_generator.py`!
# ------------------------------------------------------
from typing import Union, overload, Optional
from reflex.components.component import Component
from typing import Optional, Union, overload
from reflex.components.libs.chakra import ChakraComponent
from reflex.components.component import Component
from reflex.vars import Var, BaseVar, ComputedVar
from reflex.event import EventHandler, EventChain, EventSpec
@ -16,9 +16,12 @@ class List(ChakraComponent):
"""Create a list component.
Args:
children: The children of the component.
*children: The children of the component.
spacing: The space between each list item
style_position: Shorthand prop for listStylePosition
style_type: Shorthand prop for listStyleType
items: A list of items to add to the list.
props: The properties of the component.
**props: The properties of the component.
Returns:
The list component.
@ -50,9 +53,9 @@ class OrderedList(List):
"""Create a list component.
Args:
children: The children of the component.
*children: The children of the component.
items: A list of items to add to the list.
props: The properties of the component.
**props: The properties of the component.
Returns:
The list component.
@ -66,9 +69,9 @@ class UnorderedList(List):
"""Create a list component.
Args:
children: The children of the component.
*children: The children of the component.
items: A list of items to add to the list.
props: The properties of the component.
**props: The properties of the component.
Returns:
The list component.

View File

@ -17,12 +17,12 @@ class Stat(ChakraComponent):
"""Create a stat component.
Args:
children: The children of the component.
*children: The children of the component.
label: A label for the stat component.
number: The value of the stat component.
help_text: A text added to the stat component.
arrow_type: The type of the arrow ("increase", "decrease", None)
props: The properties of the component.
**props: The properties of the component.
Returns:
The stat component.

View File

@ -3,9 +3,9 @@
# This file was generated by `scripts/pyi_generator.py`!
# ------------------------------------------------------
from typing import Union, overload, Optional
from reflex.components.component import Component
from typing import Optional, Union, overload
from reflex.components.libs.chakra import ChakraComponent
from reflex.components.component import Component
from reflex.vars import Var, BaseVar, ComputedVar
from reflex.event import EventHandler, EventChain, EventSpec
@ -16,12 +16,12 @@ class Stat(ChakraComponent):
"""Create a stat component.
Args:
children: The children of the component.
*children: The children of the component.
label: A label for the stat component.
number: The value of the stat component.
help_text: A text added to the stat component.
arrow_type: The type of the arrow ("increase", "decrease", None)
props: The properties of the component.
**props: The properties of the component.
Returns:
The stat component.

View File

@ -31,12 +31,12 @@ class Table(ChakraComponent):
"""Create a table component.
Args:
children: The children of the component.
*children: The children of the component.
caption: The caption of the table component.
headers: The headers of the table component.
rows: The rows of the table component.
footers: The footers of the table component.
props: The properties of the component.
**props: The properties of the component.
Returns:
The table component.
@ -71,9 +71,9 @@ class Thead(ChakraComponent):
"""Create a table header component.
Args:
children: The children of the component.
props: The properties of the component.
*children: The children of the component.
headers (list, optional): List of headers. Defaults to None.
**props: The properties of the component.
Returns:
The table header component.
@ -96,9 +96,9 @@ class Tbody(ChakraComponent):
"""Create a table body component.
Args:
children: The children of the component.
props: The properties of the component.
*children: The children of the component.
rows (list[list], optional): The rows of the table body. Defaults to None.
**props: The properties of the component.
Returns:
Component: _description_
@ -130,9 +130,9 @@ class Tfoot(ChakraComponent):
"""Create a table footer component.
Args:
children: The children of the component.
props: The properties of the component.
*children: The children of the component.
footers (list, optional): List of footers. Defaults to None.
**props: The properties of the component.
Returns:
The table footer component.
@ -155,10 +155,10 @@ class Tr(ChakraComponent):
"""Create a table row component.
Args:
children: The children of the component.
props: The properties of the component.
*children: The children of the component.
cell_type: the type of cells in this table row. "header" or "data". Defaults to None.
cells: The cells value to add in the table row. Defaults to None.
**props: The properties of the component.
Returns:
The table row component

View File

@ -3,9 +3,9 @@
# This file was generated by `scripts/pyi_generator.py`!
# ------------------------------------------------------
from typing import Union, overload, Optional, List
from reflex.components.component import Component
from typing import List, Optional, Union, overload
from reflex.components.libs.chakra import ChakraComponent
from reflex.components.component import Component
from reflex.vars import Var, BaseVar, ComputedVar
from reflex.event import EventHandler, EventChain, EventSpec
@ -16,12 +16,16 @@ class Table(ChakraComponent):
"""Create a table component.
Args:
children: The children of the component.
*children: The children of the component.
color_scheme: The color scheme of the table
variant: The variant of the table style to use
size: The size of the table
placement: The placement of the table caption.
caption: The caption of the table component.
headers: The headers of the table component.
rows: The rows of the table component.
footers: The footers of the table component.
props: The properties of the component.
**props: The properties of the component.
Returns:
The table component.
@ -35,9 +39,10 @@ class Thead(ChakraComponent):
"""Create a table header component.
Args:
children: The children of the component.
props: The properties of the component.
*children: The children of the component.
invalid_children: invalid children components
headers (list, optional): List of headers. Defaults to None.
**props: The properties of the component.
Returns:
The table header component.
@ -51,9 +56,10 @@ class Tbody(ChakraComponent):
"""Create a table body component.
Args:
children: The children of the component.
props: The properties of the component.
*children: The children of the component.
invalid_children: invalid children components
rows (list[list], optional): The rows of the table body. Defaults to None.
**props: The properties of the component.
Returns:
Component: _description_
@ -67,9 +73,10 @@ class Tfoot(ChakraComponent):
"""Create a table footer component.
Args:
children: The children of the component.
props: The properties of the component.
*children: The children of the component.
invalid_children: invalid children components
footers (list, optional): List of footers. Defaults to None.
**props: The properties of the component.
Returns:
The table footer component.
@ -83,10 +90,11 @@ class Tr(ChakraComponent):
"""Create a table row component.
Args:
children: The children of the component.
props: The properties of the component.
*children: The children of the component.
invalid_children: invalid children components
cell_type: the type of cells in this table row. "header" or "data". Defaults to None.
cells: The cells value to add in the table row. Defaults to None.
**props: The properties of the component.
Returns:
The table row component

View File

@ -3,9 +3,9 @@
# This file was generated by `scripts/pyi_generator.py`!
# ------------------------------------------------------
from typing import Union, overload, Optional
from reflex.components.component import Component
from typing import Optional, Union, overload
from reflex.components.libs.chakra import ChakraComponent
from reflex.components.component import Component
from reflex.vars import Var, BaseVar, ComputedVar
from reflex.event import EventHandler, EventChain, EventSpec

View File

@ -40,12 +40,12 @@ class Accordion(ChakraComponent):
"""Create an accordion component.
Args:
children: The children of the component.
*children: The children of the component.
items: The items of the accordion component: list of tuples (label,panel)
icon_pos: The position of the arrow icon of the accordion. "right", "left" or None
allow_multiple: The allow_multiple property of the accordion. (True or False)
allow_toggle: The allow_toggle property of the accordion. (True or False)
props: The properties of the component.
**props: The properties of the component.
Returns:
The accordion component

View File

@ -3,9 +3,9 @@
# This file was generated by `scripts/pyi_generator.py`!
# ------------------------------------------------------
from typing import Optional, Union, overload, List
from reflex.components.component import Component
from typing import List, Optional, Union, overload
from reflex.components.libs.chakra import ChakraComponent
from reflex.components.component import Component
from reflex.vars import Var, BaseVar, ComputedVar
from reflex.event import EventHandler, EventChain, EventSpec
@ -16,12 +16,17 @@ class Accordion(ChakraComponent):
"""Create an accordion component.
Args:
children: The children of the component.
*children: The children of the component.
allow_multiple: If true, multiple accordion items can be expanded at once.
allow_toggle: If true, any expanded accordion item can be collapsed again.
default_index: The initial index(es) of the expanded accordion item(s).
index: The index(es) of the expanded accordion item
reduce_motion: If true, height animation and transitions will be disabled.
items: The items of the accordion component: list of tuples (label,panel)
icon_pos: The position of the arrow icon of the accordion. "right", "left" or None
allow_multiple: The allow_multiple property of the accordion. (True or False)
allow_toggle: The allow_toggle property of the accordion. (True or False)
props: The properties of the component.
**props: The properties of the component.
Returns:
The accordion component

View File

@ -43,9 +43,9 @@ class Tabs(ChakraComponent):
"""Create a tab component.
Args:
children: The children of the component.
*children: The children of the component.
items: The items for the tabs component, a list of tuple (label, panel)
props: The properties of the component.
**props: The properties of the component.
Returns:
The tab component

View File

@ -3,9 +3,9 @@
# This file was generated by `scripts/pyi_generator.py`!
# ------------------------------------------------------
from typing import Optional, Union, overload, Tuple, List
from reflex.components.component import Component
from typing import List, Optional, Tuple, Union, overload
from reflex.components.libs.chakra import ChakraComponent
from reflex.components.component import Component
from reflex.vars import Var, BaseVar, ComputedVar
from reflex.event import EventHandler, EventChain, EventSpec
@ -16,9 +16,17 @@ class Tabs(ChakraComponent):
"""Create a tab component.
Args:
children: The children of the component.
*children: The children of the component.
align: The alignment of the tabs ("center" | "end" | "start").
default_index: The initial index of the selected tab (in uncontrolled mode).
id_: The id of the tab.
is_fitted: If true, tabs will stretch to width of the tablist.
is_lazy: Performance booster. If true, rendering of the tab panel's will be deferred until it is selected.
is_manual: If true, the tabs will be manually activated and display its panel by pressing Space or Enter. If false, the tabs will be automatically activated and their panel is displayed when they receive focus.
orientation: The orientation of the tab list.
variant: "line" | "enclosed" | "enclosed-colored" | "soft-rounded" | "solid-rounded" | "unstyled"
items: The items for the tabs component, a list of tuple (label, panel)
props: The properties of the component.
**props: The properties of the component.
Returns:
The tab component

View File

@ -3,9 +3,9 @@
# This file was generated by `scripts/pyi_generator.py`!
# ------------------------------------------------------
from typing import Union, overload, Optional
from reflex.components.component import Component
from typing import Optional, Union, overload
from reflex.components.libs.chakra import ChakraComponent
from reflex.components.component import Component
from reflex.vars import Var, BaseVar, ComputedVar
from reflex.event import EventHandler, EventChain, EventSpec

View File

@ -3,9 +3,9 @@
# This file was generated by `scripts/pyi_generator.py`!
# ------------------------------------------------------
from typing import Union, overload, Optional
from reflex.components.component import Component
from typing import Optional, Union, overload
from reflex.components.libs.chakra import ChakraComponent
from reflex.components.component import Component
from reflex.vars import Var, BaseVar, ComputedVar
from reflex.event import EventHandler, EventChain, EventSpec

View File

@ -23,11 +23,11 @@ class Alert(ChakraComponent):
"""Create an alert component.
Args:
children: The children of the component.
*children: The children of the component.
icon: The icon of the alert.
title: The title of the alert.
desc: The description of the alert
props: The properties of the component.
**props: The properties of the component.
Returns:
The alert component.

View File

@ -3,9 +3,9 @@
# This file was generated by `scripts/pyi_generator.py`!
# ------------------------------------------------------
from typing import Union, overload, Optional
from reflex.components.component import Component
from typing import Optional, Union, overload
from reflex.components.libs.chakra import ChakraComponent
from reflex.components.component import Component
from reflex.vars import Var, BaseVar, ComputedVar
from reflex.event import EventHandler, EventChain, EventSpec
@ -16,11 +16,13 @@ class Alert(ChakraComponent):
"""Create an alert component.
Args:
children: The children of the component.
*children: The children of the component.
status: The status of the alert ("success" | "info" | "warning" | "error")
variant: "subtle" | "left-accent" | "top-accent" | "solid"
icon: The icon of the alert.
title: The title of the alert.
desc: The description of the alert
props: The properties of the component.
**props: The properties of the component.
Returns:
The alert component.

View File

@ -42,9 +42,9 @@ class CircularProgress(ChakraComponent):
"""Create a circular progress component.
Args:
children: the children of the component.
*children: the children of the component.
label: A label to add in the circular progress. Defaults to None.
props: the props of the component.
**props: the props of the component.
Returns:
The circular progress component.

View File

@ -3,9 +3,9 @@
# This file was generated by `scripts/pyi_generator.py`!
# ------------------------------------------------------
from typing import Union, overload, Optional
from reflex.components.component import Component
from typing import Optional, Union, overload
from reflex.components.libs.chakra import ChakraComponent
from reflex.components.component import Component
from reflex.vars import Var, BaseVar, ComputedVar
from reflex.event import EventHandler, EventChain, EventSpec
@ -16,9 +16,18 @@ class CircularProgress(ChakraComponent):
"""Create a circular progress component.
Args:
children: the children of the component.
*children: the children of the component.
cap_is_round: If true, the cap of the progress indicator will be rounded.
is_indeterminate: If true, the progress will be indeterminate and the value prop will be ignored
max_: Maximum value defining 100% progress made (must be higher than 'min')
min_: Minimum value defining 'no progress' (must be lower than 'max')
thickness: This defines the stroke width of the svg circle.
track_color: The color name of the progress track. Use a color key in the theme object
value: Current progress (must be between min/max).
value_text: The desired valueText to use in place of the value.
color: The color name of the progress bar
label: A label to add in the circular progress. Defaults to None.
props: the props of the component.
**props: the props of the component.
Returns:
The circular progress component.

View File

@ -3,9 +3,9 @@
# This file was generated by `scripts/pyi_generator.py`!
# ------------------------------------------------------
from typing import Union, overload, Optional
from reflex.components.component import Component
from typing import Optional, Union, overload
from reflex.components.libs.chakra import ChakraComponent
from reflex.components.component import Component
from reflex.vars import Var, BaseVar, ComputedVar
from reflex.event import EventHandler, EventChain, EventSpec

View File

@ -3,9 +3,9 @@
# This file was generated by `scripts/pyi_generator.py`!
# ------------------------------------------------------
from typing import Union, overload, Optional
from reflex.components.component import Component
from typing import Optional, Union, overload
from reflex.components.libs.chakra import ChakraComponent
from reflex.components.component import Component
from reflex.vars import Var, BaseVar, ComputedVar
from reflex.event import EventHandler, EventChain, EventSpec

View File

@ -3,9 +3,9 @@
# This file was generated by `scripts/pyi_generator.py`!
# ------------------------------------------------------
from typing import Union, overload, Optional
from reflex.components.component import Component
from typing import Optional, Union, overload
from reflex.components.libs.chakra import ChakraComponent
from reflex.components.component import Component
from reflex.vars import Var, BaseVar, ComputedVar
from reflex.event import EventHandler, EventChain, EventSpec

View File

@ -3,9 +3,9 @@
# This file was generated by `scripts/pyi_generator.py`!
# ------------------------------------------------------
from typing import Union, overload, Optional, List
from reflex.components.component import Component
from typing import List, Optional, Union, overload
from reflex.components.libs.chakra import ChakraComponent
from reflex.components.component import Component
from reflex.vars import Var, BaseVar, ComputedVar
from reflex.event import EventHandler, EventChain, EventSpec

View File

@ -3,9 +3,9 @@
# This file was generated by `scripts/pyi_generator.py`!
# ------------------------------------------------------
from typing import Union, overload, Dict, Optional
from reflex.components.component import Component
from typing import Dict, Optional, Union, overload
from reflex.components.libs.chakra import ChakraComponent
from reflex.components.component import Component
from reflex.vars import Var, BaseVar, ComputedVar
from reflex.event import EventHandler, EventChain, EventSpec

View File

@ -3,12 +3,12 @@
# This file was generated by `scripts/pyi_generator.py`!
# ------------------------------------------------------
from typing import Union, overload, Any, Optional
from reflex.components.media.icon import Icon
from reflex.components.component import Component
from reflex.components.forms.switch import Switch
from reflex.components.layout.cond import Cond
from typing import Any, Optional, Union, overload
from reflex.components.forms.button import Button
from reflex.components.component import Component
from reflex.components.layout.cond import Cond
from reflex.components.media.icon import Icon
from reflex.components.forms.switch import Switch
from reflex.vars import Var, BaseVar, ComputedVar
from reflex.event import EventHandler, EventChain, EventSpec

View File

@ -3,7 +3,7 @@
# This file was generated by `scripts/pyi_generator.py`!
# ------------------------------------------------------
from typing import Union, overload, Set, Optional
from typing import Optional, Set, Union, overload
from reflex.components.component import Component
from reflex.vars import Var, BaseVar, ComputedVar
from reflex.event import EventHandler, EventChain, EventSpec

View File

@ -3,7 +3,7 @@
# This file was generated by `scripts/pyi_generator.py`!
# ------------------------------------------------------
from typing import Union, overload, Optional
from typing import Optional, Union, overload
from reflex.components.component import Component
from reflex.components.forms.input import Input
from reflex.vars import Var, BaseVar, ComputedVar
@ -16,8 +16,9 @@ class DatePicker(Input):
"""Create an Input component.
Args:
children: The children of the component.
props: The properties of the component.
*children: The children of the component.
type_: The type of input.
**props: The properties of the component.
Returns:
The component.

View File

@ -3,7 +3,7 @@
# This file was generated by `scripts/pyi_generator.py`!
# ------------------------------------------------------
from typing import Union, overload, Optional
from typing import Optional, Union, overload
from reflex.components.component import Component
from reflex.components.forms.input import Input
from reflex.vars import Var, BaseVar, ComputedVar
@ -16,8 +16,9 @@ class DateTimePicker(Input):
"""Create an Input component.
Args:
children: The children of the component.
props: The properties of the component.
*children: The children of the component.
type_: The type of input.
**props: The properties of the component.
Returns:
The component.

View File

@ -3,7 +3,7 @@
# This file was generated by `scripts/pyi_generator.py`!
# ------------------------------------------------------
from typing import Union, overload, Any, Optional
from typing import Any, Optional, Union, overload
from reflex.components.component import Component
from reflex.vars import Var, BaseVar, ComputedVar
from reflex.event import EventHandler, EventChain, EventSpec

View File

@ -3,9 +3,9 @@
# This file was generated by `scripts/pyi_generator.py`!
# ------------------------------------------------------
from typing import Union, overload, Dict, Optional
from reflex.components.component import Component
from typing import Dict, Optional, Union, overload
from reflex.components.libs.chakra import ChakraComponent
from reflex.components.component import Component
from reflex.vars import Var, BaseVar, ComputedVar
from reflex.event import EventHandler, EventChain, EventSpec

View File

@ -3,7 +3,7 @@
# This file was generated by `scripts/pyi_generator.py`!
# ------------------------------------------------------
from typing import Union, overload, Optional
from typing import Optional, Union, overload
from reflex.components.component import Component
from reflex.components.forms.input import Input
from reflex.vars import Var, BaseVar, ComputedVar
@ -16,8 +16,9 @@ class Email(Input):
"""Create an Input component.
Args:
children: The children of the component.
props: The properties of the component.
*children: The children of the component.
type_: The type of input.
**props: The properties of the component.
Returns:
The component.

View File

@ -69,12 +69,12 @@ class FormControl(ChakraComponent):
"""Create a form control component.
Args:
children: The children of the form control.
*children: The children of the form control.
label: The label of the form control.
input: The input of the form control.
help_text: The help text of the form control.
error_message: The error message of the form control.
props: The properties of the form control.
**props: The properties of the form control.
Raises:
AttributeError: raise an error if missing required kwargs.

View File

@ -3,9 +3,9 @@
# This file was generated by `scripts/pyi_generator.py`!
# ------------------------------------------------------
from typing import Union, overload, Dict, Optional
from reflex.components.component import Component
from typing import Dict, Optional, Union, overload
from reflex.components.libs.chakra import ChakraComponent
from reflex.components.component import Component
from reflex.vars import Var, BaseVar, ComputedVar
from reflex.event import EventHandler, EventChain, EventSpec
@ -35,12 +35,17 @@ class FormControl(ChakraComponent):
"""Create a form control component.
Args:
children: The children of the form control.
*children: The children of the form control.
is_disabled: If true, the form control will be disabled.
is_invalid: If true, the form control will be invalid.
is_read_only: If true, the form control will be readonly
is_required: If true, the form control will be required.
label: The label text used to inform users as to what information is requested for a text field.
label: The label of the form control.
input: The input of the form control.
help_text: The help text of the form control.
error_message: The error message of the form control.
props: The properties of the form control.
**props: The properties of the form control.
Raises:
AttributeError: raise an error if missing required kwargs.

View File

@ -3,9 +3,9 @@
# This file was generated by `scripts/pyi_generator.py`!
# ------------------------------------------------------
from typing import Union, overload, Optional
from reflex.components.typography.text import Text
from typing import Optional, Union, overload
from reflex.components.component import Component
from reflex.components.typography.text import Text
from reflex.vars import Var, BaseVar, ComputedVar
from reflex.event import EventHandler, EventChain, EventSpec

View File

@ -75,8 +75,8 @@ class Input(ChakraComponent):
"""Create an Input component.
Args:
children: The children of the component.
props: The properties of the component.
*children: The children of the component.
**props: The properties of the component.
Returns:
The component.

View File

@ -3,9 +3,9 @@
# This file was generated by `scripts/pyi_generator.py`!
# ------------------------------------------------------
from typing import Union, overload, Dict, Optional
from reflex.components.component import Component
from typing import Dict, Optional, Union, overload
from reflex.components.libs.chakra import ChakraComponent
from reflex.components.component import Component
from reflex.vars import Var, BaseVar, ComputedVar
from reflex.event import EventHandler, EventChain, EventSpec
@ -16,8 +16,20 @@ class Input(ChakraComponent):
"""Create an Input component.
Args:
children: The children of the component.
props: The properties of the component.
*children: The children of the component.
value: State var to bind the input.
default_value: The default value of the input.
placeholder: The placeholder text.
type_: The type of input.
error_border_color: The border color when the input is invalid.
focus_border_color: The border color when the input is focused.
is_disabled: If true, the form control will be disabled. This has 2 side effects - The FormLabel will have `data-disabled` attribute - The form element (e.g, Input) will be disabled
is_invalid: If true, the form control will be invalid. This has 2 side effects - The FormLabel and FormErrorIcon will have `data-invalid` set to true - The form element (e.g, Input) will have `aria-invalid` set to true
is_read_only: If true, the form control will be readonly.
is_required: If true, the form control will be required. This has 2 side effects - The FormLabel will show a required indicator - The form element (e.g, Input) will have `aria-required` set to true
variant: "outline" | "filled" | "flushed" | "unstyled"
size: "lg" | "md" | "sm" | "xs"
**props: The properties of the component.
Returns:
The component.

View File

@ -3,9 +3,9 @@
# This file was generated by `scripts/pyi_generator.py`!
# ------------------------------------------------------
from typing import Union, overload, Dict, Optional
from reflex.components.component import Component
from typing import Dict, Optional, Union, overload
from reflex.components.libs.chakra import ChakraComponent
from reflex.components.component import Component
from reflex.vars import Var, BaseVar, ComputedVar
from reflex.event import EventHandler, EventChain, EventSpec

View File

@ -3,7 +3,7 @@
# This file was generated by `scripts/pyi_generator.py`!
# ------------------------------------------------------
from typing import Union, overload, Optional
from typing import Optional, Union, overload
from reflex.components.component import Component
from reflex.components.forms.input import Input
from reflex.vars import Var, BaseVar, ComputedVar
@ -16,8 +16,9 @@ class Password(Input):
"""Create an Input component.
Args:
children: The children of the component.
props: The properties of the component.
*children: The children of the component.
type_: The type of input.
**props: The properties of the component.
Returns:
The component.

View File

@ -3,9 +3,9 @@
# This file was generated by `scripts/pyi_generator.py`!
# ------------------------------------------------------
from typing import Optional, Union, overload, Dict
from reflex.components.component import Component
from typing import Dict, Optional, Union, overload
from reflex.components.libs.chakra import ChakraComponent
from reflex.components.component import Component
from reflex.vars import Var, BaseVar, ComputedVar
from reflex.event import EventHandler, EventChain, EventSpec

View File

@ -3,10 +3,10 @@
# This file was generated by `scripts/pyi_generator.py`!
# ------------------------------------------------------
from typing import Any, Optional, Union, overload, Dict, List
from reflex.components.typography.text import Text
from reflex.components.component import Component
from typing import Any, Dict, List, Optional, Union, overload
from reflex.components.libs.chakra import ChakraComponent
from reflex.components.component import Component
from reflex.components.typography.text import Text
from reflex.vars import Var, BaseVar, ComputedVar
from reflex.event import EventHandler, EventChain, EventSpec

View File

@ -83,8 +83,8 @@ class RangeSlider(ChakraComponent):
If no children are provided, a default RangeSlider will be created.
Args:
children: The children of the component.
props: The properties of the component.
*children: The children of the component.
**props: The properties of the component.
Returns:
The RangeSlider component.

View File

@ -3,9 +3,9 @@
# This file was generated by `scripts/pyi_generator.py`!
# ------------------------------------------------------
from typing import Optional, Union, overload, Dict, List
from reflex.components.component import Component
from typing import Dict, List, Optional, Union, overload
from reflex.components.libs.chakra import ChakraComponent
from reflex.components.component import Component
from reflex.vars import Var, BaseVar, ComputedVar
from reflex.event import EventHandler, EventChain, EventSpec
@ -18,8 +18,18 @@ class RangeSlider(ChakraComponent):
If no children are provided, a default RangeSlider will be created.
Args:
children: The children of the component.
props: The properties of the component.
*children: The children of the component.
value: State var to bind the the input.
default_value: The default values.
direction: The writing mode ("ltr" | "rtl")
focus_thumb_on_change: If false, the slider handle will not capture focus when value changes.
is_disabled: If true, the slider will be disabled
is_read_only: If true, the slider will be in `read-only` state.
is_reversed: If true, the value will be incremented or decremented in reverse.
min_: The minimum value of the slider.
max_: The maximum value of the slider.
min_steps_between_thumbs: The minimum distance between slider thumbs. Useful for preventing the thumbs from being too close together.
**props: The properties of the component.
Returns:
The RangeSlider component.

View File

@ -3,10 +3,10 @@
# This file was generated by `scripts/pyi_generator.py`!
# ------------------------------------------------------
from typing import Any, Optional, Union, overload, Dict, List
from reflex.components.typography.text import Text
from reflex.components.component import Component
from typing import Any, Dict, List, Optional, Union, overload
from reflex.components.libs.chakra import ChakraComponent
from reflex.components.component import Component
from reflex.components.typography.text import Text
from reflex.vars import Var, BaseVar, ComputedVar
from reflex.event import EventHandler, EventChain, EventSpec

View File

@ -83,8 +83,8 @@ class Slider(ChakraComponent):
If no children are provided, a default slider will be created.
Args:
children: The children of the component.
props: The properties of the component.
*children: The children of the component.
**props: The properties of the component.
Returns:
The slider component.

View File

@ -3,9 +3,9 @@
# This file was generated by `scripts/pyi_generator.py`!
# ------------------------------------------------------
from typing import Union, overload, Dict, Optional
from reflex.components.component import Component
from typing import Dict, Optional, Union, overload
from reflex.components.libs.chakra import ChakraComponent
from reflex.components.component import Component
from reflex.vars import Var, BaseVar, ComputedVar
from reflex.event import EventHandler, EventChain, EventSpec
@ -18,8 +18,25 @@ class Slider(ChakraComponent):
If no children are provided, a default slider will be created.
Args:
children: The children of the component.
props: The properties of the component.
*children: The children of the component.
value: State var to bind the input.
color_scheme: The color scheme.
default_value: The placeholder text.
direction: The writing mode ("ltr" | "rtl")
focus_thumb_on_change: If false, the slider handle will not capture focus when value changes.
is_disabled: If true, the slider will be disabled
is_read_only: If true, the slider will be in `read-only` state.
is_reversed: If true, the value will be incremented or decremented in reverse.
min_: The minimum value of the slider.
max_: The maximum value of the slider.
step: The step in which increments/decrements have to be made
min_steps_between_thumbs: The minimum distance between slider thumbs. Useful for preventing the thumbs from being too close together.
orientation: Oreintation of the slider vertical | horizontal.
min_h: Minimum height of the slider.
min_w: Minimum width of the slider.
max_h: Maximum height of the slider.
max_w: Maximum width of the slider.
**props: The properties of the component.
Returns:
The slider component.

View File

@ -3,9 +3,9 @@
# This file was generated by `scripts/pyi_generator.py`!
# ------------------------------------------------------
from typing import Union, overload, Dict, Optional
from reflex.components.component import Component
from typing import Dict, Optional, Union, overload
from reflex.components.libs.chakra import ChakraComponent
from reflex.components.component import Component
from reflex.vars import Var, BaseVar, ComputedVar
from reflex.event import EventHandler, EventChain, EventSpec

View File

@ -62,8 +62,8 @@ class TextArea(ChakraComponent):
"""Create an Input component.
Args:
children: The children of the component.
props: The properties of the component.
*children: The children of the component.
**props: The properties of the component.
Returns:
The component.

View File

@ -3,9 +3,9 @@
# This file was generated by `scripts/pyi_generator.py`!
# ------------------------------------------------------
from typing import Union, overload, Dict, Optional
from reflex.components.component import Component
from typing import Dict, Optional, Union, overload
from reflex.components.libs.chakra import ChakraComponent
from reflex.components.component import Component
from reflex.vars import Var, BaseVar, ComputedVar
from reflex.event import EventHandler, EventChain, EventSpec
@ -16,8 +16,18 @@ class TextArea(ChakraComponent):
"""Create an Input component.
Args:
children: The children of the component.
props: The properties of the component.
*children: The children of the component.
value: State var to bind the input.
default_value: The default value of the textarea.
placeholder: The placeholder text.
error_border_color: The border color when the input is invalid.
focus_border_color: The border color when the input is focused.
is_disabled: If true, the form control will be disabled.
is_invalid: If true, the form control will be invalid.
is_read_only: If true, the form control will be read-only.
is_required: If true, the form control will be required.
variant: "outline" | "filled" | "flushed" | "unstyled"
**props: The properties of the component.
Returns:
The component.

View File

@ -63,8 +63,8 @@ class Upload(Component):
"""Create an upload component.
Args:
children: The children of the component.
props: The properties of the component.
*children: The children of the component.
**props: The properties of the component.
Returns:
The upload component.

View File

@ -3,7 +3,7 @@
# This file was generated by `scripts/pyi_generator.py`!
# ------------------------------------------------------
from typing import Optional, Union, overload, Dict, List
from typing import Dict, List, Optional, Union, overload
from reflex.components.component import Component
from reflex.vars import Var, BaseVar, ComputedVar
from reflex.event import EventHandler, EventChain, EventSpec
@ -19,11 +19,22 @@ class Upload(Component):
def create(cls, *children, accept: Optional[Union[Var[Optional[Dict[str, List]]], Optional[Dict[str, List]]]] = None, disabled: Optional[Union[Var[bool], bool]] = None, max_files: Optional[Union[Var[int], int]] = None, max_size: Optional[Union[Var[int], int]] = None, min_size: Optional[Union[Var[int], int]] = None, multiple: Optional[Union[Var[bool], bool]] = None, no_click: Optional[Union[Var[bool], bool]] = None, no_drag: Optional[Union[Var[bool], bool]] = None, no_keyboard: Optional[Union[Var[bool], bool]] = 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_drop: 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) -> "Upload": # type: ignore
"""Create an upload component.
Args:
children: The children of the component.
props: The properties of the component.
Args:
*children: The children of the component.
accept: The list of accepted file types. This should be a dictionary of MIME types as keys and array of file formats as
values.
supported MIME types: https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types
disabled: Whether the dropzone is disabled.
max_files: The maximum number of files that can be uploaded.
max_size: The maximum file size (bytes) that can be uploaded.
min_size: The minimum file size (bytes) that can be uploaded.
multiple: Whether to allow multiple files to be uploaded.
no_click: Whether to disable click to upload.
no_drag: Whether to disable drag and drop.
no_keyboard: Whether to disable using the space/enter keys to upload.
**props: The properties of the component.
Returns:
The upload component.
Returns:
The upload component.
"""
...

View File

@ -3,9 +3,9 @@
# This file was generated by `scripts/pyi_generator.py`!
# ------------------------------------------------------
from typing import Optional, Union, overload, Dict, List
from reflex.components.component import NoSSRComponent
from typing import Dict, List, Optional, Union, overload
from reflex.components.component import Component
from reflex.components.component import NoSSRComponent
from reflex.vars import Var, BaseVar, ComputedVar
from reflex.event import EventHandler, EventChain, EventSpec

View File

@ -3,7 +3,7 @@
# This file was generated by `scripts/pyi_generator.py`!
# ------------------------------------------------------
from typing import Union, overload, Any, Optional, Dict, List
from typing import Any, Dict, List, Optional, Union, overload
from reflex.components.component import Component
from reflex.vars import Var, BaseVar, ComputedVar
from reflex.event import EventHandler, EventChain, EventSpec

View File

@ -3,9 +3,9 @@
# This file was generated by `scripts/pyi_generator.py`!
# ------------------------------------------------------
from typing import Union, overload, Optional
from reflex.components.component import Component
from typing import Optional, Union, overload
from reflex.components.libs.chakra import ChakraComponent
from reflex.components.component import Component
from reflex.vars import Var, BaseVar, ComputedVar
from reflex.event import EventHandler, EventChain, EventSpec

View File

@ -3,9 +3,9 @@
# This file was generated by `scripts/pyi_generator.py`!
# ------------------------------------------------------
from typing import Union, overload, Optional
from reflex.components.component import Component
from typing import Optional, Union, overload
from reflex.components.libs.chakra import ChakraComponent
from reflex.components.component import Component
from reflex.vars import Var, BaseVar, ComputedVar
from reflex.event import EventHandler, EventChain, EventSpec

View File

@ -3,9 +3,9 @@
# This file was generated by `scripts/pyi_generator.py`!
# ------------------------------------------------------
from typing import Union, overload, Optional
from reflex.components.component import Component
from typing import Optional, Union, overload
from reflex.components.libs.chakra import ChakraComponent
from reflex.components.component import Component
from reflex.vars import Var, BaseVar, ComputedVar
from reflex.event import EventHandler, EventChain, EventSpec

View File

@ -3,9 +3,9 @@
# This file was generated by `scripts/pyi_generator.py`!
# ------------------------------------------------------
from typing import Union, overload, Optional
from reflex.components.component import Component
from typing import Optional, Union, overload
from reflex.components.libs.chakra import ChakraComponent
from reflex.components.component import Component
from reflex.vars import Var, BaseVar, ComputedVar
from reflex.event import EventHandler, EventChain, EventSpec

View File

@ -3,9 +3,9 @@
# This file was generated by `scripts/pyi_generator.py`!
# ------------------------------------------------------
from typing import Union, overload, Optional
from reflex.components.component import Component
from typing import Optional, Union, overload
from reflex.components.libs.chakra import ChakraComponent
from reflex.components.component import Component
from reflex.vars import Var, BaseVar, ComputedVar
from reflex.event import EventHandler, EventChain, EventSpec

View File

@ -3,9 +3,9 @@
# This file was generated by `scripts/pyi_generator.py`!
# ------------------------------------------------------
from typing import Optional, Union, overload, List
from reflex.components.component import Component
from typing import List, Optional, Union, overload
from reflex.components.libs.chakra import ChakraComponent
from reflex.components.component import Component
from reflex.vars import Var, BaseVar, ComputedVar
from reflex.event import EventHandler, EventChain, EventSpec

View File

@ -3,7 +3,7 @@
# This file was generated by `scripts/pyi_generator.py`!
# ------------------------------------------------------
from typing import Union, overload, Optional
from typing import Optional, Union, overload
from reflex.components.component import Component
from reflex.vars import Var, BaseVar, ComputedVar
from reflex.event import EventHandler, EventChain, EventSpec

View File

@ -3,9 +3,9 @@
# This file was generated by `scripts/pyi_generator.py`!
# ------------------------------------------------------
from typing import Union, overload, Optional, List
from reflex.components.component import Component
from typing import List, Optional, Union, overload
from reflex.components.libs.chakra import ChakraComponent
from reflex.components.component import Component
from reflex.vars import Var, BaseVar, ComputedVar
from reflex.event import EventHandler, EventChain, EventSpec

View File

@ -3,9 +3,9 @@
# This file was generated by `scripts/pyi_generator.py`!
# ------------------------------------------------------
from typing import Union, overload, Any, Optional
from reflex.components.component import Component
from typing import Any, Optional, Union, overload
from reflex.components.layout.box import Box
from reflex.components.component import Component
from reflex.vars import Var, BaseVar, ComputedVar
from reflex.event import EventHandler, EventChain, EventSpec

View File

@ -3,9 +3,9 @@
# This file was generated by `scripts/pyi_generator.py`!
# ------------------------------------------------------
from typing import Union, overload, Optional
from reflex.components.component import Component
from typing import Optional, Union, overload
from reflex.components.libs.chakra import ChakraComponent
from reflex.components.component import Component
from reflex.vars import Var, BaseVar, ComputedVar
from reflex.event import EventHandler, EventChain, EventSpec

View File

@ -3,9 +3,9 @@
# This file was generated by `scripts/pyi_generator.py`!
# ------------------------------------------------------
from typing import Union, overload, Optional
from reflex.components.component import Component
from typing import Optional, Union, overload
from reflex.components.libs.chakra import ChakraComponent
from reflex.components.component import Component
from reflex.vars import Var, BaseVar, ComputedVar
from reflex.event import EventHandler, EventChain, EventSpec

View File

@ -36,9 +36,9 @@ class Wrap(ChakraComponent):
"""Return a wrap component.
Args:
children: The children of the component.
*children: The children of the component.
items (list): The items of the wrap component.
props: The properties of the component.
**props: The properties of the component.
Returns:
The wrap component.

View File

@ -3,9 +3,9 @@
# This file was generated by `scripts/pyi_generator.py`!
# ------------------------------------------------------
from typing import Union, overload, Optional
from reflex.components.component import Component
from typing import Optional, Union, overload
from reflex.components.libs.chakra import ChakraComponent
from reflex.components.component import Component
from reflex.vars import Var, BaseVar, ComputedVar
from reflex.event import EventHandler, EventChain, EventSpec
@ -16,9 +16,16 @@ class Wrap(ChakraComponent):
"""Return a wrap component.
Args:
children: The children of the component.
*children: The children of the component.
align: How to align the items.
direction: The flex direction of the wrap.
justify: How to justify the items.
should_wrap_children: Whether to wrap children in `rx.wrap_item`.
spacing: The spacing between the items.
spacing_x: The horizontal spacing between the items.
spacing_y: The vertical spacing between the items.
items (list): The items of the wrap component.
props: The properties of the component.
**props: The properties of the component.
Returns:
The wrap component.

View File

@ -3,7 +3,7 @@
# This file was generated by `scripts/pyi_generator.py`!
# ------------------------------------------------------
from typing import Union, overload, Optional
from typing import Optional, Union, overload
from reflex.components.component import Component
from reflex.vars import Var, BaseVar, ComputedVar
from reflex.event import EventHandler, EventChain, EventSpec

View File

@ -3,9 +3,9 @@
# This file was generated by `scripts/pyi_generator.py`!
# ------------------------------------------------------
from typing import Union, overload, Optional
from reflex.components.component import NoSSRComponent
from typing import Optional, Union, overload
from reflex.components.component import Component
from reflex.components.component import NoSSRComponent
from reflex.vars import Var, BaseVar, ComputedVar
from reflex.event import EventHandler, EventChain, EventSpec

View File

@ -3,9 +3,9 @@
# This file was generated by `scripts/pyi_generator.py`!
# ------------------------------------------------------
from typing import Union, overload, Optional
from reflex.components.libs.react_player import ReactPlayerComponent
from typing import Optional, Union, overload
from reflex.components.component import Component
from reflex.components.libs.react_player import ReactPlayerComponent
from reflex.vars import Var, BaseVar, ComputedVar
from reflex.event import EventHandler, EventChain, EventSpec

View File

@ -3,9 +3,9 @@
# This file was generated by `scripts/pyi_generator.py`!
# ------------------------------------------------------
from typing import Union, overload, Set, Optional
from reflex.components.component import Component
from typing import Optional, Set, Union, overload
from reflex.components.libs.chakra import ChakraComponent
from reflex.components.component import Component
from reflex.vars import Var, BaseVar, ComputedVar
from reflex.event import EventHandler, EventChain, EventSpec

View File

@ -23,8 +23,8 @@ class Icon(ChakraIconComponent):
Run some additional checks on Icon component.
Args:
children: The positional arguments
props: The keyword arguments
*children: The positional arguments
**props: The keyword arguments
Raises:
AttributeError: The errors tied to bad usage of the Icon component.

View File

@ -3,7 +3,7 @@
# This file was generated by `scripts/pyi_generator.py`!
# ------------------------------------------------------
from typing import Union, overload, Optional, List
from typing import List, Optional, Union, overload
from reflex.components.component import Component
from reflex.vars import Var, BaseVar, ComputedVar
from reflex.event import EventHandler, EventChain, EventSpec
@ -37,8 +37,8 @@ class Icon(ChakraIconComponent):
Run some additional checks on Icon component.
Args:
children: The positional arguments
props: The keyword arguments
*children: The positional arguments
**props: The keyword arguments
Raises:
AttributeError: The errors tied to bad usage of the Icon component.

View File

@ -3,9 +3,9 @@
# This file was generated by `scripts/pyi_generator.py`!
# ------------------------------------------------------
from typing import Any, Optional, Union, overload, Set
from reflex.components.component import Component
from typing import Any, Optional, Set, Union, overload
from reflex.components.libs.chakra import ChakraComponent
from reflex.components.component import Component
from reflex.vars import Var, BaseVar, ComputedVar
from reflex.event import EventHandler, EventChain, EventSpec

View File

@ -3,9 +3,9 @@
# This file was generated by `scripts/pyi_generator.py`!
# ------------------------------------------------------
from typing import Union, overload, Optional
from reflex.components.libs.react_player import ReactPlayerComponent
from typing import Optional, Union, overload
from reflex.components.component import Component
from reflex.components.libs.react_player import ReactPlayerComponent
from reflex.vars import Var, BaseVar, ComputedVar
from reflex.event import EventHandler, EventChain, EventSpec

View File

@ -25,9 +25,9 @@ class Breadcrumb(ChakraComponent):
If the kw-args `items` is provided and is a list, they will be added as children.
Args:
children: The children of the component.
*children: The children of the component.
items (list): The items of the breadcrumb: (label, link)
props: The properties of the component.
**props: The properties of the component.
Returns:
The breadcrumb component.
@ -70,10 +70,10 @@ class BreadcrumbItem(ChakraComponent):
"""Create a Breadcrumb Item component.
Args:
children: The children of the component.
*children: The children of the component.
label: The label used in the link. Defaults to None.
href: The URL of the link. Defaults to None.
props: The properties of the component.
**props: The properties of the component.
Returns:
The BreadcrumbItem component

View File

@ -3,10 +3,10 @@
# This file was generated by `scripts/pyi_generator.py`!
# ------------------------------------------------------
from typing import Union, overload, Optional
from typing import Optional, Union, overload
from reflex.components.libs.chakra import ChakraComponent
from reflex.components.component import Component
from reflex.components.navigation.link import Link
from reflex.components.libs.chakra import ChakraComponent
from reflex.vars import Var, BaseVar, ComputedVar
from reflex.event import EventHandler, EventChain, EventSpec
@ -19,9 +19,11 @@ class Breadcrumb(ChakraComponent):
If the kw-args `items` is provided and is a list, they will be added as children.
Args:
children: The children of the component.
*children: The children of the component.
separator: The visual separator between each breadcrumb item
separator_margin: The left and right margin applied to the separator
items (list): The items of the breadcrumb: (label, link)
props: The properties of the component.
**props: The properties of the component.
Returns:
The breadcrumb component.
@ -35,10 +37,14 @@ class BreadcrumbItem(ChakraComponent):
"""Create a Breadcrumb Item component.
Args:
children: The children of the component.
*children: The children of the component.
is_current_page: Is the current page of the breadcrumb.
is_last_child: Is the last child of the breadcrumb.
separator: The visual separator between each breadcrumb item
spacing: The left and right margin applied to the separator
label: The label used in the link. Defaults to None.
href: The URL of the link. Defaults to None.
props: The properties of the component.
**props: The properties of the component.
Returns:
The BreadcrumbItem component

View File

@ -3,7 +3,7 @@
# This file was generated by `scripts/pyi_generator.py`!
# ------------------------------------------------------
from typing import Union, overload, Optional
from typing import Optional, Union, overload
from reflex.components.component import Component
from reflex.vars import Var, BaseVar, ComputedVar
from reflex.event import EventHandler, EventChain, EventSpec

View File

@ -3,9 +3,9 @@
# This file was generated by `scripts/pyi_generator.py`!
# ------------------------------------------------------
from typing import Union, overload, Optional
from reflex.components.component import Component
from typing import Optional, Union, overload
from reflex.components.libs.chakra import ChakraComponent
from reflex.components.component import Component
from reflex.vars import Var, BaseVar, ComputedVar
from reflex.event import EventHandler, EventChain, EventSpec

View File

@ -3,9 +3,9 @@
# This file was generated by `scripts/pyi_generator.py`!
# ------------------------------------------------------
from typing import Union, overload, Optional
from reflex.components.component import Component
from typing import Optional, Union, overload
from reflex.components.libs.chakra import ChakraComponent
from reflex.components.component import Component
from reflex.vars import Var, BaseVar, ComputedVar
from reflex.event import EventHandler, EventChain, EventSpec

View File

@ -3,7 +3,7 @@
# This file was generated by `scripts/pyi_generator.py`!
# ------------------------------------------------------
from typing import Union, overload, Optional
from typing import Optional, Union, overload
from reflex.components.component import Component
from reflex.vars import Var, BaseVar, ComputedVar
from reflex.event import EventHandler, EventChain, EventSpec

View File

@ -33,9 +33,9 @@ class Stepper(ChakraComponent):
If the kw-args `items` is provided and is a list, they will be added as children.
Args:
children: The children of the component.
*children: The children of the component.
items (list): The child components for each step.
props: The properties of the component.
**props: The properties of the component.
Returns:
The stepper component.

View File

@ -3,9 +3,9 @@
# This file was generated by `scripts/pyi_generator.py`!
# ------------------------------------------------------
from typing import Optional, Union, overload, Tuple, List
from reflex.components.component import Component
from typing import List, Optional, Tuple, Union, overload
from reflex.components.libs.chakra import ChakraComponent
from reflex.components.component import Component
from reflex.vars import Var, BaseVar, ComputedVar
from reflex.event import EventHandler, EventChain, EventSpec
@ -15,15 +15,20 @@ class Stepper(ChakraComponent):
def create(cls, *children, items: Optional[List[Tuple]] = None, colorScheme: Optional[Union[Var[str], str]] = None, index: Optional[Union[Var[int], int]] = None, size: Optional[Union[Var[str], 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) -> "Stepper": # type: ignore
"""Create a Stepper component.
If the kw-args `items` is provided and is a list, they will be added as children.
If the kw-args `items` is provided and is a list, they will be added as children.
Args:
children: The children of the component.
items (list): The child components for each step.
props: The properties of the component.
Args:
*children: The children of the component.
colorScheme: The color scheme to use for the stepper; default is blue.
index: Chakra provides a useSteps hook to control the stepper.
Instead, use an integer state value to set progress in the stepper.
The index of the current step.
size: The size of the steps in the stepper.
items (list): The child components for each step.
**props: The properties of the component.
Returns:
The stepper component.
Returns:
The stepper component.
"""
...

View File

@ -72,12 +72,12 @@ class AlertDialog(ChakraComponent):
"""Create an alert dialog component.
Args:
children: The children of the alert dialog component.
*children: The children of the alert dialog component.
header: The header of the alert dialog.
body: The body of the alert dialog.
footer: The footer of the alert dialog.
close_button: The close button of the alert dialog.
props: The properties of the alert dialog component.
**props: The properties of the alert dialog component.
Raises:
AttributeError: if there is a conflict between the props used.

View File

@ -3,9 +3,9 @@
# This file was generated by `scripts/pyi_generator.py`!
# ------------------------------------------------------
from typing import Union, overload, Set, Optional
from reflex.components.component import Component
from typing import Optional, Set, Union, overload
from reflex.components.libs.chakra import ChakraComponent
from reflex.components.component import Component
from reflex.vars import Var, BaseVar, ComputedVar
from reflex.event import EventHandler, EventChain, EventSpec
@ -16,12 +16,25 @@ class AlertDialog(ChakraComponent):
"""Create an alert dialog component.
Args:
children: The children of the alert dialog component.
*children: The children of the alert dialog component.
is_open: If true, the modal will be open.
least_destructive_ref: The least destructive element to focus when the dialog opens.
allow_pinch_zoom: Handle zoom/pinch gestures on iOS devices when scroll locking is enabled. Defaults to false.
auto_focus: If true, the modal will autofocus the first enabled and interactive element within the ModalContent
block_scroll_on_mount: If true, scrolling will be disabled on the body when the modal opens.
close_on_esc: If true, the modal will close when the Esc key is pressed
close_on_overlay_click: If true, the modal will close when the overlay is clicked
is_centered: If true, the modal will be centered on screen.
lock_focus_across_frames: Enables aggressive focus capturing within iframes. If true, keep focus in the lock, no matter where lock is active. If false, allows focus to move outside of iframe.
preserve_scroll_bar_gap: If true, a `padding-right` will be applied to the body element that's equal to the width of the scrollbar. This can help prevent some unpleasant flickering effect and content adjustment when the modal opens
return_focus_on_close: If true, the modal will return focus to the element that triggered it when it closes.
size: "xs" | "sm" | "md" | "lg" | "xl" | "2xl" | "3xl" | "4xl" | "5xl" | "6xl" | "full"
use_inert: If true, the siblings of the modal will have `aria-hidden` set to true so that screen readers can only see the modal. This is commonly known as making the other elements **inert**
header: The header of the alert dialog.
body: The body of the alert dialog.
footer: The footer of the alert dialog.
close_button: The close button of the alert dialog.
props: The properties of the alert dialog component.
**props: The properties of the alert dialog component.
Raises:
AttributeError: if there is a conflict between the props used.

View File

@ -3,7 +3,7 @@
# This file was generated by `scripts/pyi_generator.py`!
# ------------------------------------------------------
from typing import Union, overload, Optional
from typing import Optional, Union, overload
from reflex.components.component import Component
from reflex.vars import Var, BaseVar, ComputedVar
from reflex.event import EventHandler, EventChain, EventSpec

View File

@ -78,12 +78,12 @@ class Drawer(ChakraComponent):
"""Create a drawer component.
Args:
children: The children of the drawer component.
*children: The children of the drawer component.
header: The header of the drawer.
body: The body of the drawer.
footer: The footer of the drawer.
close_button: The close button of the drawer.
props: The properties of the drawer component.
**props: The properties of the drawer component.
Raises:
AttributeError: error that occurs if conflicting props are passed

View File

@ -3,9 +3,9 @@
# This file was generated by `scripts/pyi_generator.py`!
# ------------------------------------------------------
from typing import Union, overload, Set, Optional
from reflex.components.component import Component
from typing import Optional, Set, Union, overload
from reflex.components.libs.chakra import ChakraComponent
from reflex.components.component import Component
from reflex.vars import Var, BaseVar, ComputedVar
from reflex.event import EventHandler, EventChain, EventSpec
@ -16,12 +16,27 @@ class Drawer(ChakraComponent):
"""Create a drawer component.
Args:
children: The children of the drawer component.
*children: The children of the drawer component.
is_open: If true, the modal will be open.
allow_pinch_zoom: Handle zoom/pinch gestures on iOS devices when scroll locking is enabled. Defaults to false.
auto_focus: If true, the modal will autofocus the first enabled and interactive element within the ModalContent
block_scroll_on_mount: If true, scrolling will be disabled on the body when the modal opens.
close_on_esc: If true, the modal will close when the Esc key is pressed
close_on_overlay_click: If true, the modal will close when the overlay is clicked
is_centered: If true, the modal will be centered on screen.
is_full_height: If true and drawer's placement is top or bottom, the drawer will occupy the viewport height (100vh)
lock_focus_across_frames: Enables aggressive focus capturing within iframes. - If true: keep focus in the lock, no matter where lock is active - If false: allows focus to move outside of iframe
placement: The placement of the drawer
preserve_scroll_bar_gap: If true, a `padding-right` will be applied to the body element that's equal to the width of the scrollbar. This can help prevent some unpleasant flickering effect and content adjustment when the modal opens
return_focus_on_close: If true, the modal will return focus to the element that triggered it when it closes.
size: "xs" | "sm" | "md" | "lg" | "xl" | "full"
use_inert: A11y: If true, the siblings of the modal will have `aria-hidden` set to true so that screen readers can only see the modal. This is commonly known as making the other elements **inert**
variant: Variant of drawer
header: The header of the drawer.
body: The body of the drawer.
footer: The footer of the drawer.
close_button: The close button of the drawer.
props: The properties of the drawer component.
**props: The properties of the drawer component.
Raises:
AttributeError: error that occurs if conflicting props are passed

View File

@ -73,10 +73,10 @@ class Menu(ChakraComponent):
"""Create a menu component.
Args:
children: The children of the component.
*children: The children of the component.
button: the button that open the menu.
items (list): The items of the menu.
props: The properties of the component.
**props: The properties of the component.
Returns:
The menu component.

View File

@ -3,9 +3,9 @@
# This file was generated by `scripts/pyi_generator.py`!
# ------------------------------------------------------
from typing import Optional, Union, overload, Set, List
from reflex.components.component import Component
from typing import List, Optional, Set, Union, overload
from reflex.components.libs.chakra import ChakraComponent
from reflex.components.component import Component
from reflex.vars import Var, BaseVar, ComputedVar
from reflex.event import EventHandler, EventChain, EventSpec
@ -16,10 +16,26 @@ class Menu(ChakraComponent):
"""Create a menu component.
Args:
children: The children of the component.
*children: The children of the component.
arrow_padding: The padding required to prevent the arrow from reaching the very edge of the popper.
auto_select: If true, the first enabled menu item will receive focus and be selected when the menu opens.
boundary: The boundary area for the popper. Used within the preventOverflow modifier
close_on_blur: If true, the menu will close when you click outside the menu list
close_on_select: If true, the menu will close when a menu item is clicked
default_is_open: If by default the menu is open.
direction: If rtl, popper placement positions will be flipped i.e. 'top-right' will become 'top-left' and vice-verse ("ltr" | "rtl")
flip: If true, the popper will change its placement and flip when it's about to overflow its boundary area.
gutter: The distance or margin between the reference and popper. It is used internally to create an offset modifier. NB: If you define offset prop, it'll override the gutter.
is_lazy: Performance 🚀: If true, the MenuItem rendering will be deferred until the menu is open.
lazy_behavior: Performance 🚀: The lazy behavior of menu's content when not visible. Only works when `isLazy={true}` - "unmount": The menu's content is always unmounted when not open. - "keepMounted": The menu's content initially unmounted, but stays mounted when menu is open.
is_open: Determines if the menu is open or not.
match_width: If true, the popper will match the width of the reference at all times. It's useful for autocomplete, `date-picker` and select patterns.
placement: The placement of the popper relative to its reference.
prevent_overflow: If true, will prevent the popper from being cut off and ensure it's visible within the boundary area.
strategy: The CSS positioning strategy to use. ("fixed" | "absolute")
button: the button that open the menu.
items (list): The items of the menu.
props: The properties of the component.
**props: The properties of the component.
Returns:
The menu component.

View File

@ -78,12 +78,12 @@ class Modal(ChakraComponent):
"""Create a modal component.
Args:
children: The children of the component.
*children: The children of the component.
header: The header of the modal.
body: The body of the modal.
footer: The footer of the modal.
close_button: The close button of the modal.
props: The properties of the component.
**props: The properties of the component.
Raises:
AttributeError: error that occurs if conflicting props are passed

View File

@ -3,9 +3,9 @@
# This file was generated by `scripts/pyi_generator.py`!
# ------------------------------------------------------
from typing import Optional, Union, overload, Set
from reflex.components.component import Component
from typing import Optional, Set, Union, overload
from reflex.components.libs.chakra import ChakraComponent
from reflex.components.component import Component
from reflex.vars import Var, BaseVar, ComputedVar
from reflex.event import EventHandler, EventChain, EventSpec
@ -16,12 +16,25 @@ class Modal(ChakraComponent):
"""Create a modal component.
Args:
children: The children of the component.
*children: The children of the component.
is_open: If true, the modal will be open.
allow_pinch_zoom: Handle zoom/pinch gestures on iOS devices when scroll locking is enabled. Defaults to false.
auto_focus: If true, the modal will autofocus the first enabled and interactive element within the ModalContent
block_scroll_on_mount: If true, scrolling will be disabled on the body when the modal opens.
close_on_esc: If true, the modal will close when the Esc key is pressed
close_on_overlay_click: If true, the modal will close when the overlay is clicked
is_centered: If true, the modal will be centered on screen.
lock_focus_across_frames: Enables aggressive focus capturing within iframes. - If true: keep focus in the lock, no matter where lock is active - If false: allows focus to move outside of iframe
motion_preset: The transition that should be used for the modal
preserve_scroll_bar_gap: If true, a `padding-right` will be applied to the body element that's equal to the width of the scrollbar. This can help prevent some unpleasant flickering effect and content adjustment when the modal opens
return_focus_on_close: If true, the modal will return focus to the element that triggered it when it closes.
size: "xs" | "sm" | "md" | "lg" | "xl" | "2xl" | "3xl" | "4xl" | "5xl" | "6xl" | "full"
use_inert: A11y: If true, the siblings of the modal will have `aria-hidden` set to true so that screen readers can only see the modal. This is commonly known as making the other elements **inert**
header: The header of the modal.
body: The body of the modal.
footer: The footer of the modal.
close_button: The close button of the modal.
props: The properties of the component.
**props: The properties of the component.
Raises:
AttributeError: error that occurs if conflicting props are passed

View File

@ -97,13 +97,13 @@ class Popover(ChakraComponent):
"""Create a popover component.
Args:
children: The children of the component.
*children: The children of the component.
trigger: The trigger that opens the popover.
header: The header of the popover.
body: The body of the popover.
footer: The footer of the popover.
use_close_button: Whether to add a close button on the popover.
props: The properties of the component.
**props: The properties of the component.
Returns:
The popover component.

Some files were not shown because too many files have changed in this diff Show More