reflex-silverpoint-react 0.1.0__py3-none-any.whl

reflex_silverpoint_react/__init__.py

@@ -0,0 +1,170 @@
+"""reflex-silverpoint-react: silverpoint charts for Reflex.
+
+Charts drawn in the manner of a Renaissance silverpoint drawing, wrapping ``@silverpoint/react``.
+"""
+
+from .base import (
+    SILVERPOINT_LIBRARY,
+    SILVERPOINT_STYLESHEETS,
+    SILVERPOINT_VERSION,
+    SilverpointChart,
+    SilverpointProvider,
+    silverpoint_provider,
+)
+from .catalog import CHARTS, COMMON_PROPS, FAMILIES, ChartInfo, PropDoc, chart_by_name, chart_by_slug
+from .charts import (
+    ActivityGrid,
+    AreaChart,
+    BarChart,
+    BubbleChart,
+    BulletChart,
+    CandlestickChart,
+    ChordRing,
+    ComposedChart,
+    CoxcombChart,
+    DonutChart,
+    FunnelChart,
+    GaugeArc,
+    HeatmapChart,
+    KpiCard,
+    LineChart,
+    MeterChart,
+    OrbitChart,
+    PolarBarChart,
+    PyramidChart,
+    RadarChart,
+    RadialArcGroup,
+    RadialRings,
+    RangeBandChart,
+    SankeyChart,
+    ScatterChart,
+    SparklineRows,
+    StackedBarChart,
+    StepChart,
+    StreamChart,
+    TreemapChart,
+    VolvelleChart,
+    WaterfallChart,
+    WindRose,
+    activity_grid,
+    area_chart,
+    bar_chart,
+    bubble_chart,
+    bullet_chart,
+    candlestick_chart,
+    chord_ring,
+    composed_chart,
+    coxcomb_chart,
+    donut_chart,
+    funnel_chart,
+    gauge_arc,
+    heatmap_chart,
+    kpi_card,
+    line_chart,
+    meter_chart,
+    orbit_chart,
+    polar_bar_chart,
+    pyramid_chart,
+    radar_chart,
+    radial_arc_group,
+    radial_rings,
+    range_band_chart,
+    sankey_chart,
+    scatter_chart,
+    sparkline_rows,
+    stacked_bar_chart,
+    step_chart,
+    stream_chart,
+    treemap_chart,
+    volvelle_chart,
+    waterfall_chart,
+    wind_rose,
+)
+from .helpers import chart_ref, download_svg, get_geometry, get_svg, tooltip_template
+
+__all__ = [
+    "CHARTS",
+    "COMMON_PROPS",
+    "FAMILIES",
+    "SILVERPOINT_LIBRARY",
+    "SILVERPOINT_STYLESHEETS",
+    "SILVERPOINT_VERSION",
+    "ActivityGrid",
+    "AreaChart",
+    "BarChart",
+    "BubbleChart",
+    "BulletChart",
+    "CandlestickChart",
+    "ChartInfo",
+    "ChordRing",
+    "ComposedChart",
+    "CoxcombChart",
+    "DonutChart",
+    "FunnelChart",
+    "GaugeArc",
+    "HeatmapChart",
+    "KpiCard",
+    "LineChart",
+    "MeterChart",
+    "OrbitChart",
+    "PolarBarChart",
+    "PropDoc",
+    "PyramidChart",
+    "RadarChart",
+    "RadialArcGroup",
+    "RadialRings",
+    "RangeBandChart",
+    "SankeyChart",
+    "ScatterChart",
+    "SilverpointChart",
+    "SilverpointProvider",
+    "SparklineRows",
+    "StackedBarChart",
+    "StepChart",
+    "StreamChart",
+    "TreemapChart",
+    "VolvelleChart",
+    "WaterfallChart",
+    "WindRose",
+    "activity_grid",
+    "area_chart",
+    "bar_chart",
+    "bubble_chart",
+    "bullet_chart",
+    "candlestick_chart",
+    "chart_by_name",
+    "chart_by_slug",
+    "chart_ref",
+    "chord_ring",
+    "composed_chart",
+    "coxcomb_chart",
+    "donut_chart",
+    "download_svg",
+    "funnel_chart",
+    "gauge_arc",
+    "get_geometry",
+    "get_svg",
+    "heatmap_chart",
+    "kpi_card",
+    "line_chart",
+    "meter_chart",
+    "orbit_chart",
+    "polar_bar_chart",
+    "pyramid_chart",
+    "radar_chart",
+    "radial_arc_group",
+    "radial_rings",
+    "range_band_chart",
+    "sankey_chart",
+    "scatter_chart",
+    "silverpoint_provider",
+    "sparkline_rows",
+    "stacked_bar_chart",
+    "step_chart",
+    "stream_chart",
+    "tooltip_template",
+    "treemap_chart",
+    "volvelle_chart",
+    "waterfall_chart",
+    "wind_rose",
+]

