@redsift/charts 10.3.0-alpha.4 → 10.3.0-alpha.6

package/CONTRIBUTING.md

@@ -137,9 +137,6 @@ import { BadgeProps } from './types';
 
 const COMPONENT_NAME = 'Badge';
 const CLASSNAME = 'redsift-badge';
-const DEFAULT_PROPS: Partial<BadgeProps> = {
-  // default values
-};
 
 /**
  * The Badge component.
@@ -162,7 +159,6 @@ export const Badge: Comp<BadgeProps, HTMLDivElement> = forwardRef((props, ref) =
   );
 });
 Badge.className = CLASSNAME;
-Badge.defaultProps = DEFAULT_PROPS;
 Badge.displayName = COMPONENT_NAME;
 ```
 

package/index.d.ts

@@ -394,6 +394,8 @@ interface DataPointProps<T> extends Omit<ComponentProps<'g'>, 'onClick' | 'scale
     color?: string;
     /** Data. Also state to which the component should end the animation, if any. */
     data: T;
+    /** Href when the component is a navigation link. */
+    href?: string;
     /** Id. Used for accessibility. */
     id?: string;
     /** Position in the list of siblings. Used for placement and selection. */
@@ -411,7 +413,7 @@ interface DataPointProps<T> extends Omit<ComponentProps<'g'>, 'onClick' | 'scale
     /** State from which the component should start the animation, if any. */
     previousData?: T;
     /** Role. Will be set to 'button' if onClick is provided. If 'option', then the component becomes selectable. */
-    role?: 'button' | 'link' | 'option';
+    role?: 'img' | 'button' | 'link' | 'option';
     /** Theme. */
     theme?: Theme;
     /** Tooltip variant. */
@@ -542,6 +544,23 @@ interface ChartContainerProps extends Omit<ComponentProps<'div'>, 'title'>, Cont
     title?: string | ReactElement;
     /** Theme. */
     theme?: Theme;
+    /** Description that won't be visually displayed but will be used for assistive technology. If you want to display the description, use `description` instead. */
+    descriptionForAssistiveTechnology?: string;
+    /** Whether the chart is static or interactive. */
+    mode?: 'static' | 'interactive';
+    /** Small text explaining which kind of chart is presenting and what's its basic composition. */
+    definition?: string;
+    /** Small text explaining the basic composition of the x-axis, if any. */
+    xAxisDefinition?: string;
+    /** Small text explaining the basic composition of the y-axis, if any. */
+    yAxisDefinition?: string;
+    /** Small text explaining how the chart is interactive, if any. */
+    interactionExplanation?: string;
+    /** Table representation of the chart. */
+    dataTableRepresentation?: {
+        header: ReactElement;
+        body: ReactElement;
+    };
 }
 type StyledChartContainerProps = Omit<ChartContainerProps, 'theme'> & {
     $theme: Theme;
@@ -643,7 +662,7 @@ interface BarChartProps extends ChartContainerProps, ChartAxesProps {
     /** @deprecated: Use xAxisTickRotation instead. Whether the x axis labels are rotated or not. */
     areXLabelsRotated?: boolean;
     /** Native HTML props to forward to each bar. */
-    barProps?: Omit<ComponentProps<'g'>, 'onClick' | 'orientation' | 'ref' | 'scale' | 'width'>;
+    barProps?: Omit<ComponentProps<'g'>, 'onClick' | 'orientation' | 'ref' | 'scale'>;
     /** Number of categories to use, the rest being put into a new category called "Others". */
     caping?: number;
     /** Dataset to use to generate the chart, should be a list of objects containing a key and a value. */
@@ -652,6 +671,11 @@ interface BarChartProps extends ChartContainerProps, ChartAxesProps {
     dataType?: 'TwoCategoryData' | 'LinearData' | 'CategoryData';
     /** Component to use if the chart is empty (replacing the default one). */
     emptyComponent?: ReactNode;
+    /** Method used to define the href on a bar used as a navigation link. */
+    getBarAnchorProps?: (datum: BarDatum) => {
+        href: string;
+        target?: string;
+    };
     /** Method to determine whether a slice is selected or not. */
     isBarSelected?: (datum: BarDatum) => void;
     /** Method to override the data labels. */
@@ -674,7 +698,7 @@ interface BarChartProps extends ChartContainerProps, ChartAxesProps {
     localeText?: LocaleText$3;
     /** Custom margins, used to give more space for axes labels and legend for instance. */
     margins?: MarginProps;
-    /** Method to be called on a click on a bar. */
+    /** Method to be called on a click on a bar. For a navigation link, please use `getBarAnchorProps` instead. */
     onBarClick?: (datum: BarDatum) => void;
     /** Orientation of the bar. */
     orientation?: BarOrientation;
@@ -895,6 +919,11 @@ interface PieChartProps extends ChartContainerProps {
     data?: CategoryData;
     /** Component to use if the chart is empty (replacing the default one). */
     emptyComponent?: ReactNode;
+    /** Method used to define the href on a bar used as a navigation link. */
+    getSliceAnchorProps?: (datum: ArcDatum) => {
+        href: string;
+        target?: string;
+    };
     /** Whether the pie or donut is cut in half or not. */
     isHalf?: boolean;
     /** Method to determine whether a slice is selected or not. */
@@ -917,7 +946,7 @@ interface PieChartProps extends ChartContainerProps {
     legendProps?: Omit<LegendProps, 'data' | 'ref' | 'variant'>;
     /** Labels and texts. */
     localeText?: LocaleText$1;
-    /** Method to be called on a click on a slice. */
+    /** Method to be called on a click on a slice. For a navigation link, please use `getSliceAnchorProps` instead. */
     onSliceClick?: (datum: ArcDatum) => 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;