@nypl/design-system-react-components 1.0.0 → 1.0.3-beta

package/README.md

@@ -6,12 +6,10 @@
 
 The Reservoir Design System (DS) is NYPL’s open-source extensible React library for products and experiences with the accessibility as its foundation. It ships functional, stateless components with consistent NYPL styling. You can learn more about the project and its goals [on the project's wiki](https://github.com/NYPL/nypl-design-system/wiki).
 
-_Note: This library is still in beta. Until we release the stable `1.0.0` version, we are loosely using semantic versioning._
-
 Storybook documentation
 
 - [Production - deployed to Github Pages](https://nypl.github.io/nypl-design-system/reservoir/v1/?path=/story/welcome--page)
-- [Development - deployed to Tugboat QA](https://development-6y1v6na1ceqnmojvc5akrm5ewys3cshs.tugboat.qa/?path=/story/introduction--page)
+- [Development/QA - deployed to Vercel](https://nypl-design-system.vercel.app/?path=/story/welcome--page)
 
 | Table of Contents |                                                                                     |
 | ----------------- | ----------------------------------------------------------------------------------- |
@@ -230,11 +228,11 @@ As of July, 2021, the Github Pages production site gets deployed every two weeks
 
 **Development**
 
-The development Storybook documentation is deployed to [Tugboat QA](https://development-6y1v6na1ceqnmojvc5akrm5ewys3cshs.tugboat.qa/?path=/story/introduction--page). This development site has all the working updates that get merged to the `development` branch. This means that this site is constantly being updated as pull requests are being merged in. This site is used to see the lastest changes during a working sprint before a production release is made.
+The development Storybook documentation is deployed to [Vercel](https://nypl-design-system.vercel.app/?path=/story/welcome--page). This development site has all the working updates that get merged to the `development` branch. This means that this site is constantly being updated as pull requests are being merged in. This site is used to see the lastest changes during a working sprint before a production release is made.
 
 **Preview Sites**
 
-Preview Storybook documentation sites are deployed to Tugboat QA for every pull request. They follow a pattern such as `pr[number]-[hash].tugboat.qa` where `[number]` is the number of the pull request it is deploying. For example, for pull request #101, Tugboat will deploy a "preview" site to `pr101-wldudndlk24kas42.tugboat.qa`. Since these "preview" sites are brought up only for pull requests, this means that the URL varies and that those instances are eventually shut off. They are not meant to be used as long-term sites but rather for reviewing working changes within the team.
+Preview Storybook documentation sites are deployed to Vercel on every commit push to every branch in this repository. They follow a pattern such as `nypl-design-system-[hash]-nypl.vercel.app` where `[hash]` is a random hash created by Vercel. This means that the URL varies and that those instances are eventually shut off. They are not meant to be used as long-term sites but rather for reviewing working changes within the team.
 
 ### React Component Documentation
 

package/dist/components/Checkbox/Checkbox.d.ts

@@ -43,6 +43,5 @@ export interface CheckboxProps extends CheckboxIconProps {
     /** Populates the value of the input */
     value?: string;
 }
-export declare const onChangeDefault: () => void;
 export declare const Checkbox: import("@chakra-ui/react").ChakraComponent<React.ForwardRefExoticComponent<CheckboxProps & React.RefAttributes<HTMLInputElement>>, {}>;
 export default Checkbox;

package/dist/components/ComponentWrapper/ComponentWrapper.d.ts

@@ -3,12 +3,18 @@ import { HelperErrorTextType } from "../HelperErrorText/HelperErrorText";
 export interface ComponentWrapperProps {
     /** The UI elements that will be wrapped by this component */
     children: React.ReactNode;
+    /** A class name for the `div` parent element. */
+    className?: string;
     /** Optional string to set the text for the component's description */
     descriptionText?: string;
     /** Optional string to set the text for a `Heading` component */
     headingText?: string;
     /** Optional string to set the text for a `HelperErrorText` component */
     helperText?: HelperErrorTextType;
+    /** Styles that target the helper text. */
+    helperTextStyles?: {
+        [key: string]: any;
+    };
     /** ID that other components can cross reference for accessibility purposes */
     id?: string;
     /** Optional string to populate the `HelperErrorText` for the error state
@@ -16,6 +22,8 @@ export interface ComponentWrapperProps {
     invalidText?: HelperErrorTextType;
     /** Sets invalid text in the error state. */
     isInvalid?: boolean;
+    /** Offers the ability to hide the helper/invalid text. */
+    showHelperInvalidText?: boolean;
 }
 export declare const ComponentWrapper: import("@chakra-ui/react").ChakraComponent<(props: React.PropsWithChildren<ComponentWrapperProps>) => JSX.Element, {}>;
 export default ComponentWrapper;

package/dist/components/Heading/Heading.d.ts

@@ -12,6 +12,8 @@ export interface HeadingProps {
     /** Optional size used to override the default styles of the semantic HTM
      * `<h>` elements */
     size?: HeadingSizes;
+    /** Optional prop used to remove default spacing */
+    noSpace?: boolean;
     /** Inner text of the `<h*>` element */
     text?: string;
     /** Optional URL that header points to; when `url` prop is passed to

package/dist/components/Logo/Logo.d.ts

@@ -1,5 +1,5 @@
 import * as React from "react";
-export declare type LogoNames = "bplBlack" | "bplWhite" | "cleverColor" | "cleverWhite" | "firstbookColor" | "firstbookColorNegative" | "lpaBlack" | "lpaColor" | "lpaWhite" | "mlnBlack" | "mlnWhite" | "nyplFullBlack" | "nyplFullWhite" | "nyplLionBlack" | "nyplLionWhite" | "openebooksColor" | "openebooksNegative" | "openebooksWithTextColor" | "openebooksWithTextNegative" | "qplAltBlack" | "qplAltWhite" | "qplBlack" | "qplColor" | "qplWhite" | "reservoirIconColor" | "reservoirVerticalColor" | "schomburgBlack" | "schomburgCircleBlack" | "schomburgCircleColor" | "schomburgCircleWhite" | "schomburgColor" | "schomburgWhite" | "simplyeBlack" | "simplyeWhite" | "simplyeColor" | "snflBlack" | "snflWhite" | "treasuresColor" | "treasuresColorNegative";
+export declare type LogoNames = "appleAppStoreBlack" | "appleAppStoreWhite" | "bplBlack" | "bplWhite" | "cleverBadgeColor" | "cleverColor" | "cleverWhite" | "firstbookColor" | "firstbookColorNegative" | "googlePlayBlack" | "lpaBlack" | "lpaColor" | "lpaWhite" | "mlnBlack" | "mlnWhite" | "nyplFullBlack" | "nyplFullWhite" | "nyplLionBlack" | "nyplLionWhite" | "openebooksColor" | "openebooksNegative" | "openebooksWithTextColor" | "openebooksWithTextNegative" | "qplAltBlack" | "qplAltWhite" | "qplBlack" | "qplColor" | "qplWhite" | "reservoirIconColor" | "reservoirVerticalColor" | "schomburgBlack" | "schomburgCircleBlack" | "schomburgCircleColor" | "schomburgCircleWhite" | "schomburgColor" | "schomburgWhite" | "simplyeBlack" | "simplyeWhite" | "simplyeColor" | "snflBlack" | "snflWhite" | "treasuresColor" | "treasuresColorNegative";
 export declare type LogoSizes = "default" | "xxsmall" | "xsmall" | "small" | "medium" | "large";
 export interface LogoProps {
     /** Optional className that will be added to the parent element */

package/dist/components/Logo/LogoSvgs.d.ts

@@ -1,10 +1,14 @@
 declare const _default: {
+    appleAppStoreBlack: string;
+    appleAppStoreWhite: string;
     bplBlack: string;
     bplWhite: string;
+    cleverBadgeColor: string;
     cleverColor: string;
     cleverWhite: string;
     firstbookColor: string;
     firstbookColorNegative: string;
+    googlePlayBlack: string;
     lpaBlack: string;
     lpaColor: string;
     lpaWhite: string;

package/dist/components/Slider/Slider.d.ts

@@ -4,8 +4,7 @@ export interface SliderProps {
     /** Additional class name for the Slider component. */
     className?: string;
     /** The initial value for the single `Slider` or an array of two number
-     * values for the `isRangeSlider` case.
-     */
+     * values for the `isRangeSlider` case. */
     defaultValue?: number | number[];
     /** Optional string to populate the HelperErrorText for standard state */
     helperText?: HelperErrorTextType;

package/dist/components/TextInput/TextInput.d.ts

@@ -33,7 +33,8 @@ export interface InputProps {
     labelText: string;
     /** The max number for a `number` TextInput type. */
     max?: number;
-    /** The max length of the input field. */
+    /** The max length of the input field. This prop is for all input types
+     * except for the `number` type. */
     maxLength?: number;
     /** The min number for a `number` TextInput type. */
     min?: number;