@nypl/design-system-react-components 0.25.8 → 0.25.9

package/src/components/ProgressIndicator/ProgressIndicator.stories.mdx

@@ -1,22 +1,32 @@
+import { Box } from "@chakra-ui/react";
 import {
-  Meta,
-  Story,
   ArgsTable,
   Canvas,
   Description,
-} from "@storybook/addon-docs/blocks";
+  Meta,
+  Story,
+} from "@storybook/addon-docs";
 import { withDesign } from "storybook-addon-designs";
-import { Box } from "@chakra-ui/react";
 
+import { GridGaps } from "../Grid/GridTypes";
 import ProgressIndicator from "./ProgressIndicator";
 import {
   ProgressIndicatorSizes,
   ProgressIndicatorTypes,
 } from "./ProgressIndicatorTypes";
+import SimpleGrid from "../Grid/SimpleGrid";
 import { getCategory } from "../../utils/componentCategories";
 import DSProvider from "../../theme/provider";
-import SimpleGrid from "../Grid/SimpleGrid";
-import { GridGaps } from "../Grid/GridTypes";
+import { getStorybookEnumValues } from "../../utils/utils";
+
+export const sizesEnumValues = getStorybookEnumValues(
+  ProgressIndicatorSizes,
+  "ProgressIndicatorSizes"
+);
+export const typesEnumValues = getStorybookEnumValues(
+  ProgressIndicatorTypes,
+  "ProgressIndicatorTypes"
+);
 
 <Meta
   title={getCategory("ProgressIndicator")}
@@ -30,7 +40,29 @@ import { GridGaps } from "../Grid/GridTypes";
     jest: ["ProgressIndicator.test.tsx"],
   }}
   argTypes={{
-    id: { table: { disable: true } },
+    darkMode: {
+      table: { defaultValue: { summary: false } },
+    },
+    id: { control: false },
+    indicatorType: {
+      control: { type: "radio" },
+      table: { defaultValue: { summary: "ProgressIndicatorTypes.Linear" } },
+      options: typesEnumValues.options,
+    },
+    isIndeterminate: {
+      table: { defaultValue: { summary: false } },
+    },
+    showLabel: {
+      table: { defaultValue: { summary: true } },
+    },
+    size: {
+      control: { type: "radio" },
+      table: { defaultValue: { summary: "ProgressIndicatorSizes.Default" } },
+      options: sizesEnumValues.options,
+    },
+    value: {
+      table: { defaultValue: { summary: 0 } },
+    },
   }}
 />
 
@@ -45,22 +77,29 @@ import { GridGaps } from "../Grid/GridTypes";
 
 <Canvas withToolbar>
   <Story
-    name="Basic with props"
+    name="ProgressIndicator with Controls"
     args={{
       darkMode: false,
-      indicatorType: ProgressIndicatorTypes.Linear,
+      id: "progressIndicator-id",
+      indicatorType: "ProgressIndicatorTypes.Linear",
       isIndeterminate: false,
       labelText: "Progress",
       showLabel: true,
-      size: ProgressIndicatorSizes.Default,
+      size: "ProgressIndicatorSizes.Default",
       value: 50,
     }}
   >
-    {(args) => <ProgressIndicator {...args} />}
+    {(args) => (
+      <ProgressIndicator
+        {...args}
+        indicatorType={typesEnumValues.getValue(args.indicatorType)}
+        size={sizesEnumValues.getValue(args.size)}
+      />
+    )}
   </Story>
 </Canvas>
 
-<ArgsTable story="Basic with props" />
+<ArgsTable story="ProgressIndicator with Controls" />
 
 ## Linear Type
 
@@ -70,20 +109,15 @@ dialogs, etc.
 <Canvas>
   <Story
     name="Linear Type"
-    args={{
-      darkMode: false,
-      indicatorType: ProgressIndicatorTypes.Linear,
-      isIndeterminate: false,
-      labelText: "Linear Progress Type",
-      showLabel: true,
-      size: ProgressIndicatorSizes.Default,
-      value: 50,
-    }}
     argTypes={{
       indicatorType: { table: { disable: true } },
     }}
   >
