@graphysdk/react-renderer 0.0.1-alpha.20260714170734 → 0.0.1-alpha.20260721093629

package/dist/index.d.ts

@@ -213,11 +213,13 @@ export declare interface FontLength {
     unit: 'px' | 'em';
 }
 
+/** Host font catalog mapping each font id a spec may reference to the CSS `font-family` string to render it with. */
 export declare type FontListInput = Array<{
     id: string;
     fontFamily: string;
 }>;
 
+/** A CSS `font-style` keyword accepted by a measured font token override. */
 export declare type FontStyle = (typeof FONT_STYLES)[number];
 
 /**
@@ -249,6 +251,7 @@ export declare interface FooterSlotProps {
     isSourceVisible: boolean;
 }
 
+/** A custom geom `renderHoverCompanions` handler's input: the layer plus the primary and related hover hits. */
 export declare type GeomHoverCompanionsRendererInput = HoverCompanionsRenderInput;
 
 /** Page-relative cursor coordinates the push-path tooltip anchors to. */
@@ -268,8 +271,10 @@ export declare interface GeomHoverPush {
     (key: null): void;
 }
 
+/** A custom geom `renderHover` handler's input: the hovered layer plus the primary/group/related hover hits. */
 export declare type GeomHoverRendererInput = HoverRenderInput;
 
+/** A custom geom `getOverlayAnchor` handler's input: the layer, coord system, and the matched observation. */
 export declare type GeomOverlayAnchorRendererInput = OverlayAnchorInput;
 
 /** An overlay-hosted geom's paint function — receives the guaranteed overlay wiring on `input.overlay`. */
@@ -328,8 +333,8 @@ export declare interface GeomRenderContract<G extends GeomName | string = string
      * Optional repaint of the matched subset for the highlight overlay. Omit it and the highlight layer
      * falls back to {@link render}. A geom overrides it when the plain column-grouped render would
      * misrepresent a matched subset — a bar repaints each matched observation as an isolated stack segment
-     * (from its compiled stack cap), so a lone mid-stack match keeps its square-edged silhouette and
-     * single-width border instead of regrouping into a standalone rounded, boxed bar.
+     * (from its compiled stack role), so a lone mid-stack match keeps its square-edged silhouette and
+     * single-width border instead of regrouping into a standalone rounded bar.
      */
     renderHighlight?: (input: HighlightRenderInput<G, C>) => ReactNode;
     renderHover: (input: HoverRenderInput<G, C>) => ReactNode;
@@ -450,6 +455,7 @@ export declare type GraphMode = 'readonly' | 'editable';
  */
 export declare const GraphProvider: ({ data, input, plugins, formattingLocale, onChange, onError, onWarnings, customPalettes, theme, fontList, themeOverrides: themeOverridesInput, children, }: GraphProviderProps) => JSX.Element;
 
+/** Props for {@link GraphProvider}: the data and spec input to compile, plus theme, locale and plugin wiring. */
 export declare interface GraphProviderProps {
     data: Data;
     input: CompilerInput;
@@ -715,8 +721,10 @@ export declare interface PanelScreenRect {
 
 export { RenderHitTester }
 
+/** Fires on each deduped size change — the shape of `GraphRenderer`'s `onResize` callback. */
 export declare type ResizeObserverOnResize = (state: ResizeObserverState) => void;
 
+/** The observed element's content-box size in CSS pixels, rounded to integers. */
 export declare interface ResizeObserverState {
     width: number;
     height: number;
@@ -854,6 +862,7 @@ declare interface TooltipAnchor {
     placement: CalloutPlacement;
 }
 
+/** Props for the Tooltip slot, overridable via `slots.Tooltip` on `GraphRenderer`. Positioning stays built in. */
 export declare interface TooltipSlotProps {
     /** Render-ready tooltip body, already formatted by the viz-engine runtime. */
     content: TooltipContent;