@nypl/design-system-react-components 1.2.0-rc-3 → 1.2.0

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

@@ -12,6 +12,9 @@ interface LabelProps {
     /** 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
+     * Note: Parenthesis will be added automatically by the component */
+    requiredLabelText?: string;
 }
 /**
  * A label for form inputs. It should never be used alone.

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

@@ -56,6 +56,9 @@ export interface InputProps {
     /** Whether or not to display the "(Required)" text in the label text.
      * True by default. */
     showRequiredLabel?: boolean;
+    /** Allows the '(Required)' text to be changed for language purposes
+     * Note: Parenthesis will be added automatically by the component */
+    requiredLabelText?: string;
     /** The amount to increase or decrease when using the number type. */
     step?: number;
     /** FOR INTERNAL DS USE ONLY: the input variant to display. */

package/dist/design-system-react-components.cjs.development.js

@@ -4069,7 +4069,7 @@ var Form = /*#__PURE__*/react.chakra( /*#__PURE__*/React.forwardRef(function (pr
   }
 });
 
-var _excluded$18 = ["children", "className", "htmlFor", "id", "isInlined", "isRequired"];
+var _excluded$18 = ["children", "className", "htmlFor", "id", "isInlined", "isRequired", "requiredLabelText"];
 /**
  * A label for form inputs. It should never be used alone.
  */
@@ -4083,6 +4083,7 @@ var Label = /*#__PURE__*/react.chakra( /*#__PURE__*/React.forwardRef(function (p
       isInlined = _props$isInlined === void 0 ? false : _props$isInlined,
       _props$isRequired = props.isRequired,
       isRequired = _props$isRequired === void 0 ? false : _props$isRequired,
+      requiredLabelText = props.requiredLabelText,
       rest = _objectWithoutPropertiesLoose(props, _excluded$18);
 
   var styles = react.useStyleConfig("Label", {
@@ -4100,10 +4101,10 @@ var Label = /*#__PURE__*/react.chakra( /*#__PURE__*/React.forwardRef(function (p
     htmlFor: htmlFor,
     ref: ref,
     __css: styles
-  }, rest), children, isRequired && React__default.createElement("span", null, " (Required)"));
+  }, rest), children, isRequired && React__default.createElement("span", null, requiredLabelText ? " (" + requiredLabelText + ")" : " (Required)"));
 }));
 
-var _excluded$19 = ["className", "defaultValue", "helperText", "id", "invalidText", "isDisabled", "isInvalid", "isRequired", "labelText", "max", "maxLength", "min", "name", "onChange", "onClick", "onFocus", "placeholder", "showHelperInvalidText", "showLabel", "showRequiredLabel", "step", "textInputType", "type", "value"];
+var _excluded$19 = ["className", "defaultValue", "helperText", "id", "invalidText", "isDisabled", "isInvalid", "isRequired", "labelText", "max", "maxLength", "min", "name", "onChange", "onClick", "onFocus", "placeholder", "showHelperInvalidText", "showLabel", "showRequiredLabel", "requiredLabelText", "step", "textInputType", "type", "value"];
 
 var TextInputFormats = {
   email: "jdoe@domain.com",
@@ -4147,6 +4148,7 @@ var TextInput = /*#__PURE__*/react.chakra( /*#__PURE__*/React.forwardRef(functio
       showLabel = _props$showLabel === void 0 ? true : _props$showLabel,
       _props$showRequiredLa = props.showRequiredLabel,
       showRequiredLabel = _props$showRequiredLa === void 0 ? true : _props$showRequiredLa,
+      requiredLabelText = props.requiredLabelText,
       _props$step = props.step,
       step = _props$step === void 0 ? 1 : _props$step,
       _props$textInputType = props.textInputType,
@@ -4242,7 +4244,8 @@ var TextInput = /*#__PURE__*/react.chakra( /*#__PURE__*/React.forwardRef(functio
   }, rest), labelText && showLabel && !isHidden && React__default.createElement(Label, {
     htmlFor: id,
     id: id + "-label",
-    isRequired: showRequiredLabel && isRequired
+    isRequired: showRequiredLabel && isRequired,
+    requiredLabelText: requiredLabelText
   }, labelText), fieldOutput);
 }));