@nypl/design-system-react-components 0.25.11 → 0.26.0

package/src/components/Select/Select.tsx

@@ -1,9 +1,10 @@
-import React from "react";
 import {
   Box,
+  chakra,
   Select as ChakraSelect,
   useMultiStyleConfig,
 } from "@chakra-ui/react";
+import React, { useEffect, useState, useRef } from "react";
 
 import HelperErrorText, {
   HelperErrorTextType,
@@ -11,9 +12,7 @@ import HelperErrorText, {
 import Icon from "../Icons/Icon";
 import { IconNames, IconSizes } from "../Icons/IconTypes";
 import Label from "../Label/Label";
-import { SelectTypes } from "./SelectTypes";
-import generateUUID from "../../helpers/generateUUID";
-
+import { SelectTypes, LabelPositions } from "./SelectTypes";
 export interface SelectProps {
   /** Optionally pass in additional Chakra-based styles. */
   additionalStyles?: { [key: string]: any };
@@ -22,7 +21,7 @@ export interface SelectProps {
   /** Optional string to populate the `HelperErrorText` for the standard state. */
   helperText?: HelperErrorTextType;
   /** ID that other components can cross reference for accessibility purposes */
-  id?: string;
+  id: string;
   /** Optional string to populate the `HelperErrorText` for the error state
    * when `isInvalid` is true. */
   invalidText?: HelperErrorTextType;
@@ -33,6 +32,9 @@ export interface SelectProps {
   isInvalid?: boolean;
   /** Adds the `required` and `aria-required` attributes to the input when true. */
   isRequired?: boolean;
+  /** Optional value to render the label inline, rather than the default (on top)
+   * of the select element. */
+  labelPosition?: LabelPositions;
   /** Provides text for a `Label` component if `showLabel` is set to `true`;
    * populates an `aria-label` attribute on the select input if `showLabel` is
    * set to `false`. */
@@ -44,15 +46,16 @@ export interface SelectProps {
   onChange?: (event: React.FormEvent) => void;
   /** Placeholder text in the select element. */
   placeholder?: string;
+  /** The variant to display. */
+  selectType?: SelectTypes;
   /** Offers the ability to hide the helper/invalid text. */
   showHelperInvalidText?: boolean;
   /** 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"/"Optional" text in the label text. */
-  showOptReqLabel?: boolean;
-  /** The variant to display. */
-  type?: SelectTypes;
+  /** Whether or not to display the "(Required)" text in the label text.
+   * True by default. */
+  showRequiredLabel?: boolean;
   /** The value of the selected option.
    * Should be passed along with `onChange` for controlled components. */
   value?: string;
@@ -62,106 +65,124 @@ export interface SelectProps {
  * Component that renders Chakra's `Select` component along with an accessible
  * `Label` and optional `HelperErrorText` component.
  */
-const Select = React.forwardRef<
-  HTMLSelectElement,
-  React.PropsWithChildren<SelectProps>
->((props: React.PropsWithChildren<SelectProps>, ref?) => {
-  const {
-    additionalStyles = {},
-    children,
-    className,
-    helperText,
-    id = generateUUID(),
-    invalidText,
-    isDisabled = false,
-    isInvalid = false,
-    isRequired = false,
-    labelText,
-    name,
-    onChange,
-    placeholder,
-    showHelperInvalidText = true,
-    showLabel = true,
-    showOptReqLabel = true,
-    type = SelectTypes.Default,
-    value = "",
-  } = props;
-  const ariaAttributes = {};
-  const optReqFlag = isRequired ? "Required" : "Optional";
-  const styles = useMultiStyleConfig("CustomSelect", { variant: type });
-  const finalInvalidText = invalidText
-    ? invalidText
-    : "There is an error related to this field.";
-  const footnote: HelperErrorTextType = isInvalid
-    ? finalInvalidText
-    : helperText;
-  // To control the `Select` component, both `onChange` and `value`
-  // must be passed.
-  const controlledProps = onChange ? { onChange, value } : {};
+export const Select = chakra(
+  React.forwardRef<HTMLSelectElement, React.PropsWithChildren<SelectProps>>(
+    (props: React.PropsWithChildren<SelectProps>, ref?) => {
+      const {
+        additionalStyles = {},
+        children,
+        className,
+        helperText,
+        id,
+        invalidText,
+        isDisabled = false,
+        isInvalid = false,
+        isRequired = false,
+        labelPosition = LabelPositions.Default,
+        labelText,
+        name,
+        onChange,
+        placeholder,
+        selectType = SelectTypes.Default,
+        showHelperInvalidText = true,
+        showLabel = true,
+        showRequiredLabel = true,
+        value = "",
+        ...rest
+      } = props;
+      const ariaAttributes = {};
+      const [labelWidth, setLabelWidth] = useState<number>(0);
+      const labelRef = useRef<HTMLInputElement>();
+      const styles = useMultiStyleConfig("CustomSelect", {
+        variant: selectType,
+        labelPosition,
+        labelWidth,
+      });
+      const finalInvalidText = invalidText
+        ? invalidText
+        : "There is an error related to this field.";
+      const footnote: HelperErrorTextType = isInvalid
+        ? finalInvalidText
+        : helperText;
+      // To control the `Select` component, both `onChange` and `value`
+      // must be passed.
+      const controlledProps = onChange ? { onChange, value } : {};
 
-  if (!showLabel) {
-    ariaAttributes["aria-label"] =
-      labelText && footnote ? `${labelText} - ${footnote}` : labelText;
-  } else if (helperText) {
-    ariaAttributes["aria-describedby"] = `${id}-helperText`;
-  }
+      if (!showLabel) {
+        ariaAttributes["aria-label"] =
+          labelText && footnote ? `${labelText} - ${footnote}` : labelText;
+      } else if (helperText) {
+        ariaAttributes["aria-describedby"] = `${id}-helperText`;
+      }
 
-  if (React.Children.count(children) > 10) {
-    console.warn(
-      "NYPL DS recommends that <select> fields have no more than 10 options; an auto-complete text input is a good alternative for 11 or more options."
-    );
-  }
+      if (!id) {
+        console.warn(
+          "NYPL Reservoir Select: This component's required `id` prop was not passed."
+        );
+      }
 
-  if (React.Children.count(children) < 4) {
-    console.warn(
-      "NYPL DS recommends that <select> fields have at least 4 options; a radio button group is a good alternative for 3 or fewer options."
-    );
-  }
+      useEffect(() => {
+        if (labelPosition === LabelPositions.Inline) {
+          if (labelRef.current) {
+            const width = labelRef.current.clientWidth + 8;
+            setLabelWidth(width);
+          }
+        }
+      }, [labelPosition]);
 
-  return (
-    <Box className={className} __css={{ ...styles, ...additionalStyles }}>
-      {showLabel && (
-        <Label
-          id={`${id}-label`}
-          htmlFor={id}
-          optReqFlag={showOptReqLabel && optReqFlag}
+      return (
+        <Box
+          className={className}
+          __css={{ ...styles, ...additionalStyles }}
+          {...rest}
         >
-          {labelText}
-        </Label>
-      )}
-      <ChakraSelect
-        id={id}
-        variant="outline"
-        isRequired={isRequired}
-        isDisabled={isDisabled}
-        isInvalid={isInvalid}
-        name={name}
-        placeholder={placeholder}
-        ref={ref}
-        {...controlledProps}
-        {...ariaAttributes}
-        icon={
-          <Icon
-            id={`${id}-icon`}
-            name={IconNames.Arrow}
-            size={IconSizes.Medium}
-          />
-        }
-        __css={styles.select}
-      >
-        {children}
-      </ChakraSelect>
-      {footnote && showHelperInvalidText && (
-        <Box __css={styles.helper} aria-disabled={isDisabled}>
-          <HelperErrorText
-            id={`${id}-helperText`}
-            isInvalid={isInvalid}
-            text={footnote}
-          />
+          <Box __css={labelPosition === LabelPositions.Inline && styles.inline}>
+            {showLabel && (
+              <Box ref={labelRef}>
+                <Label
+                  htmlFor={id}
+                  id={`${id}-label`}
+                  isInlined
+                  isRequired={showRequiredLabel && isRequired}
+                >
+                  {labelText}
+                </Label>
+              </Box>
+            )}
+            <ChakraSelect
+              id={id}
+              variant="outline"
+              isRequired={isRequired}
+              isDisabled={isDisabled}
+              isInvalid={isInvalid}
+              name={name}
+              placeholder={placeholder}
+              ref={ref}
+              {...controlledProps}
+              {...ariaAttributes}
+              icon={
+                <Icon
+                  id={`${id}-icon`}
+                  name={IconNames.Arrow}
+                  size={IconSizes.Medium}
+                />
+              }
+              __css={styles.select}
+            >
+              {children}
+            </ChakraSelect>
+            {footnote && showHelperInvalidText && (
+              <HelperErrorText
+                id={`${id}-helperText`}
+                isInvalid={isInvalid}
+                text={footnote}
+              />
+            )}
+          </Box>
         </Box>
-      )}
-    </Box>
-  );
-});
+      );
+    }
+  )
+);
 
 export default Select;

package/src/components/Select/SelectTypes.tsx

@@ -3,3 +3,8 @@ export enum SelectTypes {
   Default = "default",
   SearchBar = "searchbar",
 }
+
+export enum LabelPositions {
+  Default = "default",
+  Inline = "inline",
+}