@nypl/design-system-react-components 3.3.1 → 3.4.0-rc

package/dist/src/components/CheckboxGroup/CheckboxGroup.d.ts

@@ -36,7 +36,7 @@ export interface CheckboxGroupProps {
     /** Offers the ability to show the group's legend onscreen or hide it. Refer
      * to the `labelText` property for more information. */
     showLabel?: boolean;
-    /** Whether or not to display the "(Required)" text in the label text.
+    /** Whether or not to display the "(required)" text in the label text.
      * True by default. */
     showRequiredLabel?: boolean;
     /** The values to programmatically update the selected `Checkbox`es. */

package/dist/src/components/DatePicker/DatePicker.d.ts

@@ -26,7 +26,7 @@ interface DatePickerWrapperProps extends DateRangeRowProps {
     labelText: string;
     /** Offers the ability to show the label onscreen or hide it. */
     showLabel?: boolean;
-    /** Whether or not to display the "(Required)" text in the label text.
+    /** Whether or not to display the "(required)" text in the label text.
      * True by default. */
     showRequiredLabel?: boolean;
 }

package/dist/src/components/Fieldset/Fieldset.d.ts

@@ -7,11 +7,11 @@ export interface FieldsetProps {
     id: string;
     /** Flag to show or hide the text in the `legend` element. False by default. */
     isLegendHidden?: boolean;
-    /** Flag to render "Required" in the `legend`. True by default. */
+    /** Flag to render "required" in the `legend`. True by default. */
     isRequired?: boolean;
     /** Text to display in the `legend` element. */
     legendText?: string;
-    /** Whether or not to display the "(Required)" text in the `legend` text.
+    /** Whether or not to display the "(required)" text in the `legend` text.
      * True by default. */
     showRequiredLabel?: boolean;
 }

package/dist/src/components/Image/Image.d.ts

@@ -4,9 +4,9 @@ import { DimensionTypes } from "../../helpers/types";
 export declare const imageRatiosArray: readonly ["fourByThree", "oneByTwo", "original", "sixteenByNine", "square", "threeByFour", "threeByTwo", "twoByOne"];
 export declare const imageSizesArray: readonly ["default", "xxxsmall", "xxsmall", "xsmall", "small", "medium", "large"];
 export declare const imageTypesArray: readonly ["default", "circle"];
-export type ImageRatios = (typeof imageRatiosArray)[number];
-export type ImageSizes = (typeof imageSizesArray)[number];
-export type ImageTypes = (typeof imageTypesArray)[number];
+export type ImageRatios = typeof imageRatiosArray[number];
+export type ImageSizes = typeof imageSizesArray[number];
+export type ImageTypes = typeof imageTypesArray[number];
 export interface ComponentImageProps extends Partial<HTMLImageElement> {
     /** String value used to populate the `alt` attribute of the internal `Image`
      * component's `img` element. @NOTE if an image is used, this value must be passed. */

package/dist/src/components/Label/Label.d.ts

@@ -10,10 +10,10 @@ export interface LabelProps {
     /** Controls whether the label should be inline with the input it goes with.
      * This prop should only be used internally. */
     isInlined?: boolean;
-    /** Controls whether the "(Required)" text should be displayed alongside the
+    /** Controls whether the "(required)" text should be displayed alongside the
      * label's text. False by default. */
     isRequired?: boolean;
-    /** Allows the '(Required)' text to be changed for language purposes
+    /** Allows the '(required)' text to be changed for language purposes
      * Note: Parenthesis will be added automatically by the component */
     requiredLabelText?: string;
 }

package/dist/src/components/RadioGroup/RadioGroup.d.ts

@@ -36,7 +36,7 @@ export interface RadioGroupProps {
     /** Offers the ability to show the group's legend onscreen or hide it. Refer
      * to the `labelText` property for more information. */
     showLabel?: boolean;
-    /** Whether or not to display the "(Required)" text in the label text.
+    /** Whether or not to display the "(required)" text in the label text.
      * True by default. */
     showRequiredLabel?: boolean;
 }

package/dist/src/components/Select/Select.d.ts

@@ -45,7 +45,7 @@ export interface SelectProps {
     /** Offers the ability to show the select's label onscreen or hide it. Refer
      * to the `labelText` property for more information. */
     showLabel?: boolean;
-    /** Whether or not to display the "(Required)" text in the label text.
+    /** Whether or not to display the "(required)" text in the label text.
      * True by default. */
     showRequiredLabel?: boolean;
     /** The value of the selected option.

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

@@ -45,7 +45,7 @@ export interface SliderProps {
     /** Offers the ability to show the label onscreen or hide it. Refer
      * to the `labelText` property for more information. */
     showLabel?: boolean;
-    /** Whether or not to display the "(Required)" text in the label text.
+    /** Whether or not to display the "(required)" text in the label text.
      * True by default. */
     showRequiredLabel?: boolean;
     /** Offers the ability to hide the static min/max values. */

package/dist/src/components/Table/Table.d.ts

@@ -1,5 +1,7 @@
 import { ChakraComponent } from "@chakra-ui/react";
 import React from "react";
+export declare const tableBodyTextSizesArray: readonly ["body1", "body2"];
+export type TableBodyTextSizes = typeof tableBodyTextSizesArray[number];
 export interface TableProps {
     /** Additional class name for the `Table` component. */
     className?: string;
@@ -10,11 +12,22 @@ export interface TableProps {
     columnHeadersBackgroundColor?: string;
     /** Hex value to set the text color of the column headers. */
     columnHeadersTextColor?: string;
+    /** Array of style objects used to set custom styles for the table columns.
+     * Any style can be passed, but the most common use would be to pass "width"
+     * and "maxWidth" to set custom column widths. */
+    columnStyles?: object[];
+    /** The size of the table body text. */
+    tableTextSize?: TableBodyTextSizes;
     /** ID that other components can cross reference for accessibility purposes. */
     id?: string;
+    /** If true, horizontal scrolling will be enabled for the table content.  */
+    isScrollable?: boolean;
     /** If true, a border will be displayed between each row in the `Table`
      * component. The default value is false. */
     showRowDividers?: boolean;
+    /** If true, the heading text will be rendered above the table. The default
+     * value is true. */
+    showTitleText?: boolean;
     /** Two-dimensional array used to populate the table rows. */
     tableData: (string | JSX.Element)[][];
     /** Displays `Table` title element. */

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

@@ -65,7 +65,7 @@ export interface InputProps extends React.InputHTMLAttributes<HTMLInputElement>
     pattern?: string;
     /** Populates the placeholder for the input/textarea elements */
     placeholder?: string;
-    /** Allows the '(Required)' text to be changed for language purposes
+    /** Allows the '(required)' text to be changed for language purposes
      * Note: Parenthesis will be added automatically by the component */
     requiredLabelText?: string;
     /** Offers the ability to hide the helper/invalid text. */
@@ -73,7 +73,7 @@ export interface InputProps extends React.InputHTMLAttributes<HTMLInputElement>
     /** Offers the ability to show the label onscreen or hide it. Refer to the
      * `labelText` property for more information. */
     showLabel?: boolean;
-    /** Whether or not to display the "(Required)" text in the label text.
+    /** Whether or not to display the "(required)" text in the label text.
      * True by default. */
     showRequiredLabel?: boolean;
     /** The amount to increase or decrease when using the number type. */

package/dist/src/index.d.ts

@@ -98,7 +98,7 @@ export type { StructuredContentImagePosition, StructuredContentProps, } from "./
 export { default as StyledList } from "./components/StyledList/StyledList";
 export type { StyledListProps, StyledListTextSizes, } from "./components/StyledList/StyledList";
 export { default as Table } from "./components/Table/Table";
-export type { TableProps } from "./components/Table/Table";
+export type { TableBodyTextSizes, TableProps } from "./components/Table/Table";
 export { default as Tabs, TabList, Tab, TabPanels, TabPanel, } from "./components/Tabs/Tabs";
 export type { TabsDataProps, TabsProps } from "./components/Tabs/Tabs";
 export { default as TagSet } from "./components/TagSet/TagSet";