160 lines
8.1 KiB
Python
160 lines
8.1 KiB
Python
"""Stub file for reflex_components_gridjs/datatable.py"""
|
|
|
|
# ------------------- DO NOT EDIT ----------------------
|
|
# This file was generated by `reflex/utils/pyi_generator.py`!
|
|
# ------------------------------------------------------
|
|
from collections.abc import Mapping, Sequence
|
|
from typing import Any
|
|
|
|
from reflex_base.components.component import NoSSRComponent
|
|
from reflex_base.event import EventType, PointerEventInfo
|
|
from reflex_base.utils.imports import ImportDict
|
|
from reflex_base.vars.base import Var
|
|
from reflex_components_core.core.breakpoints import Breakpoints
|
|
|
|
class Gridjs(NoSSRComponent):
|
|
@classmethod
|
|
def create(
|
|
cls,
|
|
*children,
|
|
style: Sequence[Mapping[str, Any]]
|
|
| Mapping[str, Any]
|
|
| Var[Mapping[str, Any]]
|
|
| Breakpoints
|
|
| None = None,
|
|
key: Any | None = None,
|
|
id: Any | None = None,
|
|
ref: Var | None = None,
|
|
class_name: Any | None = None,
|
|
custom_attrs: dict[str, Any | Var] | None = None,
|
|
on_blur: EventType[()] | None = None,
|
|
on_click: EventType[()] | EventType[PointerEventInfo] | None = None,
|
|
on_context_menu: EventType[()] | EventType[PointerEventInfo] | None = None,
|
|
on_double_click: EventType[()] | EventType[PointerEventInfo] | None = None,
|
|
on_focus: EventType[()] | None = None,
|
|
on_mount: EventType[()] | None = None,
|
|
on_mouse_down: EventType[()] | None = None,
|
|
on_mouse_enter: EventType[()] | None = None,
|
|
on_mouse_leave: EventType[()] | None = None,
|
|
on_mouse_move: EventType[()] | None = None,
|
|
on_mouse_out: EventType[()] | None = None,
|
|
on_mouse_over: EventType[()] | None = None,
|
|
on_mouse_up: EventType[()] | None = None,
|
|
on_scroll: EventType[()] | None = None,
|
|
on_scroll_end: EventType[()] | None = None,
|
|
on_unmount: EventType[()] | None = 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.
|
|
ref: The Var to pass as the ref to the component.
|
|
class_name: The class name for the component.
|
|
custom_attrs: Attributes passed directly to the component.
|
|
on_focus: Fired when the element (or some element inside of it) receives focus. For example, it is called when the user clicks on a text input.
|
|
on_blur: Fired when focus has left the element (or left some element inside of it). For example, it is called when the user clicks outside of a focused text input.
|
|
on_click: Fired when the user clicks on an element. For example, it's called when the user clicks on a button.
|
|
on_context_menu: Fired when the user right-clicks on an element.
|
|
on_double_click: Fired when the user double-clicks on an element.
|
|
on_mouse_down: Fired when the user presses a mouse button on an element.
|
|
on_mouse_enter: Fired when the mouse pointer enters the element.
|
|
on_mouse_leave: Fired when the mouse pointer leaves the element.
|
|
on_mouse_move: Fired when the mouse pointer moves over the element.
|
|
on_mouse_out: Fired when the mouse pointer moves out of the element.
|
|
on_mouse_over: Fired when the mouse pointer moves onto the element.
|
|
on_mouse_up: Fired when the user releases a mouse button on an element.
|
|
on_scroll: Fired when the user scrolls the element.
|
|
on_scroll_end: Fired when scrolling ends on the element.
|
|
on_mount: Fired when the component is mounted to the page.
|
|
on_unmount: Fired when the component is removed from the page. Only called during navigation, not on page refresh.
|
|
**props: The props of the component.
|
|
|
|
Returns:
|
|
The component.
|
|
"""
|
|
|
|
class DataTable(Gridjs):
|
|
@classmethod
|
|
def create(
|
|
cls,
|
|
*children,
|
|
data: Any | None = None,
|
|
columns: Sequence | Var[Sequence] | None = None,
|
|
search: Var[bool] | bool | None = None,
|
|
sort: Var[bool] | bool | None = None,
|
|
resizable: Var[bool] | bool | None = None,
|
|
pagination: Var[bool | dict] | bool | dict | None = None,
|
|
style: Sequence[Mapping[str, Any]]
|
|
| Mapping[str, Any]
|
|
| Var[Mapping[str, Any]]
|
|
| Breakpoints
|
|
| None = None,
|
|
key: Any | None = None,
|
|
id: Any | None = None,
|
|
ref: Var | None = None,
|
|
class_name: Any | None = None,
|
|
custom_attrs: dict[str, Any | Var] | None = None,
|
|
on_blur: EventType[()] | None = None,
|
|
on_click: EventType[()] | EventType[PointerEventInfo] | None = None,
|
|
on_context_menu: EventType[()] | EventType[PointerEventInfo] | None = None,
|
|
on_double_click: EventType[()] | EventType[PointerEventInfo] | None = None,
|
|
on_focus: EventType[()] | None = None,
|
|
on_mount: EventType[()] | None = None,
|
|
on_mouse_down: EventType[()] | None = None,
|
|
on_mouse_enter: EventType[()] | None = None,
|
|
on_mouse_leave: EventType[()] | None = None,
|
|
on_mouse_move: EventType[()] | None = None,
|
|
on_mouse_out: EventType[()] | None = None,
|
|
on_mouse_over: EventType[()] | None = None,
|
|
on_mouse_up: EventType[()] | None = None,
|
|
on_scroll: EventType[()] | None = None,
|
|
on_scroll_end: EventType[()] | None = None,
|
|
on_unmount: EventType[()] | None = 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.
|
|
ref: The Var to pass as the ref to the component.
|
|
class_name: The class name for the component.
|
|
custom_attrs: Attributes passed directly to the component.
|
|
on_focus: Fired when the element (or some element inside of it) receives focus. For example, it is called when the user clicks on a text input.
|
|
on_blur: Fired when focus has left the element (or left some element inside of it). For example, it is called when the user clicks outside of a focused text input.
|
|
on_click: Fired when the user clicks on an element. For example, it's called when the user clicks on a button.
|
|
on_context_menu: Fired when the user right-clicks on an element.
|
|
on_double_click: Fired when the user double-clicks on an element.
|
|
on_mouse_down: Fired when the user presses a mouse button on an element.
|
|
on_mouse_enter: Fired when the mouse pointer enters the element.
|
|
on_mouse_leave: Fired when the mouse pointer leaves the element.
|
|
on_mouse_move: Fired when the mouse pointer moves over the element.
|
|
on_mouse_out: Fired when the mouse pointer moves out of the element.
|
|
on_mouse_over: Fired when the mouse pointer moves onto the element.
|
|
on_mouse_up: Fired when the user releases a mouse button on an element.
|
|
on_scroll: Fired when the user scrolls the element.
|
|
on_scroll_end: Fired when scrolling ends on the element.
|
|
on_mount: Fired when the component is mounted to the page.
|
|
on_unmount: Fired when the component is removed from the page. Only called during navigation, not on page refresh.
|
|
**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.
|
|
"""
|
|
|
|
def add_imports(self) -> ImportDict: ...
|