@codecademy/gamut
68.2.168.2.2-alpha.8940e8.0
dist/BarChart/utils/index.d.ts~
dist/BarChart/utils/index.d.tsModified+6−6
Index: package/dist/BarChart/utils/index.d.ts
===================================================================
--- package/dist/BarChart/utils/index.d.ts
+++ package/dist/BarChart/utils/index.d.ts
@@ -13,26 +13,26 @@
*/
export declare const formatValueWithUnit: ({ value, unit, locale, }: {
value: number;
unit: string;
- locale?: string | undefined;
+ locale?: string;
}) => string;
export declare const formatNumberUnitCompact: ({ num, locale, }: {
num: number;
- locale?: string | undefined;
+ locale?: string;
}) => string;
/**
* Sort bars based on sortBy and order configuration
*/
export declare const sortBars: <T extends BarProps>({ bars, sortBy, order, }: {
bars: T[];
- sortBy: 'label' | 'value' | 'none';
- order: 'ascending' | 'descending';
+ sortBy: "label" | "value" | "none";
+ order: "ascending" | "descending";
}) => T[];
/**
* Returns the accessibility summary for a bar row. The summary is used as aria-label on the row's link/button when interactive, or as screenreader-only text when not. Summaries come from stackedBarSummary (stacked rows) or singleValueBarSummary (single-value rows), with default implementations when not overridden.
*/
-export declare const getValuesSummary: ({ seriesOneValue, seriesTwoValue, unit, categoryLabel, translations, }: Pick<BarProps, "categoryLabel" | "seriesOneValue" | "seriesTwoValue"> & Required<Pick<BarChartUnit, "unit">> & {
+export declare const getValuesSummary: ({ seriesOneValue, seriesTwoValue, unit, categoryLabel, translations, }: Pick<BarProps, "seriesOneValue" | "seriesTwoValue" | "categoryLabel"> & Required<Pick<BarChartUnit, "unit">> & {
translations: BarChartTranslations;
}) => string;
/**
* Calculates the value for a given label position (scale min is always 0).
@@ -52,5 +52,5 @@
}) => number;
/**
* Generates a stable key for a bar row (for React list keys).
*/
-export declare const getBarRowKey: (bar: Pick<BarProps, 'categoryLabel' | 'seriesOneValue' | 'seriesTwoValue'>, index: number) => string;
+export declare const getBarRowKey: (bar: Pick<BarProps, "categoryLabel" | "seriesOneValue" | "seriesTwoValue">, index: number) => string;