reflex_silverpoint_react/base.py

@@ -0,0 +1,180 @@
+"""Shared pieces of the silverpoint wrappers: the chart base class and the provider.
+
+silverpoint draws charts in the manner of a Renaissance silverpoint drawing: a fine silver line
+on a prepared ground, tone built from hatching, and white heightening on the live value. The
+irregularity lives only in the ornament; the data geometry is exact, and every chart has a
+``precision`` mode that switches the inking off.
+
+The npm side is ``@silverpoint/react`` (client components), ``@silverpoint/grounds`` (the
+stylesheet that colours the strokes, required) and ``@silverpoint/fonts`` (self-hosted
+EB Garamond). Both stylesheets are imported once by any page that renders a chart.
+"""
+
+from typing import Any, Literal
+
+import reflex as rx
+
+#: The silverpoint npm release these wrappers are written against.
+SILVERPOINT_VERSION = "0.1.1"
+
+#: The npm package every chart is imported from (the barrel; it is side-effect free, so the
+#: bundler keeps only the charts a page uses).
+SILVERPOINT_LIBRARY = f"@silverpoint/react@{SILVERPOINT_VERSION}"
+
+#: Stylesheets every app needs once: the typeface, then the grounds.
+SILVERPOINT_STYLESHEETS = (
+    "@silverpoint/fonts/fonts.css",
+    "@silverpoint/grounds/styles.css",
+)
+
+Substrate = Literal["cream", "green", "blue", "ochre"]
+InkMode = Literal["ink", "precision"]
+Chrome = Literal["card", "bare"]
+HatchFill = Literal["tile", "per-shape"]
+DataTable = Literal["visible", "hidden", "none"]
+
+
+class _SilverpointBase(rx.Component):
+    """Library, npm dependencies and stylesheet imports shared by every wrapper."""
+
+    library = SILVERPOINT_LIBRARY
+
+    lib_dependencies: list[str] = [  # noqa: RUF012 - Reflex reads it as a class attribute
+        f"@silverpoint/core@{SILVERPOINT_VERSION}",
+        f"@silverpoint/grounds@{SILVERPOINT_VERSION}",
+        f"@silverpoint/fonts@{SILVERPOINT_VERSION}",
+    ]
+
+    def add_imports(self) -> dict[str, list[str]]:
+        """Import the typeface and the grounds stylesheet next to the component.
+
+        Returns:
+            Side-effect imports of the two stylesheets.
+        """
+        return {"": list(SILVERPOINT_STYLESHEETS)}
+
+
+def _active_item_spec(item):
+    """The item under the pointer or keyboard focus, or ``None`` when it clears.
+
+    Args:
+        item: ``{seriesKey, index, datum, value, point: {x, y}}`` from the chart, or null.
+
+    Returns:
+        The item, forwarded unchanged to the backend handler (annotate it ``dict | None``).
+    """
+    return (item,)
+
+
+def _selected_item_spec(item):
+    """The item chosen by click, Enter or Space.
+
+    Args:
+        item: ``{seriesKey, index, datum, value, point: {x, y}}`` from the chart.
+
+    Returns:
+        The item, forwarded unchanged to the backend handler.
+    """
+    return (item,)
+
+
+class SilverpointChart(_SilverpointBase):
+    """Props every silverpoint chart shares (API Spec §7, "Props every chart shares").
+
+    Give a chart an ``id`` when you want a stable seed across renders or when you want to use
+    :func:`download_svg`, :func:`get_svg` or :func:`get_geometry` on it.
+    """
+
+    # Rows to draw. If omitted, the chart renders its own demo dataset.
+    data: rx.Var[list[dict[str, Any]]]
+
+    # Style ground, by name (``"silverpoint"``) or as a complete ground object.
+    ground: rx.Var[str | dict[str, Any]]
+
+    # Prepared substrate within the ground: cream (default), green, blue or ochre.
+    substrate: rx.Var[Substrate]
+
+    # ``ink`` by default; ``precision`` switches inking off and draws exact, even strokes.
+    mode: rx.Var[InkMode]
+
+    # Seed of the hand. Same props and seed, same strokes. Derived from ``id`` when omitted.
+    seed: rx.Var[int | str]
+
+    # Height of the drawing area in px (160 by default).
+    height: rx.Var[int | float]
+
+    # Width in px. The chart takes its container's width unless this pins it.
+    width: rx.Var[int | float]
+
+    # ``card`` draws the full frame; ``bare`` only the drawing area.
+    chrome: rx.Var[Chrome]
+
+    # How areas are filled: ``tile`` (default) or ``per-shape`` (richer, much heavier).
+    hatch_fill: rx.Var[HatchFill]
+
+    # Card title.
+    title: rx.Var[str]
+
+    # Small badge printed at the top right of the card.
+    badge: rx.Var[str]
+
+    # Headline figure printed on the card.
+    value: rx.Var[str | int | float]
+
+    # Unit printed after the headline figure.
+    unit: rx.Var[str]
+
+    # Footer text, left.
+    footer_left: rx.Var[str]
+
+    # Footer text, right.
+    footer_right: rx.Var[str]
+
+    # Accessible name. Derived from ``title`` when omitted.
+    label: rx.Var[str]
+
+    # Long description for screen readers.
+    description: rx.Var[str]
+
+    # Tabular alternative: ``hidden`` (default, for assistive technology only), ``visible`` or ``none``.
+    data_table: rx.Var[DataTable]
+
+    # BCP 47 locale for number formatting, e.g. ``"es-VE"``.
+    locale: rx.Var[str]
+
+    # ``Intl.NumberFormatOptions``, e.g. ``{"style": "percent"}``.
+    number_format: rx.Var[dict[str, Any]]
+
+    # Replaces the built-in readout: a JS function ``(item, readout) => ReactNode``.
+    # Build one from Python with :func:`tooltip_template`.
+    tooltip: rx.Var[Any]
+
+    # The active item changed (pointer or keyboard focus), or cleared (``None``).
+    on_active_change: rx.EventHandler[_active_item_spec]
+
+    # An item was chosen by click, Enter or Space.
+    on_select: rx.EventHandler[_selected_item_spec]
+
+
+class SilverpointProvider(_SilverpointBase):
+    """Sets ground, substrate, mode and locale once for every chart below it.
+
+    A prop on a chart always wins over the provider.
+    """
+
+    tag = "SilverpointProvider"
+
+    # Style ground for every chart below.
+    ground: rx.Var[str | dict[str, Any]]
+
+    # Substrate for every chart below.
+    substrate: rx.Var[Substrate]
+
+    # Inking mode for every chart below.
+    mode: rx.Var[InkMode]
+
+    # Locale for every chart below.
+    locale: rx.Var[str]
+
+
+silverpoint_provider = SilverpointProvider.create

