@graphysdk/react-renderer 1.9.0-beta.1793017273153 → 1.9.0-beta.1793027249956

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -12,6 +12,7 @@ import { FormattedAxis } from '@graphysdk/viz-engine';
12
12
  import { FormattedHeadline } from '@graphysdk/viz-engine';
13
13
  import { FormattedLegend } from '@graphysdk/viz-engine';
14
14
  import { GraphLayout } from '@graphysdk/viz-engine';
15
+ import { GraphyBadgeVariant } from '@graphysdk/viz-engine';
15
16
  import { HeadlineMeasurer } from '@graphysdk/viz-engine';
16
17
  import { IntroStaggerOrder } from '@graphysdk/viz-engine';
17
18
  import { JSX } from 'react/jsx-runtime';
@@ -108,14 +109,6 @@ export declare const BarEditMenu: ObservationsEditMenu;
108
109
  */
109
110
  export declare const BarSection: ({ title, layout, preview }: OverridableSectionProps) => JSX.Element | null;
110
111
 
111
- /**
112
- * How the badge paints at the current frame size:
113
- * - `full` — glyph + "Made with Graphy" pill
114
- * - `mini` — circular glyph capsule
115
- * - `hidden` — flag off, or frame below the minimum footprint
116
- */
117
- declare type BrandMarkVisual = 'full' | 'mini' | 'hidden';
118
-
119
112
  /**
120
113
  * A press that performs an edit rather than sets a value.
121
114
  *
@@ -172,9 +165,6 @@ export declare const CalloutsSection: ({ title, layout, preview }: OverridableSe
172
165
  */
173
166
  export declare const CaptionSection: ({ title, layout, preview }: OverridableSectionProps) => JSX.Element | null;
174
167
 
175
- /** Every phrase a chart can say. The editing surface adds its own — see `editable/i18n/editor-i18n`. */
176
- declare type ChartPhrases = typeof EN_GB;
177
-
178
168
  /** The color row for a selection. Renders nothing where the command has nowhere to write. */
