@nypl/design-system-react-components 1.4.2 → 1.5.0-rc

package/CHANGELOG.md

@@ -8,6 +8,26 @@ Currently, this repo is in Prerelease. When it is released, this project will ad
 
 ## Prerelease
 
+### Adds
+
+- Adds `dark` color mode support for `background-color` and `color` global styles.
+- Adds `dark` color mode support for the `HelperErrorText` and `StatusBadge` components.
+- Adds `dark` color mode support for the `Button`, `Checkbox`, `DatePicker`, `ProgressIndicator`, `Radio`, `SearchBar`, `Select`, `Slider` and `Toggle` components.
+- Adds `dark` color mode support for the `Card` and `Hero` components.
+- Adds `dark` color mode support for the `Heading` and `List` components.
+- Adds `dark` color mode support for the `Footer`, `Header`, `HorizontalRule` and `Table` components.
+- Adds `dark` color mode support for the `Notification`, `ProgressIndicator`, and `SkeletonLoader` components.
+- Adds `dark` color mode support for the `Breadcrumbs`, `Link Types`, and `Pagination` components.
+- Adds `dark` color mode support for the `Accordion`, `Modal`, `Tabs`, and `Tooltip` components.
+- Adds `dark` color mode support for the `AlphabetFilter`, `AudioPlayer`, and `TagSet` components.
+- Adds `dark` color mode support for the `FeedbackBox` and `StyledList` components.
+- Adds `dark` color mode support for the `FilterBar` and `MultiSelect` components.
+- Adds `Supporting Dark Mode` under the `Development Guide`.
+
+### Updates
+
+- Updates the `Design Tokens Style Guide` to include more detailed information about the available tokens.
+
 ## 1.4.2 (March 2, 2023)
 
 ### Updates
@@ -151,6 +171,16 @@ This release is exactly the same as the `1.3.0-rc` release candidate published o
 
 ### Adds
 
+- Adds `brand` as a `breadcrumbsType` to the `Breadcrumbs` component.
+
+### Updates
+
+- Updates the hex value for `dark.ui.error.primary`.
+
+## 1.2.1 (October 27, 2022)
+
+### Adds
+
 - Adds the `"buttonPrimary"`, `"buttonSecondary"`, `"buttonPill"`, `"buttonCallout"`, `"buttonNoBrand"`, `"buttonDisabled"` variants for the the `Link` component, set through the `type` prop.
 
 ### Deprecates
@@ -227,6 +257,7 @@ This release is exactly the same as the `1.3.0-rc` release candidate published o
 ### Deprecates
 
 - Deprecates the `link` variant in the `Button` component.
+- Deprecates the `darkMode` prop in the `ProgressIndicator` component.
 
 ## 1.1.0 (August 30, 2022)
 
@@ -270,6 +301,7 @@ This release is exactly the same as the `1.1.0-rc5` release candidate which was
 - Updates the `onClick` event type for the `Pagination` links `onClick` function.
 - Updates the `Link` component's `onClick` event type.
 - Makes small, clarifying update to `Color Mode` story in Storybook.
+- Updates background color values available in Storybook.
 
 ### Fixes
 

package/dist/components/Breadcrumbs/Breadcrumbs.d.ts

@@ -1,5 +1,5 @@
 import React from "react";
-export declare type BreadcrumbsTypes = "blogs" | "booksAndMore" | "education" | "locations" | "research" | "whatsOn";
+export declare type BreadcrumbsTypes = "blogs" | "booksAndMore" | "brand" | "education" | "locations" | "research" | "whatsOn";
 export interface BreadcrumbsDataProps {
     url: string;
     text: string | React.ReactNode;

package/dist/components/Header/components/HeaderSearchButton.d.ts

@@ -3,8 +3,8 @@ export interface HeaderSearchButtonProps {
     isMobile?: boolean;
 }
 /**
- * This is the button that will render the search form when it is clicked
- * and keep focus trapped within the menu.
+ * This is the button that will render the search form when it is clicked and
+ * keep focus trapped within the menu.
  */
 declare const HeaderSearchButton: import("@chakra-ui/react").ChakraComponent<({ isMobile }: HeaderSearchButtonProps) => JSX.Element, {}>;
 export default HeaderSearchButton;

package/dist/components/Notification/Notification.d.ts

@@ -9,12 +9,17 @@ interface BaseProps {
     id?: string;
     /** Optional prop to control horizontal alignment of the `Notification` content */
     isCentered?: boolean;
+    /** Content to be rendered in a `NotificationHeading` component. */
+    notificationHeading?: string;
     /** Optional prop to control the coloring of the `Notification` text and the
      * visibility of an applicable icon. */
     notificationType?: NotificationTypes;
+    /** Prop to display the `Notification` icon. Defaults to `true`. */
+    showIcon?: boolean;
 }
+declare type NotificationHeadingProps = Omit<BasePropsWithoutAlignText, "notificationHeading" | "showIcon">;
+declare type NotificationContentProps = Omit<BaseProps, "icon">;
 declare type BasePropsWithoutAlignText = Omit<BaseProps, "alignText">;
-declare type BasePropsWithoutIsCentered = Omit<BaseProps, "isCentered">;
 export interface NotificationProps extends BasePropsWithoutAlignText {
     /** Label used to describe the `Notification`'s aside HTML element. */
     ariaLabel?: string;
@@ -29,19 +34,15 @@ export interface NotificationProps extends BasePropsWithoutAlignText {
     noMargin?: boolean;
     /** Content to be rendered in a `NotificationContent` component. */
     notificationContent: string | JSX.Element;
-    /** Content to be rendered in a `NotificationHeading` component. */
-    notificationHeading?: string;
-    /** Prop to display the `Notification` icon. Defaults to `true`. */
-    showIcon?: boolean;
 }
 /**
  * NotificationHeading child-component.
  */
-export declare const NotificationHeading: import("@chakra-ui/react").ChakraComponent<(props: React.PropsWithChildren<BasePropsWithoutAlignText>) => JSX.Element, {}>;
+export declare const NotificationHeading: import("@chakra-ui/react").ChakraComponent<(props: React.PropsWithChildren<NotificationHeadingProps>) => JSX.Element, {}>;
 /**
  * NotificationContent child-component.
  */
-export declare const NotificationContent: import("@chakra-ui/react").ChakraComponent<(props: React.PropsWithChildren<BasePropsWithoutIsCentered>) => JSX.Element, {}>;
+export declare const NotificationContent: import("@chakra-ui/react").ChakraComponent<(props: React.PropsWithChildren<NotificationContentProps>) => JSX.Element, {}>;
 /**
  * Component used to present users with three different levels of notifications:
  * standard, announcement, and warning.

package/dist/components/ProgressIndicator/ProgressIndicator.d.ts

@@ -2,7 +2,7 @@ import React from "react";
 export declare type ProgressIndicatorSizes = "default" | "small";
 export declare type ProgressIndicatorTypes = "circular" | "linear";
 export interface ProgressIndicatorProps {
-    /** Flag to render the component in a dark background. */
+    /** The darkMode prop is deprecated and should no longer be used. */
     darkMode?: boolean;
     /** ID that other components can cross reference for accessibility purposes. */
     id: string;