@gravity-ui/charts 0.6.0 → 0.7.0

package/dist/esm/types/chart/legend.d.ts

@@ -1,5 +1,5 @@
 import type { BaseTextStyle } from './base';
-export type ChartLegend = {
+export interface ChartLegend {
     enabled?: boolean;
     /**
      * Different types for different color schemes.
@@ -47,16 +47,16 @@ export type ChartLegend = {
         domain?: number[];
     };
     width?: number;
-};
-export type BaseLegendSymbol = {
+}
+export interface BaseLegendSymbol {
     /**
      * The pixel padding between the legend item symbol and the legend item text.
      *
      * @default 5
      * */
     padding?: number;
-};
-export type RectLegendSymbolOptions = BaseLegendSymbol & {
+}
+export interface RectLegendSymbolOptions extends BaseLegendSymbol {
     /**
      * The pixel width of the symbol for series types that use a rectangle in the legend
      *
@@ -75,20 +75,20 @@ export type RectLegendSymbolOptions = BaseLegendSymbol & {
      * Defaults to half the symbolHeight, effectively creating a circle.
      */
     radius?: number;
-};
-export type PathLegendSymbolOptions = BaseLegendSymbol & {
+}
+export interface PathLegendSymbolOptions extends BaseLegendSymbol {
     /**
      * The pixel width of the symbol for series types that use a path in the legend
      *
      * @default 16
      * */
     width?: number;
-};
-export type SymbolLegendSymbolOptions = BaseLegendSymbol & {
+}
+export interface SymbolLegendSymbolOptions extends BaseLegendSymbol {
     /**
      * The pixel width of the symbol for series types that use a symbol in the legend
      *
      * @default 8
      * */
     width?: number;
-};
+}

package/dist/esm/types/chart/line.d.ts

@@ -3,7 +3,7 @@ import type { MeaningfulAny } from '../misc';
 import type { BaseSeries, BaseSeriesData } from './base';
 import type { ChartLegend, RectLegendSymbolOptions } from './legend';
 import type { PointMarkerOptions } from './marker';
