victory-core 37.1.2 → 37.3.0

package/src/victory-theme/material.tsx

@@ -1,4 +1,4 @@
-import { VictoryThemeDefinition } from "./types";
+import { VictoryThemeDefinition, VictoryThemePalette } from "./types";
 
 // *
 // * Colors
@@ -9,7 +9,7 @@ const lime300 = "#DCE775";
 const lightGreen500 = "#8BC34A";
 const teal700 = "#00796B";
 const cyan900 = "#006064";
-const colors = [
+const colorScale = [
   deepOrange600,
   yellow200,
   lime300,
@@ -21,6 +21,39 @@ const blueGrey50 = "#ECEFF1";
 const blueGrey300 = "#90A4AE";
 const blueGrey700 = "#455A64";
 const grey900 = "#212121";
+
+const colors: VictoryThemePalette = {
+  blue: "#4F7DA1",
+  pink: "#E2A37F",
+  teal: teal700,
+  purple: "#DF948A",
+  green: lightGreen500,
+  orange: deepOrange600,
+  cyan: cyan900,
+  red: "#DF5A49",
+  yellow: yellow200,
+};
+
+const grayscale = [blueGrey50, blueGrey300, blueGrey700, grey900];
+const qualitative = [
+  "#334D5C",
+  "#45B29D",
+  "#EFC94C",
+  "#E27A3F",
+  "#DF5A49",
+  "#4F7DA1",
+  "#55DBC1",
+  "#EFDA97",
+  "#E2A37F",
+  "#DF948A",
+];
+const heatmap = ["#428517", "#77D200", "#D6D305", "#EC8E19", "#C92B05"];
+const warm = ["#940031", "#C43343", "#DC5429", "#FF821D", "#FFAF55"];
+const cool = ["#2746B9", "#0B69D4", "#2794DB", "#31BB76", "#60E83B"];
+const red = ["#FCAE91", "#FB6A4A", "#DE2D26", "#A50F15", "#750B0E"];
+const green = ["#354722", "#466631", "#649146", "#8AB25C", "#A9C97E"];
+const blue = ["#002C61", "#004B8F", "#006BC9", "#3795E5", "#65B4F4"];
+
 // *
 // * Typography
 // *
@@ -61,6 +94,17 @@ const strokeLinecap = "round";
 const strokeLinejoin = "round";
 
 export const material: VictoryThemeDefinition = {
+  palette: {
+    colors,
+    grayscale,
+    qualitative,
+    heatmap,
+    warm,
+    cool,
+    red,
+    green,
+    blue,
+  },
   area: Object.assign(
     {
       style: {
@@ -182,7 +226,7 @@ export const material: VictoryThemeDefinition = {
   ),
   group: Object.assign(
     {
-      colorScale: colors,
+      colorScale,
     },
     baseProps,
   ),
@@ -200,7 +244,7 @@ export const material: VictoryThemeDefinition = {
     baseProps,
   ),
   legend: {
-    colorScale: colors,
+    colorScale,
     gutter: 10,
     orientation: "vertical",
     titleOrientation: "top",
@@ -228,7 +272,7 @@ export const material: VictoryThemeDefinition = {
   ),
   pie: Object.assign(
     {
-      colorScale: colors,
+      colorScale,
       style: {
         data: {
           padding,
@@ -256,7 +300,7 @@ export const material: VictoryThemeDefinition = {
   ),
   stack: Object.assign(
     {
-      colorScale: colors,
+      colorScale,
     },
     baseProps,
   ),

package/src/victory-theme/types.ts

@@ -72,7 +72,33 @@ export interface VictoryAxisCommonProps {
 export type VerticalAnchorType = "start" | "middle" | "end";
 // #region Victory Theme
 // Note: Many SVG attributes are missed in CSSProperties interface
+type VictoryThemePaletteKeys =
+  | "blue"
+  | "pink"
+  | "teal"
+  | "purple"
+  | "green"
+  | "orange"
+  | "cyan"
+  | "red"
+  | "yellow";
+
+export type VictoryThemePalette = {
+  [key in VictoryThemePaletteKeys]?: string;
+};
+
 export interface VictoryThemeDefinition {
+  palette?: {
+    colors?: VictoryThemePalette;
+    grayscale?: string[];
+    qualitative?: string[];
+    heatmap?: string[];
+    warm?: string[];
+    cool?: string[];
+    red?: string[];
+    blue?: string[];
+    green?: string[];
+  };
   area?: {
     style?: {
       data?: VictoryStyleObject;

package/src/victory-util/style.ts

@@ -1,3 +1,8 @@
+import {
+  VictoryTheme,
+  VictoryThemeDefinition,
+} from "../victory-theme/victory-theme";
+
 /**
  * Given an object with CSS/SVG transform definitions, return the string value
  * for use with the `transform` CSS property or SVG attribute. Note that we
@@ -33,29 +38,39 @@ export const toTransformString = function (obj, ...more) {
  * of 5 hex string values in that color scale. If no 'name' parameter
  * is given, it will return the Victory default grayscale.
  * @param {String} name The name of the color scale to return (optional).
+ * @param {Object} theme The theme object to retrieve the color scale from (optional).
  * @returns {Array} An array of 5 hex string values composing a color scale.
  */
-export function getColorScale(name) {
-  const scales = {
-    grayscale: ["#cccccc", "#969696", "#636363", "#252525"],
-    qualitative: [
-      "#334D5C",
-      "#45B29D",
-      "#EFC94C",
-      "#E27A3F",
-      "#DF5A49",
-      "#4F7DA1",
-      "#55DBC1",
-      "#EFDA97",
-      "#E2A37F",
-      "#DF948A",
-    ],
-    heatmap: ["#428517", "#77D200", "#D6D305", "#EC8E19", "#C92B05"],
-    warm: ["#940031", "#C43343", "#DC5429", "#FF821D", "#FFAF55"],
-    cool: ["#2746B9", "#0B69D4", "#2794DB", "#31BB76", "#60E83B"],
-    red: ["#FCAE91", "#FB6A4A", "#DE2D26", "#A50F15", "#750B0E"],
-    blue: ["#002C61", "#004B8F", "#006BC9", "#3795E5", "#65B4F4"],
-    green: ["#354722", "#466631", "#649146", "#8AB25C", "#A9C97E"],
+export function getColorScale(
+  name?: string,
+  theme: VictoryThemeDefinition = VictoryTheme.material,
+) {
+  const {
+    palette: {
+      grayscale = ["#cccccc", "#969696", "#636363", "#252525"],
+      qualitative = [],
+      heatmap = [],
+      warm = [],
+      cool = [],
+      red = [],
+      blue = [],
+      green = [],
+    } = {},
+  } = theme;
+
+  const scales: Record<string, string[]> = {
+    grayscale,
+    qualitative,
+    heatmap,
+    warm,
+    cool,
+    red,
+    blue,
+    green,
   };
-  return name ? scales[name] : scales.grayscale;
+
+  const selectedScale =
+    name && scales[name]?.length ? scales[name] : scales.grayscale;
+
+  return selectedScale;
 }

package/src/victory-util/wrapper.tsx

@@ -298,7 +298,8 @@ export function getAllEvents(props) {
   return events || [];
 }
 
-export function getColor(calculatedProps, child, index) {
+// eslint-disable-next-line max-params
+export function getColor(calculatedProps, child, index, theme) {
   // check for styles first
   const { style } = calculatedProps;
   let { colorScale, color } = calculatedProps;
@@ -313,7 +314,7 @@ export function getColor(calculatedProps, child, index) {
   }
   const colors = Array.isArray(colorScale)
     ? colorScale
-    : Style.getColorScale(colorScale);
+    : Style.getColorScale(colorScale, theme);
   return color || colors[index % colors.length];
 }
 
@@ -323,7 +324,8 @@ export function getStyle(theme, style, role) {
   return Helpers.getStyles(style, defaultStyle);
 }
 
-export function getChildStyle(child, index, calculatedProps) {
+// eslint-disable-next-line max-params
+export function getChildStyle(child, index, calculatedProps, theme) {
   const { style, role } = calculatedProps;
   const childStyle = child.props.style || {};
   if (Array.isArray(childStyle)) {
@@ -331,7 +333,9 @@ export function getChildStyle(child, index, calculatedProps) {
   }
   const childRole = child.type && child.type.role;
   const defaultFill =
-    childRole === "stack" ? undefined : getColor(calculatedProps, child, index);
+    childRole === "stack"
+      ? undefined
+      : getColor(calculatedProps, child, index, theme);
   const defaultColor =
     childRole === "line"
       ? { fill: "none", stroke: defaultFill }
@@ -352,19 +356,13 @@ export function getChildStyle(child, index, calculatedProps) {
   };
 }
 
-export function getStringsFromCategories(childComponents, axis) {
+export function getStringsFromChildrenCategories(childComponents, axis) {
   const iteratee = (child) => {
-    const childProps = child.props || {};
-    if (!Domain.isDomainComponent(child) || !childProps.categories) {
+    if (!Domain.isDomainComponent(child)) {
       return null;
     }
-    const categories =
-      childProps.categories && !Array.isArray(childProps.categories)
-        ? childProps.categories[axis]
-        : childProps.props.categories;
-    const categoryStrings =
-      categories && categories.filter((val) => typeof val === "string");
-    return categoryStrings ? Collection.removeUndefined(categoryStrings) : [];
+    const childProps = child.props || {};
+    return Data.getStringsFromCategories(childProps, axis);
   };
   return Helpers.reduceChildren(childComponents.slice(0), iteratee);
 }
@@ -413,15 +411,14 @@ export function getCategoryAndAxisStringsFromChildren(
   axis,
   childComponents,
 ) {
-  const categories = isPlainObject(props.categories)
-    ? props.categories[axis]
-    : props.categories;
+  const categories = Data.getStringsFromCategories(props, axis);
   const axisComponent = Axis.getAxisComponent(childComponents, axis);
   const axisStrings = axisComponent
     ? Data.getStringsFromAxes(axisComponent.props, axis)
     : [];
-  const categoryStrings =
-    categories || getStringsFromCategories(childComponents, axis);
+  const categoryStrings = categories.length
+    ? categories
+    : getStringsFromChildrenCategories(childComponents, axis);
   return uniq([...categoryStrings, ...axisStrings].flat());
 }
 
@@ -441,15 +438,9 @@ export function getStringsFromChildren(props, childComponents) {
 
 export function getCategories(props, childComponents, allStrings?) {
   const xPropCategories =
-    props.categories && !Array.isArray(props.categories)
-      ? props.categories.x
-      : props.categories;
-
+    props.categories && Data.getStringsFromCategories(props, "x");
   const yPropCategories =
-    props.categories && !Array.isArray(props.categories)
-      ? props.categories.y
-      : props.categories;
-
+    props.categories && Data.getStringsFromCategories(props, "y");
   const fallbackRequired = !xPropCategories || !yPropCategories;
 
   const fallbackProps = fallbackRequired