-    {(args) => <ProgressIndicator {...args} />}
+    <ProgressIndicator
+      indicatorType={ProgressIndicatorTypes.Linear}
+      labelText="Linear Progress Type"
+      value={50}
+    />
   </Story>
 </Canvas>
 
@@ -96,20 +130,15 @@ full-screen loading. Set the `indicatorType` prop to
 <Canvas>
   <Story
     name="Circular Type"
-    args={{
-      darkMode: false,
-      indicatorType: ProgressIndicatorTypes.Circular,
-      isIndeterminate: false,
-      labelText: "Circular Progress Type",
-      showLabel: true,
-      size: ProgressIndicatorSizes.Default,
-      value: 50,
-    }}
     argTypes={{
       indicatorType: { table: { disable: true } },
     }}
   >
-    {(args) => <ProgressIndicator {...args} />}
+    <ProgressIndicator
+      indicatorType={ProgressIndicatorTypes.Circular}
+      labelText="Linear Progress Type"
+      value={50}
+    />
   </Story>
 </Canvas>
 
@@ -145,13 +174,13 @@ percentage will not displayed.
   <DSProvider>
     <SimpleGrid columns={1} gap={GridGaps.Medium}>
       <ProgressIndicator
-        labelText="Default 48px size"
         indicatorType={ProgressIndicatorTypes.Circular}
+        labelText="Default 48px size"
         value={50}
       />
       <ProgressIndicator
-        labelText="Small 24px size"
         indicatorType={ProgressIndicatorTypes.Circular}
+        labelText="Small 24px size"
         size={ProgressIndicatorSizes.Small}
         value={50}
       />
@@ -174,14 +203,14 @@ the progress element to provide a description of the progress for screen readers
     <SimpleGrid columns={1} gap={GridGaps.Medium}>
       <ProgressIndicator
         labelText="This label will be added through aria-label"
-        value={50}
         showLabel={false}
+        value={50}
       />
       <ProgressIndicator
-        labelText="This label will be added through aria-label"
         indicatorType={ProgressIndicatorTypes.Circular}
-        value={50}
+        labelText="This label will be added through aria-label"
         showLabel={false}
+        value={50}
       />
     </SimpleGrid>
   </DSProvider>
@@ -197,14 +226,14 @@ exact value or progress of the task is unknown.
   <DSProvider>
     <SimpleGrid columns={1} gap={GridGaps.Medium}>
       <ProgressIndicator
-        labelText="Indeterminate state"
         isIndeterminate
+        labelText="Indeterminate state"
         value={50}
       />
       <ProgressIndicator
-        labelText="Indeterminate state"
         indicatorType={ProgressIndicatorTypes.Circular}
         isIndeterminate
+        labelText="Indeterminate state"
         value={50}
       />
     </SimpleGrid>
@@ -224,10 +253,10 @@ Note: the background is manually set to better showcase the `darkMode` prop.
       <SimpleGrid columns={1} gap={GridGaps.Medium}>
         <ProgressIndicator labelText="Dark Mode" value={50} darkMode />
         <ProgressIndicator
-          labelText="Dark Mode"
+          darkMode
           indicatorType={ProgressIndicatorTypes.Circular}
+          labelText="Dark Mode"
           value={50}
-          darkMode
         />
       </SimpleGrid>
     </Box>
