@dschz/solid-uplot 0.1.0 → 0.1.1

package/dist/index/index.d.ts

@@ -5,27 +5,59 @@ import uPlot from 'uplot';
 import { S as SeriesDatum } from '../getSeriesData-D1zBqQ9Y.js';
 import 'solid-js/store';
 
+/** Placement options for children components relative to the chart */
 type ChildrenPlacement = "top" | "bottom";
+/**
+ * A SolidJS-compatible uPlot plugin that can be either a standard uPlot plugin
+ * or a factory function that creates a plugin with access to the plugin bus
+ *
+ * @template T - The type of the plugin bus data structure
+ */
 type SolidUplotPlugin<T extends VoidStruct = VoidStruct> = uPlot.Plugin | PluginFactory<T>;
+/**
+ * Configuration options for the SolidUplot component, extending uPlot.Options
+ * with SolidJS-specific enhancements
+ *
+ * @template T - The type of the plugin bus data structure
+ */
 type SolidUplotOptions<T extends VoidStruct = VoidStruct> = Omit<uPlot.Options, "plugins" | "width" | "height"> & {
+    /** Chart width in pixels */
     readonly width?: number;
+    /** Chart height in pixels */
     readonly height?: number;
+    /** Plugin communication bus for coordinating between plugins */
     readonly pluginBus?: SolidUplotPluginBus<T>;
+    /** Array of plugins to apply to the chart */
     readonly plugins?: SolidUplotPlugin<T>[];
 };
+/**
+ * Metadata provided to the onCreate callback when the chart is initialized
+ */
 type OnCreateMeta = {
+    /** Array of series data extracted from the chart configuration */
     readonly seriesData: SeriesDatum[];
 };
+/**
+ * Props for the SolidUplot component
+ *
+ * @template T - The type of the plugin bus data structure
+ */
 type SolidUplotProps<T extends VoidStruct = VoidStruct> = SolidUplotOptions<T> & {
-    /** The ref of the uPlot instance */
+    /** Ref callback to access the chart container element */
     readonly ref?: (el: HTMLDivElement) => void;
-    /** Callback when uPlot instance is created */
+    /** Callback fired when the uPlot instance is created */
     readonly onCreate?: (u: uPlot, meta: OnCreateMeta) => void;
-    /** Apply scale reset on redraw triggered by updated plot data (default: `true`) */
+    /**
+     * Whether to reset scales when chart data is updated
+     * @default true
+     */
     readonly resetScales?: boolean;
-    /** The style of the uPlot instance container */
+    /** CSS styles for the chart container (position is managed internally) */
     readonly style?: Omit<JSX.CSSProperties, "position">;
-    /** The placement of the children container. Defaults to "top" */
+    /**
+     * Where to place children components relative to the chart
+     * @default "top"
+     */
     readonly childrenPlacement?: ChildrenPlacement;
     /**
      * Enable automatic resizing to fit container.
@@ -39,6 +71,35 @@ type SolidUplotProps<T extends VoidStruct = VoidStruct> = SolidUplotOptions<T> &
      */
     readonly autoResize?: boolean;
 };
+/**
+ * A SolidJS wrapper component for uPlot charts with enhanced features
+ *
+ * This component provides:
+ * - Reactive data updates
+ * - Plugin system with communication bus
+ * - Automatic resizing capabilities
+ * - Flexible children placement
+ * - TypeScript support with generics
+ *
+ * @template T - The type of the plugin bus data structure for type-safe plugin communication
+ *
+ * @param props - Component props extending uPlot options with SolidJS enhancements
+ * @returns JSX element containing the chart and any children components
+ *
+ * @example
+ * ```tsx
+ * <SolidUplot
+ *   data={chartData}
+ *   height={400}
+ *   autoResize
+ *   series={[
+ *     {},
+ *     { label: "Series 1", stroke: "red" }
+ *   ]}
+ *   onCreate={(chart) => console.log("Chart created:", chart)}
+ * />
+ * ```
+ */
 declare const SolidUplot: <T extends VoidStruct = VoidStruct>(props: ParentProps<SolidUplotProps<T>>) => JSX.Element;
 
-export { SolidUplot, SolidUplotPluginBus, VoidStruct };
+export { SolidUplot };

package/dist/plugins/index.d.ts

@@ -226,6 +226,13 @@ declare const focusSeries: (options?: FocusSeriesPluginOptions) => PluginFactory
  * Simple legend placement options - only top corners to avoid axis conflicts
  */
 type LegendPlacement = "top-left" | "top-right";
+/**
+ * Props passed to the custom legend SolidJS component.
+ *
+ * The legend plugin automatically provides these props to your custom component, ensuring it always
+ * receives the latest series data from the chart via the plugin bus system. This creates a reactive
+ * data flow where series data changes immediately trigger legend updates with fresh data information.
+ */
 type LegendProps = {
     readonly u: uPlot;
     readonly seriesData: SeriesDatum[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dschz/solid-uplot",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "SolidJS wrapper for uPlot — ultra-fast, tiny time-series & charting library",
   "type": "module",
   "author": "Daniel Sanchez <dsanc89@pm.me>",