179
169
  export declare const ColorRow: {
180
170
  ({ target }: ResolvedObservations): JSX.Element | null;
@@ -850,10 +840,10 @@ declare interface FooterSlotProps {
850
840
  captionStyle: TextStyle;
851
841
  sourceStyle: SourceStyle;
852
842
  /**
853
- * Resolved badge visual for footer placement. `hidden` when the mark is off, below the min
854
- * footprint, or configured for header placement.
843
+ * The Graphy badge variant to paint in the footer, or `null` when the badge is off, the frame is
844
+ * below the minimum footprint, or the badge is positioned in the header.
855
845
  */
856
- brandMark: BrandMarkVisual;
846
+ graphyBadge: GraphyBadgeVariant | null;
857
847
  }
858
848
 
859
849
  /** The style menu and the annotate menu for one way observations are drawn. */
@@ -874,12 +864,12 @@ declare type GoalSectionProps = Omit<OverridableSectionProps, 'layout'>;
874
864
  * Chart display and interaction mode.
875
865
  * - 'readonly': Normal chart display with full interactivity but no editing (default)
876
866
  * - 'editable': Chart with inline editing capabilities for labels, titles, etc.
877
- * - 'point-and-edit': A press on the chart selects what it hit: an observation, its band, or the chart
867
+ * - 'pointAndEdit': A press on the chart selects what it hit: an observation, its band, or the chart
878
868
  */
879
869
  declare const GRAPH_MODES: {
880
870
  readonly readonly: "readonly";
881
871
  readonly editable: "editable";
882
- readonly pointAndEdit: "point-and-edit";
872
+ readonly pointAndEdit: "pointAndEdit";
883
873
  };
884
874
 
885
875
  /**
@@ -965,6 +955,9 @@ export declare interface GraphOptionsSectionProps extends OverridableSectionProp
965
955
  layerId?: string;
966
956
  }
967
957
 
958
+ /** Every phrase a chart can say. The editing surface adds its own — see `editable/i18n/editor-i18n`. */
959
+ declare type GraphPhrases = typeof EN_GB;
960
+
968
961
  /** Props for {@link GraphRenderer}: container sizing, interaction toggles and per-region slot overrides. */
969
962
  declare interface GraphRendererProps {
970
963
  /** Controls how the graph responds to its container size. Defaults to filling the parent container. */
@@ -1060,8 +1053,9 @@ declare interface GridProps {
1060
1053
  export declare const GridSection: ({ title, layout, preview }: OverridableSectionProps) => JSX.Element | null;
1061
1054
 
1062
1055
  /**
1063
- * Props for the Grid slot, overridable via `slots.Grid` on `GraphRenderer`. `panelRect` is in
1064
- * SVG-local coordinates.
1056
+ * Props for `GraphRenderer`'s `slots.Grid`. Rects use SVG-local coordinates.
1057
+ * `panelEdgeSizes` contains the maximum border or axis-line width on each edge.
1058
+ * Skip grid lines at edges with a positive width.
1065
1059
  *
1066
1060
  * A grid filling this slot spreads `stampGridEditTarget` on the group holding each line it draws, with a
1067
1061
  * hit area of its own inside that group, where `useGuidesTakePress` is true; a line it hides or moves
@@ -1069,7 +1063,7 @@ export declare const GridSection: ({ title, layout, preview }: OverridableSectio
1069
1063
  */
1070
1064
  declare interface GridSlotProps {
1071
1065
  axes: FormattedAxis[];
1072
- panelBorderSizes: EdgeSizes;
1066
+ panelEdgeSizes: EdgeSizes;
1073
1067
  panelFrameRect: GraphLayout['panelFrame'];
1074
1068
  panelRect: GraphLayout['panel'];
1075
1069
  }
@@ -1096,10 +1090,10 @@ declare interface HeaderSlotProps {
1096
1090
  headingStyle: TextStyle;
1097
1091
  subtitleStyle: TextStyle;
1098
1092
  /**
1099
- * Resolved badge visual for header placement. `hidden` when the mark is off, below the min
1100
- * footprint, or configured for footer placement.
1093
+ * The Graphy badge variant to paint in the header, or `null` when the badge is off, the frame is
1094
+ * below the minimum footprint, or the badge is positioned in the footer.
1101
1095
  */
1102
- brandMark: BrandMarkVisual;
1096
+ graphyBadge: GraphyBadgeVariant | null;
1103
1097
  }
1104
1098
 
1105
1099
  /**
@@ -1126,7 +1120,7 @@ declare interface HeadlineSlotProps {
1126
1120
 
1127
1121
  declare type I18nLocale = keyof typeof dictionaries;
1128
1122
 
1129
- declare type I18nRuntimeOverrides = RuntimeOverrides<ChartPhrases>;
1123
+ declare type I18nRuntimeOverrides = RuntimeOverrides<GraphPhrases>;
1130
1124
 
1131
1125
  /**
1132
1126
  * Provides editor translations. `EditableGraphRenderer` and `EditorPanel.Root` include this provider.
@@ -1594,7 +1588,7 @@ declare interface SwatchSlotProps {
1594
1588
  }
1595
1589
 
1596
1590
  /** The UI surface a swatch is painted on. Lets a Swatch slot restyle one surface and delegate the rest. */
1597
- declare type SwatchSurface = 'legend' | 'tooltip' | 'headline' | 'callout' | 'rule-label';
1591
+ declare type SwatchSurface = 'legend' | 'tooltip' | 'headline' | 'callout' | 'ruleLabel';
1598
1592
 
1599
1593
  /** An on/off toggle, for a setting whose whole value is whether it is on. */
1600
1594
  export declare const Switch: ({ checked, onChange, disabled, ariaLabel, ariaLabelledBy, id }: SwitchControlProps) => JSX.Element;