@@ -255,8 +284,8 @@ function ProgressIndicatorExample() {
     <SimpleGrid columns={1} gap={GridGaps.Medium}>
       <ProgressIndicator labelText="Progress example" value={value} />
       <ProgressIndicator
-        labelText="Progress example"
         indicatorType={ProgressIndicatorTypes.Circular}
+        labelText="Progress example"
         value={value}
       />
     </SimpleGrid>
@@ -276,8 +305,8 @@ export function ProgressIndicatorExample() {
     <SimpleGrid columns={1} gap={GridGaps.Medium}>
       <ProgressIndicator labelText="Progress example" value={value} />
       <ProgressIndicator
-        labelText="Progress example"
         indicatorType={ProgressIndicatorTypes.Circular}
+        labelText="Progress example"
         value={value}
       />
     </SimpleGrid>

package/src/components/Radio/Radio.stories.mdx

@@ -1,16 +1,16 @@
+import { HStack } from "@chakra-ui/react";
 import {
-  Meta,
-  Story,
-  Canvas,
   ArgsTable,
+  Canvas,
   Description,
+  Meta,
+  Story,
 } from "@storybook/addon-docs";
 import { withDesign } from "storybook-addon-designs";
-import { HStack } from "@chakra-ui/react";
 
+import Radio from "./Radio";
 import { getCategory } from "../../utils/componentCategories";
 import DSProvider from "../../theme/provider";
-import Radio from "./Radio";
 
 <Meta
   title={getCategory("Radio")}
@@ -19,16 +19,32 @@ import Radio from "./Radio";
   parameters={{
     design: {
       type: "figma",
-      url:
-        "https://www.figma.com/file/qShodlfNCJHb8n03IFyApM/Master?node-id=11895%3A742",
+      url: "https://www.figma.com/file/qShodlfNCJHb8n03IFyApM/Master?node-id=11895%3A742",
     },
     jest: ["Radio.test.tsx"],
   }}
   argTypes={{
-    className: { table: { disable: true } },
-    id: { table: { disable: true } },
-    isChecked: { table: { disable: true } },
-    onChange: { table: { disable: true } },
+    className: { control: false },
+    id: { control: false },
+    isChecked: { control: false },
+    isDisabled: {
+      table: { defaultValue: { summary: false } },
+    },
+    isInvalid: {
+      table: { defaultValue: { summary: false } },
+    },
+    isRequired: {
+      table: { defaultValue: { summary: false } },
+    },
+    key: { table: { disable: true } },
+    onChange: { control: false },
+    ref: { table: { disable: true } },
+    showHelperInvalidText: {
+      table: { defaultValue: { summary: true } },
+    },
+    showLabel: {
+      table: { defaultValue: { summary: true } },
+    },
   }}
 />
 
@@ -37,7 +53,7 @@ import Radio from "./Radio";
 | Component Version | DS Version |
 | ----------------- | ---------- |
 | Added             | `0.22.0`   |
-| Latest            | `0.25.0`   |
+| Latest            | `0.25.9`   |
 
 <Description of={Radio} />
 
@@ -50,16 +66,20 @@ component will handle all the states and data management.
   <Story
     name="Radio"
     args={{
+      className: undefined,
+      helperText: "This is the helper text!",
+      id: "radio-id",
+      invalidText: "This is the error text :(",
+      isChecked: undefined,
+      isDisabled: false,
+      isInvalid: false,
+      isRequired: false,
       labelText: "Test Label",
-      showLabel: true,
-      id: "test_id",
       name: "test_name",
+      onChange: undefined,
+      showHelperInvalidText: true,
+      showLabel: true,
       value: "1",
-      isDisabled: false,
-      isRequired: false,
-      isInvalid: false,
-      helperText: "This is the helper text!",
-      invalidText: "This is the error text :(",
     }}
   >
     {(args) => <Radio {...args} />}

package/src/components/Radio/Radio.tsx

@@ -5,20 +5,22 @@ import {
   useMultiStyleConfig,
 } from "@chakra-ui/react";
 
+import HelperErrorText, {
+  HelperErrorTextType,
+} from "../HelperErrorText/HelperErrorText";
 import generateUUID from "../../helpers/generateUUID";
-import HelperErrorText from "../HelperErrorText/HelperErrorText";
 
 export interface RadioProps {
   /** Additional class name. */
   className?: string;
-  /** Optional string to populate the HelperErrorText for the error state
-   * when `isInvalid` is true.
-   */
-  invalidText?: string;
   /** Optional string to populate the HelperErrorText for the standard state. */
-  helperText?: string;
+  helperText?: HelperErrorTextType;
   /** ID that other components can cross reference for accessibility purposes */
   id?: string;
+  /** Optional string to populate the HelperErrorText for the error state
+   * when `isInvalid` is true.
+   */
+  invalidText?: HelperErrorTextType;
   /** When using the Radio as a "controlled" form element, you can specify the
    * `Radio`'s checked state using this prop. You must also pass an onChange prop.
    * Learn more about controlled and uncontrolled form fields: https://goshakkk.name/controlled-vs-uncontrolled-inputs-react/ */
@@ -100,9 +102,11 @@ const Radio = React.forwardRef<HTMLInputElement, RadioProps>((props, ref?) => {
       </ChakraRadio>
       {footnote && showHelperInvalidText && (
         <Box __css={styles.helper} aria-disabled={isDisabled}>
-          <HelperErrorText isInvalid={isInvalid} id={`${id}-helperText`}>
-            {footnote}
-          </HelperErrorText>
+          <HelperErrorText
+            id={`${id}-helperText`}
+            isInvalid={isInvalid}
+            text={footnote}
+          />
         </Box>
       )}
     </>

package/src/components/RadioGroup/RadioGroup.stories.mdx

@@ -1,17 +1,23 @@
 import {
-  Meta,
-  Story,
-  Canvas,
   ArgsTable,
+  Canvas,
   Description,
-} from "@storybook/addon-docs/blocks";
+  Meta,
+  Story,
+} from "@storybook/addon-docs";
 import { withDesign } from "storybook-addon-designs";
 
-import { getCategory } from "../../utils/componentCategories";
-import DSProvider from "../../theme/provider";
+import Radio from "../Radio/Radio";
 import RadioGroup, { onChangeDefault } from "./RadioGroup";
 import { RadioGroupLayoutTypes } from "./RadioGroupLayoutTypes";
-import Radio from "../Radio/Radio";
+import { getCategory } from "../../utils/componentCategories";
+import DSProvider from "../../theme/provider";
+import { getStorybookEnumValues } from "../../utils/utils";
+
+export const enumValues = getStorybookEnumValues(
+  RadioGroupLayoutTypes,
+  "RadioGroupLayoutTypes"
+);
 
 <Meta
   title={getCategory("RadioGroup")}
@@ -20,16 +26,40 @@ import Radio from "../Radio/Radio";
   parameters={{
     design: {
       type: "figma",
-      url:
-        "https://www.figma.com/file/qShodlfNCJHb8n03IFyApM/Main?node-id=11895%3A742",
+      url: "https://www.figma.com/file/qShodlfNCJHb8n03IFyApM/Main?node-id=11895%3A742",
     },
     jest: ["RadioGroup.test.tsx"],
   }}
   argTypes={{
     children: { table: { disable: true } },
-    className: { table: { disable: true } },
-    onChange: { table: { disable: true } },
-    id: { table: { disable: true } },
+    className: { control: false },
+    id: { control: false },
+    isDisabled: {
+      table: { defaultValue: { summary: false } },
+    },
+    isInvalid: {
+      table: { defaultValue: { summary: false } },
+    },
+    isRequired: {
+      table: { defaultValue: { summary: false } },
+    },
+    layout: {
+      control: { type: "select" },
+      table: { defaultValue: { summary: "RadioGroupLayoutTypes.Column" } },
+      options: enumValues.options,
+    },
+    key: { table: { disable: true } },
+    onChange: { control: false },
+    ref: { table: { disable: true } },
+    optReqFlag: {
+      table: { defaultValue: { summary: true } },
+    },
+    showHelperInvalidText: {
+      table: { defaultValue: { summary: true } },
+    },
+    showLabel: {
+      table: { defaultValue: { summary: true } },
+    },
   }}
 />
 
@@ -38,7 +68,7 @@ import Radio from "../Radio/Radio";
 | Component Version | DS Version |
 | ----------------- | ---------- |
 | Added             | `0.25.0`   |
-| Latest            | `0.25.3`   |
+| Latest            | `0.25.9`   |
 
 <Description of={RadioGroup} />
 
@@ -46,21 +76,25 @@ import Radio from "../Radio/Radio";
   <Story
     name="RadioGroup"
     args={{
+      className: undefined,
       defaultValue: "4",
-      invalidText: "error!",
       helperText: "This is the helper text for the full group.",
+      id: "radioGroup-id",
+      invalidText: "error!",
       isDisabled: false,
       isInvalid: false,
       isRequired: false,
       labelText: "Standard Radio Group",
-      layout: RadioGroupLayoutTypes.Column,
+      layout: "RadioGroupLayoutTypes.Column",
       name: "radio-story",
+      onChange: undefined,
       optReqFlag: true,
+      showHelperInvalidText: true,
       showLabel: true,
     }}
   >
     {(args) => (
-      <RadioGroup {...args}>
+      <RadioGroup {...args} layout={enumValues.getValue(args.layout)}>
         <Radio value="2" labelText="Radio 2" />
         <Radio value="3" labelText="Radio 3" />
         <Radio value="4" labelText="Radio 4" />

package/src/components/RadioGroup/RadioGroup.tsx

@@ -1,17 +1,19 @@
-import * as React from "react";
 import {
   Box,
   Stack,
   useMultiStyleConfig,
   useRadioGroup,
 } from "@chakra-ui/react";
+import * as React from "react";
 
-import HelperErrorText from "../HelperErrorText/HelperErrorText";
-import generateUUID from "../../helpers/generateUUID";
+import Fieldset from "../Fieldset/Fieldset";
+import HelperErrorText, {
+  HelperErrorTextType,
+} from "../HelperErrorText/HelperErrorText";
 import { spacing } from "../../theme/foundations/spacing";
-import { RadioGroupLayoutTypes } from "./RadioGroupLayoutTypes";
 import Radio from "../Radio/Radio";
-import Fieldset from "../Fieldset/Fieldset";
+import { RadioGroupLayoutTypes } from "./RadioGroupLayoutTypes";
+import generateUUID from "../../helpers/generateUUID";
 
 export interface RadioGroupProps {
   /** Any child node passed to the component. */
@@ -21,11 +23,11 @@ export interface RadioGroupProps {
   /** Populates the initial value of the input */
   defaultValue?: string;
   /** Optional string to populate the HelperErrorText for standard state */
-  helperText?: string;
+  helperText?: HelperErrorTextType;
   /** ID that other components can cross reference for accessibility purposes */
   id?: string;
   /** Optional string to populate the HelperErrorText for error state */
-  invalidText?: string;
+  invalidText?: HelperErrorTextType;
   /** Adds the 'disabled' prop to the input when true. */
   isDisabled?: boolean;
   /** Adds the 'aria-invalid' attribute to the input and
@@ -76,7 +78,7 @@ const RadioGroup = React.forwardRef<HTMLInputElement, RadioGroupProps>(
       showHelperInvalidText = true,
       showLabel = true,
     } = props;
-    const footnote = isInvalid ? invalidText : helperText;
+    const footnote: HelperErrorTextType = isInvalid ? invalidText : helperText;
     const spacingProp =
       layout === RadioGroupLayoutTypes.Column ? spacing.s : spacing.l;
     const newChildren = [];
@@ -141,9 +143,11 @@ const RadioGroup = React.forwardRef<HTMLInputElement, RadioGroupProps>(
         </Stack>
         {footnote && showHelperInvalidText && (
           <Box __css={styles.helper}>
-            <HelperErrorText isInvalid={isInvalid} id={`${id}-helperErrorText`}>
-              {footnote}
-            </HelperErrorText>
+            <HelperErrorText
+              id={`${id}-helperErrorText`}
+              isInvalid={isInvalid}
+              text={footnote}
+            />
           </Box>
         )}
       </Fieldset>

package/src/components/RadioGroup/__snapshots__/RadioGroup.test.tsx.snap

@@ -468,11 +468,14 @@ exports[`Radio Button renders the UI snapshot correctly 4`] = `
       aria-atomic={true}
       aria-live="off"
       className=" css-0"
+      dangerouslySetInnerHTML={
+        Object {
+          "__html": "helper text",
+        }
+      }
       data-isinvalid={false}
       id="helperText-helperErrorText"
-    >
-      helper text
-    </div>
+    />
   </div>
 </fieldset>
 `;