@nypl/design-system-react-components 3.5.5-rc4 → 3.5.5

package/dist/src/components/StyleGuide/ColorCard.d.ts

@@ -5,45 +5,37 @@ export declare const colorContrastData: {
         primary: {
             dataBlackColor: string[];
             dataWhiteColor: string[];
-            textColor: string;
         };
         secondary: {
             dataBlackColor: string[];
             dataWhiteColor: string[];
-            textColor: string;
         };
     };
     ui: {
         black: {
             dataBlackColor: string[];
             dataWhiteColor: string[];
-            textColor: string;
         };
         gray: {
             xxxxDark: {
                 dataBlackColor: any[];
                 dataWhiteColor: any[];
-                textColor: string;
             };
             xxxDark: {
                 dataBlackColor: any[];
                 dataWhiteColor: any[];
-                textColor: string;
             };
             xxDark: {
                 dataBlackColor: any[];
                 dataWhiteColor: any[];
-                textColor: string;
             };
             xDark: {
                 dataBlackColor: any[];
                 dataWhiteColor: any[];
-                textColor: string;
             };
             dark: {
                 dataBlackColor: any[];
                 dataWhiteColor: any[];
-                textColor: string;
             };
             semiDark: {
                 dataBlackColor: any[];
@@ -107,12 +99,11 @@ export declare const colorContrastData: {
         };
     };
 };
-export declare const cssVars: {
+export declare const colorCardsData: {
     brand: {
         name: string;
         dataBlackColor: string[];
         dataWhiteColor: string[];
-        textColor: string;
     }[];
     blogs: {
         colorSource: string;
@@ -126,58 +117,49 @@ export declare const cssVars: {
         name: string;
         dataBlackColor: string[];
         dataWhiteColor: string[];
-        textColor: string;
     }[];
     connect: {
         name: string;
         dataBlackColor: any[];
         dataWhiteColor: any[];
-        textColor: string;
     }[];
     education: {
         name: string;
         dataBlackColor: string[];
         dataWhiteColor: string[];
-        textColor: string;
     }[];
     locations: {
         colorSource: string;
         name: string;
         dataBlackColor: string[];
         dataWhiteColor: string[];
-        textColor: string;
     }[];
     research: {
         name: string;
         dataBlackColor: string[];
         dataWhiteColor: string[];
-        textColor: string;
     }[];
     researchLibraries: ({
         name: string;
         dataBlackColor: string[];
         dataWhiteColor: string[];
-        textColor: string;
         colorSource?: undefined;
     } | {
         colorSource: string;
         name: string;
         dataBlackColor: string[];
         dataWhiteColor: string[];
-        textColor: string;
     })[];
     whatsOn: ({
         name: string;
         dataBlackColor: string[];
         dataWhiteColor: string[];
-        textColor: string;
         colorSource?: undefined;
     } | {
         colorSource: string;
         name: string;
         dataBlackColor: string[];
         dataWhiteColor: string[];
-        textColor: string;
     })[];
     ui: ({
         colorSource: string;
@@ -201,6 +183,28 @@ export declare const cssVars: {
         dataBrandPrimaryColor?: undefined;
         dataBrandSecondaryColor?: undefined;
         notes?: undefined;
+    } | {
+        colorSource: string;
+        name: string;
+        dataBlackColor: any[];
+        dataWhiteColor: any[];
+        dataBgPageColor: string[];
+        dataBgDefaultColor: string[];
+        textColor?: undefined;
+        dataBrandPrimaryColor?: undefined;
+        dataBrandSecondaryColor?: undefined;
+        notes?: undefined;
+    } | {
+        name: string;
+        dataBlackColor: any[];
+        dataWhiteColor: any[];
+        dataBgPageColor: any[];
+        dataBgDefaultColor: any[];
+        colorSource?: undefined;
+        textColor?: undefined;
+        dataBrandPrimaryColor?: undefined;
+        dataBrandSecondaryColor?: undefined;
+        notes?: undefined;
     } | {
         name: string;
         dataBlackColor: any[];
@@ -212,6 +216,17 @@ export declare const cssVars: {
         dataBrandPrimaryColor?: undefined;
         dataBrandSecondaryColor?: undefined;
         notes?: undefined;
+    } | {
+        colorSource: string;
+        name: string;
+        dataBlackColor: string[];
+        dataWhiteColor: string[];
+        dataBrandPrimaryColor: any[];
+        dataBrandSecondaryColor: any[];
+        dataBgPageColor: string[];
+        dataBgDefaultColor: any[];
+        textColor?: undefined;
+        notes?: undefined;
     } | {
         colorSource: string;
         name: string;
@@ -235,24 +250,47 @@ export declare const cssVars: {
         dataBrandPrimaryColor?: undefined;
         dataBrandSecondaryColor?: undefined;
     })[];
-    grayscaleRoot: {
+    grayscaleRoot: ({
+        name: string;
+        dataBlackColor: string[];
+        dataWhiteColor: string[];
+        textColor?: undefined;
+    } | {
         name: string;
         dataBlackColor: string[];
         dataWhiteColor: string[];
         textColor: string;
-    }[];
-    grayscaleCool: {
+    })[];
+    grayscaleCool: ({
+        name: string;
+        dataBlackColor: any[];
+        dataWhiteColor: any[];
+        textColor?: undefined;
+    } | {
         name: string;
         dataBlackColor: any[];
         dataWhiteColor: any[];
         textColor: string;
-    }[];
+    })[];
     grayscaleWarm: {
         name: string;
         dataBlackColor: string[];
         dataWhiteColor: string[];
         textColor: string;
     }[];
+    highlighter: ({
+        name: string;
+        showColorDataTable: boolean;
+        textColor: string;
+        dataBlackColor?: undefined;
+        dataWhiteColor?: undefined;
+    } | {
+        name: string;
+        dataBlackColor: string[];
+        dataWhiteColor: string[];
+        showColorDataTable: boolean;
+        textColor: string;
+    })[];
     dark: ({
         colorSource: string;
         name: string;
@@ -260,9 +298,9 @@ export declare const cssVars: {
         dataWhiteColor: any[];
         dataHeadingColor: string[];
         dataBodyColor: string[];
-        textColor: string;
         dataDarkBgPageColor?: undefined;
         dataDarkBgDefaultColor?: undefined;
+        textColor?: undefined;
         dataBrandPrimaryColor?: undefined;
         dataBrandSecondaryColor?: undefined;
     } | {
@@ -277,6 +315,18 @@ export declare const cssVars: {
         dataBodyColor?: undefined;
         dataBrandPrimaryColor?: undefined;
         dataBrandSecondaryColor?: undefined;
+    } | {
+        colorSource: string;
+        name: string;
+        dataBlackColor: any[];
+        dataWhiteColor: any[];
+        dataDarkBgPageColor: any[];
+        dataDarkBgDefaultColor: any[];
+        dataHeadingColor?: undefined;
+        dataBodyColor?: undefined;
+        textColor?: undefined;
+        dataBrandPrimaryColor?: undefined;
+        dataBrandSecondaryColor?: undefined;
     } | {
         name: string;
         dataBlackColor: any[];
@@ -289,6 +339,18 @@ export declare const cssVars: {
         dataBodyColor?: undefined;
         dataBrandPrimaryColor?: undefined;
         dataBrandSecondaryColor?: undefined;
+    } | {
+        name: string;
+        dataBlackColor: string[];
+        dataWhiteColor: string[];
+        dataDarkBgPageColor: string[];
+        dataDarkBgDefaultColor: string[];
+        colorSource?: undefined;
+        dataHeadingColor?: undefined;
+        dataBodyColor?: undefined;
+        textColor?: undefined;
+        dataBrandPrimaryColor?: undefined;
+        dataBrandSecondaryColor?: undefined;
     } | {
         name: string;
         dataDarkBgPageColor: string[];
@@ -297,8 +359,8 @@ export declare const cssVars: {
         dataWhiteColor: string[];
         dataHeadingColor: string[];
         dataBodyColor: string[];
-        textColor: string;
         colorSource?: undefined;
+        textColor?: undefined;
         dataBrandPrimaryColor?: undefined;
         dataBrandSecondaryColor?: undefined;
     } | {
@@ -313,10 +375,26 @@ export declare const cssVars: {
         textColor: string;
         dataHeadingColor?: undefined;
         dataBodyColor?: undefined;
+    } | {
+        colorSource: string;
+        name: string;
+        dataBlackColor: any[];
+        dataWhiteColor: any[];
+        dataBrandPrimaryColor: any[];
+        dataBrandSecondaryColor: any[];
+        dataDarkBgPageColor: any[];
+        dataDarkBgDefaultColor: any[];
+        dataHeadingColor?: undefined;
+        dataBodyColor?: undefined;
+        textColor?: undefined;
     })[];
+    darkHighlighter: {
+        name: string;
+        showColorDataTable: boolean;
+    }[];
 };
 export declare const makeColorCard: (data: any) => import("react/jsx-runtime").JSX.Element;
-export declare const getColorCards: (category: any) => any[];
+export declare const getColorCards: (category: string) => any;
 export interface DataTableProps {
     /** Contrast and WCAG compliance data related to the color ui.bg.page when
      * used with the current color. */
@@ -358,9 +436,29 @@ export interface ColorCardProps extends DataTableProps {
     colorName: string;
     /** The name of the color that the current color is based on. */
     colorSource: string;
+    /** Show or hide the data table */
+    showColorDataTable: boolean;
     /** Details on how a color should be used. */
     notes?: string;
 }
+export declare const colorNamesArray: readonly ["nyplRed", "fluorescentPink", "vividBurgundy", "carrotOrange", "flavescent", "treeGreen", "scienceBlue", "blueberry", "irisPurple"];
+export type ColorNames = typeof colorNamesArray[number];
+export interface ColorBoxProps {
+    /** The backgroundColor of the color card. */
+    backgroundColor: string;
+    /** The name of a color's javascript theme object. */
+    colorName: ColorNames;
+    /** The name of a color's javascript theme object. */
+    colorOption: string;
+    /** The color to use for text in the color card. */
+    textColor?: IconColors;
+}
+export interface ColorScaleProps {
+    /** The name of a color's javascript theme object. */
+    colorName: ColorNames;
+}
 export declare const DataTable: (props: PropsWithChildren<DataTableProps>) => import("react/jsx-runtime").JSX.Element;
+export declare const ColorBox: (props: ColorBoxProps) => import("react/jsx-runtime").JSX.Element;
+export declare const ColorScale: (props: ColorScaleProps) => import("react/jsx-runtime").JSX.Element;
 export declare const ColorCard: (props: PropsWithChildren<ColorCardProps>) => import("react/jsx-runtime").JSX.Element;
 export default ColorCard;

package/dist/src/theme/foundations/colors.d.ts

@@ -1,3 +1,159 @@
 import { Colors } from "@chakra-ui/react";
+/**
+ * All colors can be found in Storybook:
+ *   https://nypl.github.io/nypl-design-system/reservoir/v3/?path=/docs/style-guide-colors--docs
+ *
+ * All UI Fills colors can be found in Figma:
+ *   https://www.figma.com/file/qShodlfNCJHb8n03IFyApM/Main?node-id=47083%3A27674
+ *
+ * All Brand Fills colors can be found in Figma:
+ *   https://www.figma.com/file/qShodlfNCJHb8n03IFyApM/Main?node-id=15454%3A47007
+ *
+ * All Dark Mode UI Fills colors can be found in Figma:
+ *   https://www.figma.com/file/qShodlfNCJHb8n03IFyApM/Main?node-id=61991%3A45315
+ *
+ * At the end of this file, there are objects that extend Chakra's default
+ * color shade palette for individual colors. WE DO NOT RECOMMEND to use them
+ * and only recommend to use the colors defined by the Design System such as the
+ * following "ui", "brand", and "section" colors below.
+ */
+/** Reusable variables: */
+export declare const primitives: {
+    nyplRed: {
+        DEFAULT: string;
+        "25": string;
+        "50": string;
+        "100": string;
+        "200": string;
+        "300": string;
+        "400": string;
+        "500": string;
+        "600": string;
+        "700": string;
+        "800": string;
+        "900": string;
+        "950": string;
+    };
+    fluorescentPink: {
+        DEFAULT: string;
+        "25": string;
+        "50": string;
+        "100": string;
+        "200": string;
+        "300": string;
+        "400": string;
+        "500": string;
+        "600": string;
+        "700": string;
+        "800": string;
+        "900": string;
+        "950": string;
+    };
+    vividBurgundy: {
+        DEFAULT: string;
+        "25": string;
+        "50": string;
+        "100": string;
+        "200": string;
+        "300": string;
+        "400": string;
+        "500": string;
+        "600": string;
+        "700": string;
+        "800": string;
+        "900": string;
+        "950": string;
+    };
+    carrotOrange: {
+        DEFAULT: string;
+        "25": string;
+        "50": string;
+        "100": string;
+        "200": string;
+        "300": string;
+        "400": string;
+        "500": string;
+        "600": string;
+        "700": string;
+        "800": string;
+        "900": string;
+        "950": string;
+    };
+    flavescent: {
+        DEFAULT: string;
+        "25": string;
+        "50": string;
+        "100": string;
+        "200": string;
+        "300": string;
+        "400": string;
+        "500": string;
+        "600": string;
+        "700": string;
+        "800": string;
+        "900": string;
+        "950": string;
+    };
+    treeGreen: {
+        DEFAULT: string;
+        "25": string;
+        "50": string;
+        "100": string;
+        "200": string;
+        "300": string;
+        "400": string;
+        "500": string;
+        "600": string;
+        "700": string;
+        "800": string;
+        "900": string;
+        "950": string;
+    };
+    scienceBlue: {
+        DEFAULT: string;
+        "25": string;
+        "50": string;
+        "100": string;
+        "200": string;
+        "300": string;
+        "400": string;
+        "500": string;
+        "600": string;
+        "700": string;
+        "800": string;
+        "900": string;
+        "950": string;
+    };
+    blueberry: {
+        DEFAULT: string;
+        "25": string;
+        "50": string;
+        "100": string;
+        "200": string;
+        "300": string;
+        "400": string;
+        "500": string;
+        "600": string;
+        "700": string;
+        "800": string;
+        "900": string;
+        "950": string;
+    };
+    irisPurple: {
+        DEFAULT: string;
+        "25": string;
+        "50": string;
+        "100": string;
+        "200": string;
+        "300": string;
+        "400": string;
+        "500": string;
+        "600": string;
+        "700": string;
+        "800": string;
+        "900": string;
+        "950": string;
+    };
+};
 declare const colors: Colors;
 export default colors;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nypl/design-system-react-components",
-  "version": "3.5.5-rc4",
+  "version": "3.5.5",
   "description": "NYPL Reservoir Design System React Components",
   "repository": {
     "type": "git",