@gravity-ui/charts 0.5.0 → 0.6.0

package/dist/esm/hooks/useTooltip/index.d.ts

@@ -1,13 +1,12 @@
 import type { Dispatch } from 'd3';
-import type { TooltipDataChunk } from '../../types';
+import type { PointPosition, TooltipDataChunk } from '../../types';
 import type { PreparedTooltip } from '../useChartOptions/types';
-import type { PointerPosition } from './types';
 type Args = {
     dispatcher: Dispatch<object>;
     tooltip: PreparedTooltip;
 };
 export declare const useTooltip: ({ dispatcher, tooltip }: Args) => {
     hovered: TooltipDataChunk[] | undefined;
-    pointerPosition: PointerPosition | undefined;
+    pointerPosition: PointPosition | undefined;
 };
 export {};

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

@@ -1,5 +1,5 @@
 import type { MeaningfulAny } from '../misc';
-import type { ChartTooltipRendererData } from './tooltip';
+import type { ChartTooltipRendererArgs } from './tooltip';
 export type ChartMargin = {
     top: number;
     right: number;
@@ -13,6 +13,6 @@ export type ChartOptions = {
             point: MeaningfulAny;
             series: MeaningfulAny;
         }, event: PointerEvent) => void;
-        pointermove?: (data: ChartTooltipRendererData | undefined, event: PointerEvent) => void;
+        pointermove?: (data: ChartTooltipRendererArgs | undefined, event: PointerEvent) => void;
     };
 };

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

@@ -16,7 +16,7 @@ export type ChartSeriesData<T = MeaningfulAny> = ScatterSeriesData<T> | PieSerie
 export type DataLabelRendererData<T = MeaningfulAny> = {
     data: ChartSeriesData<T>;
 };
-type BasicHoverState = {
+export type BasicHoverState = {
     /**
      * Enable separate styles for the hovered series.
      *
@@ -223,4 +223,3 @@ export type ChartSeriesOptions = {
         };
     };
 };
-export {};

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

@@ -59,7 +59,7 @@ export type TooltipDataChunkWaterfall<T = MeaningfulAny> = {
 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 ChartTooltipRendererData<T = MeaningfulAny> = {
+export type ChartTooltipRendererArgs<T = MeaningfulAny> = {
     hovered: TooltipDataChunk<T>[];
     xAxis?: ChartXAxis;
     yAxis?: ChartYAxis;
@@ -67,9 +67,9 @@ export type ChartTooltipRendererData<T = MeaningfulAny> = {
 export type ChartTooltip<T = MeaningfulAny> = {
     enabled?: boolean;
     /** Specifies the renderer for the tooltip. If returned null default tooltip renderer will be used. */
-    renderer?: (args: {
-        hovered: TooltipDataChunk<T>[];
-        xAxis?: ChartXAxis;
-        yAxis?: ChartYAxis;
-    }) => React.ReactElement | null;
+    renderer?: (args: ChartTooltipRendererArgs<T>) => React.ReactElement | null;
+    pin?: {
+        enabled?: boolean;
+        modifierKey?: 'altKey' | 'metaKey';
+    };
 };

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

@@ -2,3 +2,4 @@
  * A utilitarian type to describe `any` when it does not contradict the typescript usage paradigm.
  */
 export type MeaningfulAny = any;
+export type PointPosition = [number, number];

package/dist/esm/utils/misc.d.ts

@@ -1,2 +1,10 @@
-export declare const randomString: (length: number, chars: string) => string;
-export declare const getUniqId: () => string;
+export declare function randomString(length: number, chars: string): string;
+export declare function getUniqId(): string;
+/**
+ * Checks Macintosh hardware is used.
+ *
+ * Note: there is no better way to get this information as using depricated property `navigator.platform`.
+ *
+ * More details [here](https://developer.mozilla.org/en-US/docs/Web/API/Navigator/platform#examples).
+ */
+export declare function isMacintosh(): boolean;

package/dist/esm/utils/misc.js

@@ -1,8 +1,20 @@
-export const randomString = (length, chars) => {
+export function randomString(length, chars) {
     let result = '';
     for (let i = length; i > 0; --i) {
         result += chars[Math.floor(Math.random() * chars.length)];
     }
     return result;
-};
-export const getUniqId = () => `gravity-chart.${randomString(5, '0123456789abcdefghijklmnopqrstuvwxyz')}`;
+}
+export function getUniqId() {
+    return `gravity-chart.${randomString(5, '0123456789abcdefghijklmnopqrstuvwxyz')}`;
+}
+/**
+ * Checks Macintosh hardware is used.
+ *
+ * Note: there is no better way to get this information as using depricated property `navigator.platform`.
+ *
+ * More details [here](https://developer.mozilla.org/en-US/docs/Web/API/Navigator/platform#examples).
+ */
+export function isMacintosh() {
+    return typeof navigator === 'undefined' ? false : /Mac|iP(hone|[oa]d)/.test(navigator.platform);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gravity-ui/charts",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "description": "React component used to render charts",
   "license": "MIT",
   "main": "dist/cjs/index.js",

package/dist/cjs/hooks/useTooltip/types.d.ts

@@ -1 +0,0 @@
-export type PointerPosition = [number, number];

package/dist/esm/hooks/useTooltip/types.d.ts

@@ -1 +0,0 @@
-export type PointerPosition = [number, number];