@shopify/polaris-viz - npm Package Compare versions

Comparing version 0.9.0 to 0.9.1

CHANGELOG.md

 # Changelog
 
+## Unreleased
+
+## [0.9.1] — 2021-04-27
+
+### Added
+
+- `<Sparkbar />` component
+- Annotations prop to `<BarChart />`
+
 ## [0.9.0] — 2021-04-26
@@ -4,0 +13,0 @@

package.json

 {
   "name": "@shopify/polaris-viz",
   "description": "Shopify’s viz component library",
-  "version": "0.9.0",
+  "version": "0.9.1",
   "private": false,
@@ -19,2 +19,3 @@ "license": "SEE LICENSE IN LICENSE.md",
     "test:coverage": "CI=true yarn test --coverage",
+    "test:debug:chrome": "osascript -e 'tell app \"Google Chrome\" to open location \"chrome://inspect\"' && sewing-kit-debug test --debug",
     "posttest:coverage": "yarn open:coverage",
@@ -21,0 +22,0 @@ "open:coverage": "open build/coverage/index.html",

types/components/BarChart/BarChart.d.ts

 import React from 'react';
 import { Data } from 'types';
-import { RenderTooltipContentData, BarOptions, GridOptions, XAxisOptions, YAxisOptions } from './types';
+import { RenderTooltipContentData, BarOptions, GridOptions, XAxisOptions, YAxisOptions, Annotation } from './types';
 export interface BarChartProps {
     data: Data[];
+    annotations?: Annotation[];
     skipLinkText?: string;
@@ -15,2 +16,2 @@ emptyStateText?: string;
 }
-export declare function BarChart({ data, renderTooltipContent, emptyStateText, isAnimated, skipLinkText, barOptions, gridOptions, xAxisOptions, yAxisOptions, }: BarChartProps): JSX.Element;
+export declare function BarChart({ data, annotations, renderTooltipContent, emptyStateText, isAnimated, skipLinkText, barOptions, gridOptions, xAxisOptions, yAxisOptions, }: BarChartProps): JSX.Element;

types/components/BarChart/Chart.d.ts

 import React from 'react';
 import { Data } from '../../types';
-import { RenderTooltipContentData, BarOptions, GridOptions, XAxisOptions, YAxisOptions } from './types';
+import { RenderTooltipContentData, BarOptions, GridOptions, XAxisOptions, YAxisOptions, AnnotationLookupTable } from './types';
 interface Props {
     data: Data[];
+    annotationsLookupTable: AnnotationLookupTable;
     chartDimensions: DOMRect;
@@ -17,3 +18,3 @@ renderTooltipContent: (data: RenderTooltipContentData) => React.ReactNode;
 }
-export declare function Chart({ data, chartDimensions, renderTooltipContent, emptyStateText, isAnimated, barOptions, gridOptions, xAxisOptions, yAxisOptions, }: Props): JSX.Element;
+export declare function Chart({ data, annotationsLookupTable, chartDimensions, renderTooltipContent, emptyStateText, isAnimated, barOptions, gridOptions, xAxisOptions, yAxisOptions, }: Props): JSX.Element;
 export {};

types/components/BarChart/components/index.d.ts

 export { TooltipContent, TooltipContentProps } from './TooltipContent';
+export { AnnotationLine } from './AnnotationLine';

types/components/BarChart/components/TooltipContent/TooltipContent.d.ts

 /// <reference types="react" />
+import { Annotation } from '../../types';
 export interface TooltipContentProps {
     label: string;
     value: string;
+    annotation?: Annotation;
 }
-export declare function TooltipContent({ label, value }: TooltipContentProps): JSX.Element;
+export declare function TooltipContent({ label, value, annotation, }: TooltipContentProps): JSX.Element;

types/components/BarChart/types.d.ts

@@ -11,2 +11,3 @@ import { Color, StringLabelFormatter, NumberLabelFormatter } from 'types';
     value: number;
+    annotation?: Annotation;
 }
@@ -33,1 +34,15 @@ export interface BarOptions {
 }
+export interface Annotation {
+    dataIndex: number;
+    width: number;
+    color: string;
+    tooltipData?: {
+        label: string;
+        value: string;
+    };
+    ariaLabel?: string;
+    xOffset?: number;
+}
+export interface AnnotationLookupTable {
+    [key: number]: Annotation;
+}

types/components/index.d.ts

@@ -5,2 +5,3 @@ export { Point } from './Point';
 export { Sparkline, SparklineProps } from './Sparkline';
+export { Sparkbar, SparkbarProps } from './Sparkbar';
 export { BarChart, BarChartProps, BarChartTooltipContent, BarChartTooltipContentProps, } from './BarChart';
@@ -7,0 +8,0 @@ export { LineChart, LineChartProps, LineChartTooltipContent, LineChartTooltipContentProps, } from './LineChart';

types/components/Sparkline/components/index.d.ts

@@ -1,2 +0,1 @@
-export { LinearGradient } from './LinearGradient';
 export { Series } from './Series';

types/index.d.ts

@@ -1,1 +0,1 @@
-export { Sparkline, SparklineProps, NormalizedStackedBarChart, NormalizedStackedBarChartProps, BarChart, BarChartProps, BarChartTooltipContent, BarChartTooltipContentProps, LineChart, LineChartProps, LineChartTooltipContent, LineChartTooltipContentProps, StackedAreaChart, StackedAreaChartProps, Legend, MultiSeriesBarChart, MultiSeriesBarChartProps, TooltipContent, TooltipContentProps, LinePreview, SquareColorPreview, } from './components';
+export { Sparkline, SparklineProps, Sparkbar, SparkbarProps, NormalizedStackedBarChart, NormalizedStackedBarChartProps, BarChart, BarChartProps, BarChartTooltipContent, BarChartTooltipContentProps, LineChart, LineChartProps, LineChartTooltipContent, LineChartTooltipContentProps, StackedAreaChart, StackedAreaChartProps, Legend, MultiSeriesBarChart, MultiSeriesBarChartProps, TooltipContent, TooltipContentProps, LinePreview, SquareColorPreview, } from './components';

types/utilities/get-color-value.d.ts

 import { Color } from 'types';
+export declare function isValidColorToken(color: Color): boolean;
 export declare function getColorValue(color: Color): string;

types/utilities/index.d.ts

@@ -19,1 +19,2 @@ export { eventPoint } from './event-point';
 export { getPointAtLength } from './get-point-at-length';
+export { normalizeData } from './normalize-data';

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

688618

increased by13.08%

Number of package files

352

increased by6.34%

Lines of code

9553

increased by7.34%

No dependency changes