1b4229691a
* update to ensure every radix component only inherits events from EventTriggers class * update the naming of event handlers to swap name on_value_change and on_checked_change to on_change * update to call _replace_prop_names in component.py * small darglint error fix * update to ensure every radix component only inherits events from EventTriggers class * update the naming of event handlers to swap name on_value_change and on_checked_change to on_change * update to call _replace_prop_names in component.py * small darglint error fix * updates to pass pytest tests * small fix * duplicate removal --------- Co-authored-by: Tom Gotsman <tomgotsman@toms-mbp.lan>
190 lines
7.2 KiB
Python
190 lines
7.2 KiB
Python
"""Stub file for reflex/components/gridjs/datatable.py"""
|
|
# ------------------- DO NOT EDIT ----------------------
|
|
# This file was generated by `scripts/pyi_generator.py`!
|
|
# ------------------------------------------------------
|
|
|
|
from typing import Any, Dict, Literal, Optional, Union, overload
|
|
from reflex.vars import Var, BaseVar, ComputedVar
|
|
from reflex.event import EventChain, EventHandler, EventSpec
|
|
from reflex.style import Style
|
|
from typing import Any, Dict, List, Union
|
|
from reflex.components.component import Component
|
|
from reflex.components.tags import Tag
|
|
from reflex.utils import imports, types
|
|
from reflex.utils.serializers import serialize
|
|
from reflex.vars import BaseVar, ComputedVar, Var
|
|
|
|
class Gridjs(Component):
|
|
@overload
|
|
@classmethod
|
|
def create( # type: ignore
|
|
cls,
|
|
*children,
|
|
style: Optional[Style] = None,
|
|
key: Optional[Any] = None,
|
|
id: Optional[Any] = None,
|
|
class_name: Optional[Any] = None,
|
|
autofocus: Optional[bool] = None,
|
|
_rename_props: Optional[Dict[str, str]] = None,
|
|
custom_attrs: Optional[Dict[str, Union[Var, str]]] = None,
|
|
on_blur: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
on_click: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
on_context_menu: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
on_double_click: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
on_focus: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
on_mount: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
on_mouse_down: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
on_mouse_enter: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
on_mouse_leave: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
on_mouse_move: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
on_mouse_out: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
on_mouse_over: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
on_mouse_up: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
on_scroll: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
on_unmount: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
**props
|
|
) -> "Gridjs":
|
|
"""Create the component.
|
|
|
|
Args:
|
|
*children: The children of the component.
|
|
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
|
|
_rename_props: props to change the name of
|
|
custom_attrs: custom attribute
|
|
**props: The props of the component.
|
|
|
|
Returns:
|
|
The component.
|
|
|
|
Raises:
|
|
TypeError: If an invalid child is passed.
|
|
"""
|
|
...
|
|
|
|
class DataTable(Gridjs):
|
|
@overload
|
|
@classmethod
|
|
def create( # type: ignore
|
|
cls,
|
|
*children,
|
|
data: Optional[Any] = None,
|
|
columns: Optional[Union[Var[List], List]] = None,
|
|
search: Optional[Union[Var[bool], bool]] = None,
|
|
sort: Optional[Union[Var[bool], bool]] = None,
|
|
resizable: Optional[Union[Var[bool], bool]] = None,
|
|
pagination: Optional[Union[Var[Union[bool, Dict]], Union[bool, Dict]]] = None,
|
|
style: Optional[Style] = None,
|
|
key: Optional[Any] = None,
|
|
id: Optional[Any] = None,
|
|
class_name: Optional[Any] = None,
|
|
autofocus: Optional[bool] = None,
|
|
_rename_props: Optional[Dict[str, str]] = None,
|
|
custom_attrs: Optional[Dict[str, Union[Var, str]]] = None,
|
|
on_blur: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
on_click: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
on_context_menu: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
on_double_click: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
on_focus: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
on_mount: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
on_mouse_down: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
on_mouse_enter: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
on_mouse_leave: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
on_mouse_move: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
on_mouse_out: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
on_mouse_over: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
on_mouse_up: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
on_scroll: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
on_unmount: Optional[
|
|
Union[EventHandler, EventSpec, list, function, BaseVar]
|
|
] = None,
|
|
**props
|
|
) -> "DataTable":
|
|
"""Create a datatable component.
|
|
|
|
Args:
|
|
*children: The children of the component.
|
|
data: The data to display. Either a list of lists or a pandas dataframe.
|
|
columns: The list of columns to display. Required if data is a list and should not be provided if the data field is a dataframe
|
|
search: Enable a search bar.
|
|
sort: Enable sorting on columns.
|
|
resizable: Enable resizable columns.
|
|
pagination: Enable pagination.
|
|
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
|
|
_rename_props: props to change the name of
|
|
custom_attrs: custom attribute
|
|
**props: The props to pass to the component.
|
|
|
|
Returns:
|
|
The datatable component.
|
|
|
|
Raises:
|
|
ValueError: If a pandas dataframe is passed in and columns are also provided.
|
|
"""
|
|
...
|