-export type LineSeriesData<T = MeaningfulAny> = BaseSeriesData<T> & {
+export interface LineSeriesData<T = MeaningfulAny> extends BaseSeriesData<T> {
     /**
      * The `x` value of the point. Depending on the context , it may represents:
      * - numeric value (for `linear` x axis)
@@ -27,8 +27,8 @@ export type LineSeriesData<T = MeaningfulAny> = BaseSeriesData<T> & {
             };
         };
     };
-};
-export type LineSeries<T = MeaningfulAny> = BaseSeries & {
+}
+export interface LineSeries<T = MeaningfulAny> extends BaseSeries {
     type: typeof SeriesType.Line;
     data: LineSeriesData<T>[];
     /** The name of the series (used in legend, tooltip etc) */
@@ -54,4 +54,4 @@ export type LineSeries<T = MeaningfulAny> = BaseSeries & {
     opacity?: number;
     /** Y-axis index (when using two axes) */
     yAxis?: number;
-};
+}

package/dist/esm/types/chart/marker.d.ts

@@ -1,5 +1,5 @@
 import type { SymbolType } from '../../constants';
-export type PointMarkerOptions = {
+export interface PointMarkerOptions {
     /** Enable or disable the point marker */
     enabled?: boolean;
     /** The radius of the point marker */
@@ -9,4 +9,4 @@ export type PointMarkerOptions = {
     /** The width of the point marker's border */
     borderWidth?: number;
     symbol?: `${SymbolType}`;
-};
+}

package/dist/esm/types/chart/pie.d.ts

@@ -3,7 +3,7 @@ import type { SeriesType } from '../../constants';
 import type { MeaningfulAny } from '../misc';
 import type { BaseSeries, BaseSeriesData } from './base';
 import type { ChartLegend, RectLegendSymbolOptions } from './legend';
-export type PieSeriesData<T = MeaningfulAny> = BaseSeriesData<T> & {
+export interface PieSeriesData<T = MeaningfulAny> extends BaseSeriesData<T> {
     /** The value of the pie segment. */
     value: number;
     /** The name of the pie segment (used in legend, tooltip etc). */
@@ -14,10 +14,10 @@ export type PieSeriesData<T = MeaningfulAny> = BaseSeriesData<T> & {
     label?: string;
     /** Individual opacity for the pie segment. */
     opacity?: number;
-};
+}
 export type ConnectorShape = 'straight-line' | 'polyline';
 export type ConnectorCurve = 'linear' | 'basic';
-export type PieSeries<T = MeaningfulAny> = BaseSeries & {
+export interface PieSeries<T = MeaningfulAny> extends BaseSeries {
     type: typeof SeriesType.Pie;
     data: PieSeriesData<T>[];
     /**
@@ -85,4 +85,4 @@ export type PieSeries<T = MeaningfulAny> = BaseSeries & {
             innerRadius: number;
         };
     }) => BaseType;
-};
+}

package/dist/esm/types/chart/scatter.d.ts

@@ -2,7 +2,7 @@ import type { SeriesType, SymbolType } from '../../constants';
 import type { MeaningfulAny } from '../misc';
 import type { BaseSeries, BaseSeriesData } from './base';
 import type { ChartLegend, RectLegendSymbolOptions } from './legend';
-export type ScatterSeriesData<T = MeaningfulAny> = BaseSeriesData<T> & {
+export interface ScatterSeriesData<T = MeaningfulAny> extends BaseSeriesData<T> {
     /**
      * The `x` value of the point. Depending on the context , it may represents:
      * - numeric value (for `linear` x axis)
@@ -27,8 +27,8 @@ export type ScatterSeriesData<T = MeaningfulAny> = BaseSeriesData<T> & {
     radius?: number;
     /** Individual opacity for the point. */
     opacity?: number;
-};
-export type ScatterSeries<T = MeaningfulAny> = BaseSeries & {
+}
+export interface ScatterSeries<T = MeaningfulAny> extends BaseSeries {
     type: typeof SeriesType.Scatter;
     data: ScatterSeriesData<T>[];
     /** The name of the series (used in legend, tooltip etc) */
@@ -43,4 +43,4 @@ export type ScatterSeries<T = MeaningfulAny> = BaseSeries & {
     };
     /** Y-axis index (when using two axes) */
     yAxis?: number;
-};
+}

package/dist/esm/types/chart/series.d.ts

@@ -13,10 +13,10 @@ import type { TreemapSeries, TreemapSeriesData } from './treemap';
 import type { WaterfallSeries, WaterfallSeriesData } from './waterfall';
 export type ChartSeries<T = MeaningfulAny> = ScatterSeries<T> | PieSeries<T> | BarXSeries<T> | BarYSeries<T> | LineSeries<T> | AreaSeries<T> | TreemapSeries<T> | WaterfallSeries<T>;
 export type ChartSeriesData<T = MeaningfulAny> = ScatterSeriesData<T> | PieSeriesData<T> | BarXSeriesData<T> | BarYSeriesData<T> | LineSeriesData<T> | AreaSeriesData<T> | TreemapSeriesData<T> | WaterfallSeriesData<T>;
-export type DataLabelRendererData<T = MeaningfulAny> = {
+export interface DataLabelRendererData<T = MeaningfulAny> {
     data: ChartSeriesData<T>;
-};
-export type BasicHoverState = {
+}
+export interface BasicHoverState {
     /**
      * Enable separate styles for the hovered series.
      *
@@ -32,8 +32,8 @@ export type BasicHoverState = {
      * @default 0.3
      */
     brightness?: number;
-};
-export type BasicInactiveState = {
+}
+export interface BasicInactiveState {
     /**
      * Enable separate styles for the inactive series.
      *
@@ -46,8 +46,8 @@ export type BasicInactiveState = {
      * @default 0.5
      * */
     opacity?: number;
-};
-export type ChartSeriesOptions = {
+}
+export interface ChartSeriesOptions {
     /** Individual data label for each point. */
     dataLabels?: {
         /** Enable or disable the data labels */
@@ -222,4 +222,4 @@ export type ChartSeriesOptions = {
             inactive?: BasicInactiveState;
         };
     };
-};
+}

package/dist/esm/types/chart/split.d.ts

@@ -1,13 +1,13 @@
 import type { BaseTextStyle } from './base';
-export type SplitPlotOptions = {
+export interface SplitPlotOptions {
     title?: {
         text: string;
         style?: Partial<BaseTextStyle>;
     };
-};
-export type ChartSplit = {
+}
+export interface ChartSplit {
     enable: boolean;
     layout?: 'vertical';
     gap?: string | number;
     plots?: SplitPlotOptions[];
-};
+}

package/dist/esm/types/chart/title.d.ts

@@ -1,5 +1,5 @@
 import type { BaseTextStyle } from './base';
-export type ChartTitle = {
+export interface ChartTitle {
     text: string;
     style?: Partial<BaseTextStyle>;
-};
+}

package/dist/esm/types/chart/tooltip.d.ts

@@ -8,63 +8,63 @@ import type { PieSeries, PieSeriesData } from './pie';
 import type { ScatterSeries, ScatterSeriesData } from './scatter';
 import type { TreemapSeries, TreemapSeriesData } from './treemap';
 import type { WaterfallSeries, WaterfallSeriesData } from './waterfall';
-export type TooltipDataChunkBarX<T = MeaningfulAny> = {
+export interface TooltipDataChunkBarX<T = MeaningfulAny> {
     data: BarXSeriesData<T>;
     series: BarXSeries<T>;
-};
-export type TooltipDataChunkBarY<T = MeaningfulAny> = {
+}
+export interface TooltipDataChunkBarY<T = MeaningfulAny> {
     data: BarYSeriesData<T>;
     series: BarYSeries<T>;
-};
-export type TooltipDataChunkPie<T = MeaningfulAny> = {
+}
+export interface TooltipDataChunkPie<T = MeaningfulAny> {
     data: PieSeriesData<T>;
     series: {
         type: PieSeries['type'];
         id: string;
         name: string;
     };
-};
-export type TooltipDataChunkScatter<T = MeaningfulAny> = {
+}
+export interface TooltipDataChunkScatter<T = MeaningfulAny> {
     data: ScatterSeriesData<T>;
     series: {
         type: ScatterSeries['type'];
         id: string;
         name: string;
     };
-};
-export type TooltipDataChunkLine<T = MeaningfulAny> = {
+}
+export interface TooltipDataChunkLine<T = MeaningfulAny> {
     data: LineSeriesData<T>;
     series: {
         type: LineSeries['type'];
         id: string;
         name: string;
     };
-};
-export type TooltipDataChunkArea<T = MeaningfulAny> = {
+}
+export interface TooltipDataChunkArea<T = MeaningfulAny> {
     data: AreaSeriesData<T>;
     series: {
         type: AreaSeries['type'];
         id: string;
         name: string;
     };
-};
-export type TooltipDataChunkTreemap<T = MeaningfulAny> = {
+}
+export interface TooltipDataChunkTreemap<T = MeaningfulAny> {
     data: TreemapSeriesData<T>;
     series: TreemapSeries<T>;
-};
-export type TooltipDataChunkWaterfall<T = MeaningfulAny> = {
+}
+export interface TooltipDataChunkWaterfall<T = MeaningfulAny> {
     data: WaterfallSeriesData<T>;
     series: WaterfallSeries<T>;
-};
+}
 export type TooltipDataChunk<T = MeaningfulAny> = (TooltipDataChunkBarX<T> | TooltipDataChunkBarY<T> | TooltipDataChunkPie<T> | TooltipDataChunkScatter<T> | TooltipDataChunkLine<T> | TooltipDataChunkArea<T> | TooltipDataChunkTreemap<T> | TooltipDataChunkWaterfall<T>) & {
     closest?: boolean;
 };
-export type ChartTooltipRendererArgs<T = MeaningfulAny> = {
+export interface ChartTooltipRendererArgs<T = MeaningfulAny> {
     hovered: TooltipDataChunk<T>[];
     xAxis?: ChartXAxis;
     yAxis?: ChartYAxis;
-};
-export type ChartTooltip<T = MeaningfulAny> = {
+}
+export interface ChartTooltip<T = MeaningfulAny> {
     enabled?: boolean;
     /** Specifies the renderer for the tooltip. If returned null default tooltip renderer will be used. */
     renderer?: (args: ChartTooltipRendererArgs<T>) => React.ReactElement | null;
@@ -72,4 +72,4 @@ export type ChartTooltip<T = MeaningfulAny> = {
         enabled?: boolean;
         modifierKey?: 'altKey' | 'metaKey';
     };
-};
+}

package/dist/esm/types/chart/treemap.d.ts

@@ -2,7 +2,7 @@ import type { LayoutAlgorithm, SeriesType } from '../../constants';
 import type { MeaningfulAny } from '../misc';
 import type { BaseSeries, BaseSeriesData } from './base';
 import type { ChartLegend, RectLegendSymbolOptions } from './legend';
-export type TreemapSeriesData<T = MeaningfulAny> = BaseSeriesData<T> & {
+export interface TreemapSeriesData<T = MeaningfulAny> extends BaseSeriesData<T> {
     /** The name of the node (used in legend, tooltip etc). */
     name: string | string[];
     /** The value of the node. All nodes should have this property except nodes that have children. */
@@ -14,8 +14,8 @@ export type TreemapSeriesData<T = MeaningfulAny> = BaseSeriesData<T> & {
      * If no nodes has a matching id, or this option is undefined, then the parent will be set to the root.
      */
     parentId?: string;
-};
-export type TreemapSeries<T = MeaningfulAny> = BaseSeries & {
+}
+export interface TreemapSeries<T = MeaningfulAny> extends BaseSeries {
     type: typeof SeriesType.Treemap;
     data: TreemapSeriesData<T>[];
     /** The name of the series (used in legend, tooltip etc). */
@@ -43,4 +43,4 @@ export type TreemapSeries<T = MeaningfulAny> = BaseSeries & {
         /** Horizontal alignment of the data label inside the tile. */
         align?: 'left' | 'center' | 'right';
     };
-};
+}

package/dist/esm/types/chart/waterfall.d.ts

@@ -2,7 +2,7 @@ import type { SeriesType } from '../../constants';
 import type { MeaningfulAny } from '../misc';
 import type { BaseSeries, BaseSeriesData } from './base';
 import type { ChartLegend, RectLegendSymbolOptions } from './legend';
-export type WaterfallSeriesData<T = MeaningfulAny> = BaseSeriesData<T> & {
+export interface WaterfallSeriesData<T = MeaningfulAny> extends BaseSeriesData<T> {
     /**
      * The `x` value. Depending on the context , it may represents:
      * - numeric value (for `linear` x axis)
@@ -21,8 +21,8 @@ export type WaterfallSeriesData<T = MeaningfulAny> = BaseSeriesData<T> & {
     opacity?: number;
     /** When this property is true, the point display the total sum across the entire series. */
     total?: boolean;
-};
-export type WaterfallSeries<T = MeaningfulAny> = BaseSeries & {
+}
+export interface WaterfallSeries<T = MeaningfulAny> extends BaseSeries {
     type: typeof SeriesType.Waterfall;
     data: WaterfallSeriesData<T>[];
     /** The name of the series (used in legend, tooltip etc). */
@@ -37,4 +37,4 @@ export type WaterfallSeries<T = MeaningfulAny> = BaseSeries & {
     legend?: ChartLegend & {
         symbol?: RectLegendSymbolOptions;
     };
-};
+}

package/dist/esm/types/chart-ui.d.ts

@@ -1,5 +1,5 @@
 import type { BaseTextStyle } from './chart/base';
-export type LabelData = {
+export interface LabelData {
     text: string;
     x: number;
     y: number;
@@ -13,12 +13,16 @@ export type LabelData = {
         id: string;
     };
     active?: boolean;
-};
-export type HtmlItem = {
+}
+export interface HtmlItem {
     x: number;
     y: number;
     content: string;
-};
-export type ShapeDataWithHtmlItems = {
+    size: {
+        width: number;
+        height: number;
+    };
+}
+export interface ShapeDataWithHtmlItems {
     htmlElements: HtmlItem[];
-};
+}

package/dist/esm/types/formatter.d.ts

@@ -1,14 +1,14 @@
-export type FormatOptions = {
+export interface FormatOptions {
     precision?: number | 'auto';
     unitRate?: number;
     showRankDelimiter?: boolean;
     lang?: string;
     labelMode?: string;
-};
-export type FormatNumberOptions = FormatOptions & {
+}
+export interface FormatNumberOptions extends FormatOptions {
     format?: 'number' | 'percent';
     multiplier?: number;
     prefix?: string;
     postfix?: string;
     unit?: 'auto' | 'k' | 'm' | 'b' | 't' | null;
-};
+}

package/dist/esm/types/index.d.ts

@@ -25,18 +25,48 @@ export * from './chart/tooltip';
 export * from './chart/halo';
 export * from './chart/treemap';
 export * from './chart/waterfall';
-export type ChartData<T = MeaningfulAny> = {
+export interface ChartData<T = MeaningfulAny> {
+    /**
+     * General options for the chart.
+     */
     chart?: ChartOptions;
+    /**
+     * The legend displays a labeled box for each data element in the chart.
+     * It shows a distinctive symbol paired with a name for every series.
+     */
     legend?: ChartLegend;
+    /**
+     * Represents the series data and series options.
+     */
     series: {
+        /**
+         * Contains data points to be plotted.
+         */
         data: ChartSeries<T>[];
+        /**
+         * Allows for customizing the appearance and behavior of the series.
+         */
         options?: ChartSeriesOptions;
     };
+    /**
+     * The main title of the chart.
+     */
     title?: ChartTitle;
+    /**
+     * Options for the tooltip that appears when the user hovers over a series or point.
+     */
     tooltip?: ChartTooltip<T>;
+    /**
+     * Options for the the X axis.
+     */
     xAxis?: ChartXAxis;
+    /**
+     * Options for the the Y axis or multiple Y axes.
+     */
     yAxis?: ChartYAxis[];
-    /** Setting for displaying charts on different plots.
-     * It can be used to visualize related information on multiple charts. */
+    /**
+     * Setting for displaying charts on different plots.
+     * It can be used to visualize related information on multiple charts.
+     */
     split?: ChartSplit;
-};
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gravity-ui/charts",
-  "version": "0.6.0",
+  "version": "0.7.0",
   "description": "React component used to render charts",
   "license": "MIT",
   "main": "dist/cjs/index.js",
@@ -50,7 +50,10 @@
     "build": "gulp",
     "start": "storybook dev -p 7007",
     "build-storybook": "storybook build -c .storybook -o storybook-static",
-    "prepublishOnly": "npm run build"
+    "prepublishOnly": "npm run build",
+    "docs:deps": "cd ./docs && npm ci",
+    "docs:dev": "cd ./docs && npm run docs:dev",
+    "docs:build": "cd ./docs && npm run docs:build"
   },
   "dependencies": {
     "@bem-react/classname": "^1.6.0",
@@ -70,7 +73,7 @@
     "@gravity-ui/prettier-config": "^1.1.0",
     "@gravity-ui/stylelint-config": "^4.0.1",
     "@gravity-ui/tsconfig": "^1.0.0",
-    "@gravity-ui/uikit": "^6.15.0",
+    "@gravity-ui/uikit": "^7.4.0",
     "@storybook/addon-a11y": "^8.2.9",
     "@storybook/addon-actions": "^8.2.9",
     "@storybook/addon-essentials": "^8.2.9",
@@ -122,7 +125,7 @@
     "typescript": "^5.5.4"
   },
   "peerDependencies": {
-    "@gravity-ui/uikit": "^6.0.0",
+    "@gravity-ui/uikit": "^7.0.0",
     "react": ">=17.0.0",
     "react-dom": ">=17.0.0"
   },