chore(stream): respond to pr feedback

plouc · Jun 3, 2021 · 54dc1c2 · 54dc1c2
1 parent 780954a
commit 54dc1c2
Show file tree

Hide file tree

Showing 2 changed files with 29 additions and 5 deletions.
diff --git a/packages/stream/index.d.ts b/packages/stream/index.d.ts
@@ -45,6 +45,30 @@ declare module '@nivo/stream' {
         y2: number
     }
 
+    interface DotDatum extends StreamLayerDatum {
+        id: string
+        color: string
+    }
+
+    export interface DatumId {
+        id: string
+    }
+
+    export interface StreamLayerDatum {
+        index: number
+        x: number
+        value: number
+        y1: number
+        y2: number
+    }
+
+    export interface ComputedDatum {
+        id: number
+        layer: StreamLayerDatum[]
+        path: string
+        color: string
+    }
+
     export type DatumToNumber = (datum: Datum) => number
 
     interface OptionalStreamProps<T> extends SvgDefsAndFill<T>, MotionProps {
@@ -56,7 +80,7 @@ declare module '@nivo/stream' {
         offsetType: StackOffset
         curve: AreaCurve
 
-        legendLabel: PropertyAccessor<T, string>
+        legendLabel: PropertyAccessor<DatumId, string>
 
         margin: Box
 
@@ -71,15 +95,15 @@ declare module '@nivo/stream' {
         fillOpacity: number
 
         borderWidth: number
-        borderColor: InheritedColorConfig<T>
+        borderColor: InheritedColorConfig<ComputedDatum>
 
         enableDots: boolean
         renderDot: StreamDotsItem
         dotPosition: 'start' | 'center' | 'end'
         dotSize: DatumToNumber | number
-        dotColor: InheritedColorConfig<T>
+        dotColor: InheritedColorConfig<DotDatum>
         dotBorderWidth: DatumToNumber | number
-        dotBorderColor: InheritedColorConfig<T>
+        dotBorderColor: InheritedColorConfig<DotDatum>
 
         isInteractive: boolean
         tooltipLabel: TooltipLabel<T>

diff --git a/website/src/data/components/stream/props.js b/website/src/data/components/stream/props.js
@@ -240,7 +240,7 @@ const props = [
             Define how to access the legend label of each datum,
             by default, nivo will look for the \`id\` property.
         `,
-        type: 'string | (datum: RawDatum): string',
+        type: 'string | (datum: { id: string }): string',
         required: false,
         defaultValue: defaults.legendLabel,
         group: 'Customization',