Updated component docs

Author: forman

chartlets.py/chartlets/components/button.py

@@ -5,4 +5,8 @@
 
 @dataclass(frozen=True)
 class Button(Component):
+    """Buttons allow users to take actions, and make choices,
+    with a single tap."""
+
     text: str | None = None
+    """The button text."""

chartlets.py/chartlets/components/checkbox.py

@@ -5,5 +5,11 @@
 
 @dataclass(frozen=True)
 class Checkbox(Component):
+    """Checkboxes allow the user to select one or more items from a set.
+    They can be used to turn an option on or off."""
+
     value: bool | None = None
+    """The checkbox value."""
+
     label: str = ""
+    """The checkbox label."""

chartlets.py/chartlets/components/dropdown.py

@@ -5,4 +5,8 @@
 
 @dataclass(frozen=True)
 class Dropdown(Component):
+    """Dropdown components are used for collecting user provided
+    information from a list of options."""
+
     options: list[tuple[str, str | int | float]] = field(default_factory=list)
+    """The options given as a list of (label, value) pairs."""

chartlets.py/chartlets/components/plot.py

@@ -8,7 +8,12 @@
 
 @dataclass(frozen=True)
 class Plot(Component):
+    """The plot component is a container for a
+    [Vega Altair](https://altair-viz.github.io/) chart."""
+
     chart: alt.Chart | None = None
+    """The Vega Altair 
+    [chart object](https://altair-viz.github.io/user_guide/generated/toplevel/altair.Chart.html)."""
 
     def to_dict(self) -> dict[str, Any]:
         d = super().to_dict()

chartlets.py/chartlets/components/typography.py

@@ -5,4 +5,14 @@
 
 @dataclass(frozen=True)
 class Typography(Component):
+    """Use typography to present your design and content as clearly
+    and efficiently as possible."""
+
     text: str | None = None
+    """Optional text to be displayed."""
+
+    color: str | None = None
+    """The color of the component."""
+
+    variant: str | None = None
+    """Applies the theme typography styles."""