reflex_silverpoint_react/base.pyi

@@ -0,0 +1,270 @@
+"""Stub file for custom_components/reflex_silverpoint_react/base.py"""
+
+# ------------------- DO NOT EDIT ----------------------
+# This file was generated by `reflex/utils/pyi_generator.py`!
+# ------------------------------------------------------
+from collections.abc import Mapping, Sequence
+from typing import Any, Literal, Optional
+from reflex_components_core.core.breakpoints import Breakpoints
+from reflex_base.event import (
+    EventType,
+    PointerEventInfo,
+)
+from reflex_base.vars.base import Var
+import reflex as rx
+
+SILVERPOINT_VERSION = "0.1.1"
+SILVERPOINT_LIBRARY = f"@silverpoint/react@{SILVERPOINT_VERSION}"
+SILVERPOINT_STYLESHEETS = ("@silverpoint/fonts/fonts.css", "@silverpoint/grounds/styles.css")
+Substrate = Literal["cream", "green", "blue", "ochre"]
+InkMode = Literal["ink", "precision"]
+Chrome = Literal["card", "bare"]
+HatchFill = Literal["tile", "per-shape"]
+DataTable = Literal["visible", "hidden", "none"]
+
+class _SilverpointBase(rx.Component):
+    def add_imports(self) -> dict[str, list[str]]: ...
+    @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: Optional[EventType[()]] = None,
+        on_click: Optional[EventType[()] | EventType[PointerEventInfo]] = None,
+        on_context_menu: Optional[EventType[()] | EventType[PointerEventInfo]] = None,
+        on_double_click: Optional[EventType[()] | EventType[PointerEventInfo]] = None,
+        on_focus: Optional[EventType[()]] = None,
+        on_mount: Optional[EventType[()]] = None,
+        on_mouse_down: Optional[EventType[()]] = None,
+        on_mouse_enter: Optional[EventType[()]] = None,
+        on_mouse_leave: Optional[EventType[()]] = None,
+        on_mouse_move: Optional[EventType[()]] = None,
+        on_mouse_out: Optional[EventType[()]] = None,
+        on_mouse_over: Optional[EventType[()]] = None,
+        on_mouse_up: Optional[EventType[()]] = None,
+        on_scroll: Optional[EventType[()]] = None,
+        on_scroll_end: Optional[EventType[()]] = None,
+        on_unmount: Optional[EventType[()]] = None,
+        **props,
+    ) -> "_SilverpointBase":
+        """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 SilverpointChart(_SilverpointBase):
+    @classmethod
+    def create(
+        cls,
+        *children,
+        data: Var[list[dict[str, Any]]] | list[dict[str, Any]] | None = None,
+        ground: Var[dict[str, Any] | str] | dict[str, Any] | str | None = None,
+        substrate: Literal["blue", "cream", "green", "ochre"]
+        | Var[Literal["blue", "cream", "green", "ochre"]]
+        | None = None,
+        mode: Literal["ink", "precision"] | Var[Literal["ink", "precision"]] | None = None,
+        seed: Var[int | str] | int | str | None = None,
+        height: Var[float | int] | float | int | None = None,
+        width: Var[float | int] | float | int | None = None,
+        chrome: Literal["bare", "card"] | Var[Literal["bare", "card"]] | None = None,
+        hatch_fill: Literal["per-shape", "tile"] | Var[Literal["per-shape", "tile"]] | None = None,
+        title: Var[str] | str | None = None,
+        badge: Var[str] | str | None = None,
+        value: Var[float | int | str] | float | int | str | None = None,
+        unit: Var[str] | str | None = None,
+        footer_left: Var[str] | str | None = None,
+        footer_right: Var[str] | str | None = None,
+        label: Var[str] | str | None = None,
+        description: Var[str] | str | None = None,
+        data_table: Literal["hidden", "none", "visible"] | Var[Literal["hidden", "none", "visible"]] | None = None,
+        locale: Var[str] | str | None = None,
+        number_format: Var[dict[str, Any]] | dict[str, Any] | None = None,
+        tooltip: Any | Var[Any] | 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_active_change: Optional[EventType[Any]] = None,
+        on_blur: Optional[EventType[()]] = None,
+        on_click: Optional[EventType[()] | EventType[PointerEventInfo]] = None,
+        on_context_menu: Optional[EventType[()] | EventType[PointerEventInfo]] = None,
+        on_double_click: Optional[EventType[()] | EventType[PointerEventInfo]] = None,
+        on_focus: Optional[EventType[()]] = None,
+        on_mount: Optional[EventType[()]] = None,
+        on_mouse_down: Optional[EventType[()]] = None,
+        on_mouse_enter: Optional[EventType[()]] = None,
+        on_mouse_leave: Optional[EventType[()]] = None,
+        on_mouse_move: Optional[EventType[()]] = None,
+        on_mouse_out: Optional[EventType[()]] = None,
+        on_mouse_over: Optional[EventType[()]] = None,
+        on_mouse_up: Optional[EventType[()]] = None,
+        on_scroll: Optional[EventType[()]] = None,
+        on_scroll_end: Optional[EventType[()]] = None,
+        on_select: Optional[EventType[Any]] = None,
+        on_unmount: Optional[EventType[()]] = None,
+        **props,
+    ) -> "SilverpointChart":
+        """Create the component.
+
+        Args:
+            *children: The children of the component.
+            data: no description
+            ground: no description
+            substrate: no description
+            mode: no description
+            seed: no description
+            height: no description
+            width: no description
+            chrome: no description
+            hatch_fill: no description
+            title: no description
+            badge: no description
+            value: no description
+            unit: no description
+            footer_left: no description
+            footer_right: no description
+            label: no description
+            description: no description
+            data_table: no description
+            locale: no description
+            number_format: no description
+            tooltip: no description
+            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.
+            on_active_change: no description
+            on_select: no description
+            **props: The props of the component.
+
+        Returns:
+            The component.
+        """
+        ...
+
+class SilverpointProvider(_SilverpointBase):
+    @classmethod
+    def create(
+        cls,
+        *children,
+        ground: Var[dict[str, Any] | str] | dict[str, Any] | str | None = None,
+        substrate: Literal["blue", "cream", "green", "ochre"]
+        | Var[Literal["blue", "cream", "green", "ochre"]]
+        | None = None,
+        mode: Literal["ink", "precision"] | Var[Literal["ink", "precision"]] | None = None,
+        locale: Var[str] | str | 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: Optional[EventType[()]] = None,
+        on_click: Optional[EventType[()] | EventType[PointerEventInfo]] = None,
+        on_context_menu: Optional[EventType[()] | EventType[PointerEventInfo]] = None,
+        on_double_click: Optional[EventType[()] | EventType[PointerEventInfo]] = None,
+        on_focus: Optional[EventType[()]] = None,
+        on_mount: Optional[EventType[()]] = None,
+        on_mouse_down: Optional[EventType[()]] = None,
+        on_mouse_enter: Optional[EventType[()]] = None,
+        on_mouse_leave: Optional[EventType[()]] = None,
+        on_mouse_move: Optional[EventType[()]] = None,
+        on_mouse_out: Optional[EventType[()]] = None,
+        on_mouse_over: Optional[EventType[()]] = None,
+        on_mouse_up: Optional[EventType[()]] = None,
+        on_scroll: Optional[EventType[()]] = None,
+        on_scroll_end: Optional[EventType[()]] = None,
+        on_unmount: Optional[EventType[()]] = None,
+        **props,
+    ) -> "SilverpointProvider":
+        """Create the component.
+
+        Args:
+            *children: The children of the component.
+            ground: Style ground for every chart below.
+            substrate: Substrate for every chart below.
+            mode: Inking mode for every chart below.
+            locale: Locale for every chart below.
+            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.
+        """
+        ...
+
+silverpoint_provider = SilverpointProvider.create