reflex-components-gridjs 0.9.0__tar.gz

reflex_components_gridjs-0.9.0/.gitignore

@@ -0,0 +1,24 @@
+**/.DS_Store
+**/*.pyc
+assets/external/*
+dist/*
+examples/
+.web
+.states
+.idea
+.vscode
+.coverage
+.coverage.*
+.venv
+venv
+requirements.txt
+.pyi_generator_last_run
+.pyi_generator_diff
+reflex.db
+.codspeed
+.env
+.env.*
+node_modules
+package-lock.json
+*.pyi
+.pre-commit-config.yaml

reflex_components_gridjs-0.9.0/PKG-INFO

@@ -0,0 +1,12 @@
+Metadata-Version: 2.4
+Name: reflex-components-gridjs
+Version: 0.9.0
+Summary: Reflex gridjs components.
+Author-email: Khaleel Al-Adhami <khaleel@reflex.dev>
+Maintainer-email: Khaleel Al-Adhami <khaleel@reflex.dev>
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+
+# reflex-components-gridjs
+
+Reflex gridjs components.

reflex_components_gridjs-0.9.0/README.md

@@ -0,0 +1,3 @@
+# reflex-components-gridjs
+
+Reflex gridjs components.

reflex_components_gridjs-0.9.0/pyproject.toml

@@ -0,0 +1,27 @@
+[project]
+name = "reflex-components-gridjs"
+dynamic = ["version"]
+description = "Reflex gridjs components."
+readme = "README.md"
+authors = [{ name = "Khaleel Al-Adhami", email = "khaleel@reflex.dev" }]
+maintainers = [{ name = "Khaleel Al-Adhami", email = "khaleel@reflex.dev" }]
+requires-python = ">=3.10"
+dependencies = []
+
+[tool.hatch.version]
+source = "uv-dynamic-versioning"
+
+[tool.uv-dynamic-versioning]
+pattern-prefix = "reflex-components-gridjs-"
+fallback-version = "0.0.0dev0"
+
+[tool.hatch.build]
+targets.sdist.artifacts = ["*.pyi"]
+targets.wheel.artifacts = ["*.pyi"]
+
+[tool.hatch.build.hooks.reflex-pyi]
+dependencies = ["ruff", "reflex-base"]
+
+[build-system]
+requires = ["hatchling", "uv-dynamic-versioning", "hatch-reflex-pyi"]
+build-backend = "hatchling.build"

reflex_components_gridjs-0.9.0/src/reflex_components_gridjs/__init__.py

@@ -0,0 +1,5 @@
+"""Grid components."""
+
+from .datatable import DataTable
+
+data_table = DataTable.create

reflex_components_gridjs-0.9.0/src/reflex_components_gridjs/datatable.py

@@ -0,0 +1,128 @@
+"""Table components."""
+
+from __future__ import annotations
+
+from collections.abc import Sequence
+from typing import Any
+
+from reflex_base.components.component import NoSSRComponent, field
+from reflex_base.components.tags import Tag
+from reflex_base.utils import types
+from reflex_base.utils.imports import ImportDict
+from reflex_base.utils.serializers import serialize
+from reflex_base.vars.base import LiteralVar, Var, is_computed_var
+
+
+class Gridjs(NoSSRComponent):
+    """A component that wraps a nivo bar component."""
+
+    library = "gridjs-react@6.1.1"
+
+    lib_dependencies: list[str] = ["gridjs@6.2.0"]
+
+
+class DataTable(Gridjs):
+    """A data table component."""
+
+    tag = "Grid"
+
+    alias = "DataTableGrid"
+
+    data: Any = field(
+        doc="The data to display. Either a list of lists or a pandas dataframe."
+    )
+
+    columns: Var[Sequence] = field(
+        doc="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: Var[bool] = field(doc="Enable a search bar.")
+
+    sort: Var[bool] = field(doc="Enable sorting on columns.")
+
+    resizable: Var[bool] = field(doc="Enable resizable columns.")
+
+    pagination: Var[bool | dict] = field(doc="Enable pagination.")
+
+    @classmethod
+    def create(cls, *children, **props):
+        """Create a datatable component.
+
+        Args:
+            *children: The children of the component.
+            **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.
+        """
+        data = props.get("data")
+        columns = props.get("columns")
+
+        # The annotation should be provided if data is a computed var. We need this to know how to
+        # render pandas dataframes.
+        if is_computed_var(data) and data._var_type == Any:
+            msg = "Annotation of the computed var assigned to the data field should be provided."
+            raise ValueError(msg)
+
+        if (
+            columns is not None
+            and is_computed_var(columns)
+            and columns._var_type == Any
+        ):
+            msg = "Annotation of the computed var assigned to the column field should be provided."
+            raise ValueError(msg)
+
+        # If data is a pandas dataframe and columns are provided throw an error.
+        if (
+            types.is_dataframe(type(data))
+            or (isinstance(data, Var) and types.is_dataframe(data._var_type))
+        ) and columns is not None:
+            msg = "Cannot pass in both a pandas dataframe and columns to the data_table component."
+            raise ValueError(msg)
+
+        # If data is a list and columns are not provided, throw an error
+        if (
+            (isinstance(data, Var) and types.typehint_issubclass(data._var_type, list))
+            or isinstance(data, list)
+        ) and columns is None:
+            msg = "column field should be specified when the data field is a list type"
+            raise ValueError(msg)
+
+        # Create the component.
+        return super().create(
+            *children,
+            **props,
+        )
+
+    def add_imports(self) -> ImportDict:
+        """Add the imports for the datatable component.
+
+        Returns:
+            The import dict for the component.
+        """
+        return {"": "gridjs/dist/theme/mermaid.css"}
+
+    def _render(self) -> Tag:
+        if isinstance(self.data, Var) and types.is_dataframe(self.data._var_type):
+            self.columns = self.data._replace(
+                _js_expr=f"{self.data._js_expr}.columns",
+                _var_type=list[Any],
+            )
+            self.data = self.data._replace(
+                _js_expr=f"{self.data._js_expr}.data",
+                _var_type=list[list[Any]],
+            )
+        if types.is_dataframe(type(self.data)):
+            # If given a pandas df break up the data and columns
+            data = serialize(self.data)
+            if not isinstance(data, dict):
+                msg = "Serialized dataframe should be a dict."
+                raise ValueError(msg)
+            self.columns = LiteralVar.create(data["columns"])
+            self.data = LiteralVar.create(data["data"])
+
+        # Render the table.
+        return super()._render()

reflex_components_gridjs-0.9.0/src/reflex_components_gridjs/datatable.pyi

@@ -0,0 +1,160 @@
+"""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: ...