@redsift/charts 6.2.0 → 6.3.0

package/index.d.ts

@@ -1,7 +1,11 @@
 import { PieArcDatum as PieArcDatum$1 } from 'd3-shape';
-import { Ref, ReactElement, ComponentProps } from 'react';
+import { ValueOf as ValueOf$1, Comp } from '@redsift/design-system';
+import { ComponentProps } from 'react';
 import * as styled_components from 'styled-components';
 
+/** Get types of the values of a record. */
+declare type ValueOf<T extends Record<any, any>> = T[keyof T];
+
 declare type ChartDimensions = {
     width: number;
     height: number;
@@ -15,8 +19,21 @@ declare type Datum = {
     value: number;
 };
 declare type PieArcDatum = PieArcDatum$1<Datum>;
+declare const ColorTheme: {
+    readonly default: "default";
+    readonly dark: "dark";
+    readonly darker: "darker";
+    readonly monochrome: "monochrome";
+};
+declare type ColorTheme = ValueOf<typeof ColorTheme>;
+declare type SuccessDangerColorTheme = {
+    success: string;
+    warning: string;
+    danger: string;
+    neutral?: string;
+};
 
-declare const neutral = "#B6DAEE";
+declare const monochrome = "#B6DAEE";
 declare const scheme: {
     default: string[];
     dark: string[];
@@ -24,29 +41,15 @@ declare const scheme: {
     light: string[];
     lighter: string[];
     monochrome: string[];
+    empty: string[];
 };
 declare const successDangerScheme: {
     success: string;
     warning: string;
     danger: string;
+    neutral: string;
 };
-
-/** Component Type. */
-declare type Comp<P, T = HTMLElement> = {
-    (props: P & {
-        ref?: Ref<T>;
-    }): ReactElement | null;
-    /** React component type. */
-    readonly $$typeof: symbol;
-    /** Component default props. */
-    defaultProps?: Partial<P>;
-    /** Component name. */
-    displayName?: string;
-    /** Component base class name. */
-    className?: string;
-};
-/** Get types of the values of a record. */
-declare type ValueOf<T extends Record<any, any>> = T[keyof T];
+declare const getColorScale: (theme: ColorTheme | SuccessDangerColorTheme, isEmpty?: boolean) => undefined<string, string, never>;
 
 /**
  * Component size.
@@ -56,7 +59,7 @@ declare const PieChartSize: {
     readonly medium: "medium";
     readonly large: "large";
 };
-declare type PieChartSize = ValueOf<typeof PieChartSize>;
+declare type PieChartSize = ValueOf$1<typeof PieChartSize>;
 /**
  * Component variant.
  */
@@ -66,7 +69,7 @@ declare const PieChartVariant: {
     readonly donut: "donut";
     readonly spacedDonut: "spacedDonut";
 };
-declare type PieChartVariant = ValueOf<typeof PieChartVariant>;
+declare type PieChartVariant = ValueOf$1<typeof PieChartVariant>;
 /**
  * Component's labels variant.
  */
@@ -77,7 +80,7 @@ declare const PieChartLabelVariant: {
     readonly externalLabelValue: "externalLabelValue";
     readonly externalLabelPercent: "externalLabelPercent";
 };
-declare type PieChartLabelVariant = ValueOf<typeof PieChartLabelVariant>;
+declare type PieChartLabelVariant = ValueOf$1<typeof PieChartLabelVariant>;
 /**
  * Component theme.
  */
@@ -87,12 +90,19 @@ declare const PieChartTheme: {
     readonly darker: "darker";
     readonly monochrome: "monochrome";
 };
-declare type PieChartTheme = ValueOf<typeof PieChartTheme>;
+declare type PieChartTheme = ValueOf$1<typeof PieChartTheme>;
+/**
+ * Tooltip label variant.
+ */
+declare const PieChartTooltipVariant: {
+    none: string;
+    label: string;
+    value: string;
+    percent: string;
+};
+declare type PieChartTooltipVariant = ValueOf$1<typeof PieChartTooltipVariant>;
 interface LocaleText {
-    emptyChartTitle: string;
-    emptyChartSubtitle: string;
-    emptyChartResetLabel: string;
-    resetLabel: string;
+    emptyChartText: string;
 }
 /**
  * Component props.
@@ -110,26 +120,24 @@ interface PieChartProps extends ComponentProps<'div'> {
     localeText?: LocaleText;
     /** Method to be called on a click on a slice. */
     onSliceClick?: (data: Datum) => void;
-    /** Method to be called when hovering a slice. */
-    onSliceHover?: (data: Datum) => void;
     /** Whether a category should be displayed for categories that has been removed by the caping option. Optionaly, this prop can be used to change the label of this category. */
     others?: boolean | string;
     /** PieChart size. */
     size?: PieChartSize;
-    /** Secondary text to be displayed in the middle of the chart, above the main text. Only for donut variant. */
+    /** Secondary text to be displayed in the middle of the chart, between the main text and subtext. Recommended to be used with donut variants only. */
+    middleText?: string;
+    /** Secondary text to be displayed in the middle of the chart, above the main text. Recommended to be used with `donut` variants only. */
     subtext?: string;
-    /** Main text to be displayed in the middle of the chart. Only for donut variant. */
+    /** Main text to be displayed in the middle of the chart. Recommended to be used with `donut` variants only. */
     text?: string;
     /** Color palette to use. You can choose among the list of available color palette or also choose to use the success/warning/danger theme for which you have to specify which key corresponds to which status.  */
-    theme?: PieChartTheme | {
-        success: string;
-        warning: string;
-        danger: string;
-    };
+    theme?: PieChartTheme | SuccessDangerColorTheme;
     /** Title. */
     title?: string;
     /** PieChart variant. */
     variant?: PieChartVariant;
+    /** Tooltip variant. */
+    tooltipVariant?: PieChartTooltipVariant;
 }
 declare type StyledPieChartProps = Omit<PieChartProps, 'data'> & {};
 interface PieChartArcProps extends ComponentProps<'g'> {
@@ -137,13 +145,16 @@ interface PieChartArcProps extends ComponentProps<'g'> {
     data: Datum;
     index: number;
     onClick?: () => void;
-    onMouseOver?: () => void;
     path: string;
     spaced?: boolean;
+    showTooltip: boolean;
+    tooltipPercent: string | null;
+    tooltipLabelOnly: boolean;
+    isEmpty: boolean;
 }
-declare type StyledPieChartArcProps = Omit<PieChartArcProps, 'color' | 'data' | 'index' | 'path' | 'spaced'> & {
-    $hover: boolean;
+declare type StyledPieChartArcProps = Omit<PieChartArcProps, 'color' | 'data' | 'index' | 'path' | 'spaced' | 'showTooltip' | 'tooltipPercent' | 'tooltipLabelOnly' | 'isEmpty'> & {
     $spaced: boolean;
+    $clickable: boolean;
 };
 
 declare const PieChart: Comp<PieChartProps, HTMLDivElement>;
@@ -156,13 +167,21 @@ declare const StyledPieChartTitle: styled_components.StyledComponent<"div", any,
 declare const StyledPieChartCaption: styled_components.StyledComponent<"p", any, Omit<PieChartProps, "data">, never>;
 declare const StyledPieChartCenterText: styled_components.StyledComponent<"div", any, {
     $maxWidth: number;
+    $textSize: number;
+    $smallTextSize: number;
+}, never>;
+declare const StyledPieChartEmptyText: styled_components.StyledComponent<"div", any, {
+    $maxWidth: number;
+    $textSize: number;
+    $isDonut: boolean;
 }, never>;
 declare const StyledPieChartLabel: styled_components.StyledComponent<"li", any, {
     $color: string;
 }, never>;
-declare const StyledPieChartArc: styled_components.StyledComponent<"g", any, Omit<PieChartArcProps, "data" | "path" | "color" | "spaced" | "index"> & {
-    $hover: boolean;
+declare const StyledPieChartArc: styled_components.StyledComponent<"g", any, Omit<PieChartArcProps, "data" | "path" | "color" | "spaced" | "index" | "showTooltip" | "tooltipPercent" | "tooltipLabelOnly" | "isEmpty"> & {
     $spaced: boolean;
+    $clickable: boolean;
 }, never>;
+declare const Tooltip: styled_components.StyledComponent<"div", any, {}, never>;
 
-export { ChartDimensions, Datum, PieArcDatum, PieChart, PieChartArcProps, PieChartLabelVariant, PieChartProps, PieChartSize, PieChartTheme, PieChartVariant, StyledPieChart, StyledPieChartArc, StyledPieChartArcProps, StyledPieChartCaption, StyledPieChartCenterText, StyledPieChartLabel, StyledPieChartProps, StyledPieChartTitle, neutral, scheme, successDangerScheme };
+export { ChartDimensions, ColorTheme, Datum, PieArcDatum, PieChart, PieChartArcProps, PieChartLabelVariant, PieChartProps, PieChartSize, PieChartTheme, PieChartTooltipVariant, PieChartVariant, StyledPieChart, StyledPieChartArc, StyledPieChartArcProps, StyledPieChartCaption, StyledPieChartCenterText, StyledPieChartEmptyText, StyledPieChartLabel, StyledPieChartProps, StyledPieChartTitle, SuccessDangerColorTheme, Tooltip, getColorScale, monochrome, scheme, successDangerScheme };