@spscommerce/ds-react 5.21.5 → 5.22.0

package/lib/index.es.js

@@ -34806,7 +34806,8 @@ const propsDoc$v = {
   name: "string",
   onChange: "ChangeEventHandler<HTMLInputElement>",
   placeholder: "string",
-  value: "string"
+  value: "string",
+  additionalText: "string"
 };
 const propTypes$x = __spreadProps(__spreadValues({}, spsGlobalPropTypes), {
   disabled: propTypes$1O.exports.bool,
@@ -34816,7 +34817,8 @@ const propTypes$x = __spreadProps(__spreadValues({}, spsGlobalPropTypes), {
   name: propTypes$1O.exports.string,
   onChange: fun(),
   placeholder: propTypes$1O.exports.string,
-  value: propTypes$1O.exports.string
+  value: propTypes$1O.exports.string,
+  additionalText: propTypes$1O.exports.string
 });
 const SpsTextInput = React.forwardRef((_G, ref2) => {
   var _H = _G, {
@@ -34832,7 +34834,8 @@ const SpsTextInput = React.forwardRef((_G, ref2) => {
     "data-testid": testId,
     title,
     unsafelyReplaceClassName,
-    value = ""
+    value = "",
+    additionalText
   } = _H, rest = __objRest(_H, [
     "className",
     "disabled",
@@ -34846,7 +34849,8 @@ const SpsTextInput = React.forwardRef((_G, ref2) => {
     "data-testid",
     "title",
     "unsafelyReplaceClassName",
-    "value"
+    "value",
+    "additionalText"
   ]);
   const meta = formMeta || formControl2;
   const { wrapperId, controlId } = useFormControlId(id2, meta);
@@ -34897,7 +34901,9 @@ const SpsTextInput = React.forwardRef((_G, ref2) => {
     "data-testid": `${testId}__input_clear`,
     className: "sps-icon sps-icon-x-circle sps-form-control__clear-btn",
     onClick: clear
-  })));
+  })), additionalText && /* @__PURE__ */ React.createElement("p", {
+    className: "sps-input__additional-text"
+  }, additionalText));
 });
 Object.assign(SpsTextInput, {
   props: propsDoc$v,
@@ -34905,91 +34911,118 @@ Object.assign(SpsTextInput, {
   displayName: "SpsTextInput"
 });
 const SpsTextInputExamples = {
-  standard: {
-    label: "Standard",
-    description: "info about standard text inputs",
+  general: {
+    label: "General Usage",
+    description: ({ NavigateTo }) => /* @__PURE__ */ React.createElement(React.Fragment, null, /* @__PURE__ */ React.createElement("h5", null, "Use a Text Input:"), /* @__PURE__ */ React.createElement("ul", null, /* @__PURE__ */ React.createElement("li", null, "When the value required is short (a single word or short phrase)."), /* @__PURE__ */ React.createElement("li", null, "When only one value is required or accepted.")), /* @__PURE__ */ React.createElement("h5", null, "Do Not Use a Text Input:"), /* @__PURE__ */ React.createElement("ul", null, /* @__PURE__ */ React.createElement("li", null, "When a value of considerable length (such as a sentence or paragraph) is required or accepted. Use a ", /* @__PURE__ */ React.createElement(NavigateTo, {
+      to: "text-areas"
+    }, "Text Area"), " instead."), /* @__PURE__ */ React.createElement("li", null, "When more than one value is required or accepted in the field. Use", " ", /* @__PURE__ */ React.createElement(NavigateTo, {
+      to: "multi-select"
+    }, "Multi-Select"), " instead."), /* @__PURE__ */ React.createElement("li", null, "When a boolean selection is required (such as on/off, yes/no, etc). Use", " ", /* @__PURE__ */ React.createElement(NavigateTo, {
+      to: "checkbox"
+    }, "Checkboxes"), ",", " ", /* @__PURE__ */ React.createElement(NavigateTo, {
+      to: "radio-buttons"
+    }, "Radio Buttons"), " or", " ", /* @__PURE__ */ React.createElement(NavigateTo, {
+      to: "toggle"
+    }, "Toggles"), " instead.")))
+  },
+  basic: {
+    label: "Basic Text Inputs",
+    description: () => /* @__PURE__ */ React.createElement("p", null, "Basic Text Inputs include a label and an input field."),
     examples: {
       standard: {
         react: code`
                     function DemoComponent() {
-                        const { formValue, formMeta, updateForm } = useSpsForm({ foo: "bar" });
+                        const { formValue, formMeta, updateForm } = useSpsForm({ companyName: "" });
 
-                        return <>
-                            <SpsLabel for={formMeta.fields.foo}>Foo</SpsLabel>
-                            <SpsTextInput
-                                value={formValue.foo}
-                                formMeta={formMeta.fields.foo}
-                            />
-                        </>;
+                        return (
+                            <div className="sfg-row">
+                                <div className="sfg-col-4">
+                                    <SpsLabel for={formMeta.fields.companyName}>Company Name</SpsLabel>
+                                    <SpsTextInput
+                                        value={formValue.companyName}
+                                        formMeta={formMeta.fields.companyName}
+                                    />
+                                </div>
+                            </div>
+                        );
                     }
                 `
       }
     }
   },
-  b_placeholder: {
-    label: "Placeholder",
-    description: "info about text input placeholders",
+  placeholder: {
+    label: "Placeholder Text",
+    description: ({ NavigateTo }) => /* @__PURE__ */ React.createElement("p", null, "Certain inputs may benefit from placeholder text to aid the user in providing a valid value."),
     examples: {
       placeholder: {
         react: code`
                     function DemoComponent() {
-                        const { formValue, formMeta, updateForm } = useSpsForm({ foo: "bar" });
+                      const { formValue, formMeta, updateForm } = useSpsForm({ phoneNumber: "" });
 
-                        return <>
-                                <SpsLabel for={formMeta.fields.foo}>
-                                    Company Name
-                                </SpsLabel>
-                                <SpsTextInput formMeta={formMeta.fields.foo}
-                                    value={formValue.foo}
-                                    placeholder="Enter a company name"
-                                ></SpsTextInput>
-                            </>
+                      return (
+                          <div className="sfg-row">
+                              <div className="sfg-col-4">
+                                  <SpsLabel for={formMeta.fields.phoneNumber}>Phone Number</SpsLabel>
+                                  <SpsTextInput
+                                      value={formValue.phoneNumber}
+                                      formMeta={formMeta.fields.phoneNumber}
+                                      placeholder="(000) 000-0000"
+                                  />
+                              </div>
+                          </div>
+                      );
                     }
                 `
       }
     }
   },
-  c_description: {
-    label: "Description",
-    description: "info about text inputs with descriptions",
+  additional_text: {
+    label: "Additional Descriptive Text",
+    description: ({ NavigateTo }) => /* @__PURE__ */ React.createElement("p", null, "For occasions when additional context beyond a placeholder is required, text in the form of a short phrase can appear below the input."),
     examples: {
-      description: {
+      placeholder: {
         react: code`
                     function DemoComponent() {
-                        const { formValue, formMeta, updateForm } = useSpsForm({ foo: "bar" });
+                      const { formValue, formMeta, updateForm } = useSpsForm({ password: "" });
 
-                        return <>
-                                <SpsLabel for={formMeta.fields.foo}
-                                    value={formValue.foo}
-                                    description="This is a brief description of the field to provide additional context."
-                                >
-                                    Label
-                                </SpsLabel>
-                                <SpsTextInput formMeta={formMeta.fields.foo}/>
-                            </>
+                      return (
+                          <div className="sfg-row">
+                              <div className="sfg-col-4">
+                                  <SpsLabel for={formMeta.fields.password}>Password</SpsLabel>
+                                  <SpsTextInput
+                                      value={formValue.password}
+                                      formMeta={formMeta.fields.password}
+                                      additionalText="Password must be 8-12 characters in length and include: 1 capital letter, 1 number and 1 special character"
+                                  />
+                              </div>
+                          </div>
+                      );
                     }
                 `
       }
     }
   },
-  d_disabled: {
-    label: "Disabled",
-    description: "info about disabled text inputs",
+  disabled: {
+    label: "Disabled State",
+    description: () => /* @__PURE__ */ React.createElement("p", null, "The Disabled State prevents a user from modifying the text input while still allowing visibility to its information."),
     examples: {
-      disabled: {
+      standard: {
         react: code`
                     function DemoComponent() {
-                        const { formValue, formMeta, updateForm } = useSpsForm({ email: "foo@bar.com" });
+                        const { formValue, formMeta, updateForm } = useSpsForm({ companyName: "FGL Sports" });
 
-                        return <>
-                                <SpsLabel for={formMeta.fields.email}>
-                                    Email Address
-                                </SpsLabel>
-                                <SpsTextInput id="disabledTextInput" disabled
-                                    value={formValue.email}
-                                    formMeta={formMeta.fields.email}
-                                ></SpsTextInput>
-                            </>
+                        return (
+                            <div className="sfg-row">
+                                <div className="sfg-col-4">
+                                    <SpsLabel for={formMeta.fields.companyName}>Company Name</SpsLabel>
+                                    <SpsTextInput
+                                        value={formValue.companyName}
+                                        formMeta={formMeta.fields.companyName}
+                                        disabled
+                                    />
+                                </div>
+                            </div>
+                        );
                     }
                 `
       }
@@ -35003,7 +35036,8 @@ const propsDoc$u = {
   onChange: "ChangeEventHandler",
   placeholder: "string",
   rows: "number",
-  value: "string"
+  value: "string",
+  additionalText: "string"
 };
 const propTypes$w = __spreadProps(__spreadValues({}, spsGlobalPropTypes), {
   disabled: propTypes$1O.exports.bool,
@@ -35014,7 +35048,8 @@ const propTypes$w = __spreadProps(__spreadValues({}, spsGlobalPropTypes), {
   placeholder: propTypes$1O.exports.string,
   ref: ref(),
   rows: propTypes$1O.exports.number,
-  value: propTypes$1O.exports.string
+  value: propTypes$1O.exports.string,
+  additionalText: propTypes$1O.exports.string
 });
 function SpsTextarea(_I) {
   var _J = _I, {
@@ -35030,7 +35065,8 @@ function SpsTextarea(_I) {
     rows = 2,
     "data-testid": testId,
     unsafelyReplaceClassName,
-    value = ""
+    value = "",
+    additionalText
   } = _J, rest = __objRest(_J, [
     "className",
     "disabled",
@@ -35044,7 +35080,8 @@ function SpsTextarea(_I) {
     "rows",
     "data-testid",
     "unsafelyReplaceClassName",
-    "value"
+    "value",
+    "additionalText"
   ]);
   const meta = formMeta || formControl2;
   const { wrapperId, controlId } = useFormControlId(id2, meta);
@@ -35092,7 +35129,9 @@ function SpsTextarea(_I) {
     "data-testid": `${testId}__input_clear`,
     className: "sps-icon sps-icon-x-circle sps-form-control__clear-btn",
     onClick: clear
-  })));
+  })), additionalText && /* @__PURE__ */ React.createElement("p", {
+    className: "sps-input__additional-text"
+  }, additionalText));
 }
 Object.assign(SpsTextarea, {
   props: propsDoc$u,
@@ -35100,101 +35139,119 @@ Object.assign(SpsTextarea, {
   displayName: "SpsTextarea"
 });
 const SpsTextareaExamples = {
+  general: {
+    label: "General Usage",
+    description: ({ NavigateTo }) => /* @__PURE__ */ React.createElement(React.Fragment, null, /* @__PURE__ */ React.createElement("h5", null, "Use a Text Area:"), /* @__PURE__ */ React.createElement("ul", null, /* @__PURE__ */ React.createElement("li", null, "When a value of considerable length (such as a sentence or paragraph) is required or accepted.")), /* @__PURE__ */ React.createElement("h5", null, "Do Not Use a Text Area:"), /* @__PURE__ */ React.createElement("ul", null, /* @__PURE__ */ React.createElement("li", null, "When the value required is short (a single word or short phrase). Use a", " ", /* @__PURE__ */ React.createElement(NavigateTo, {
+      to: "text-inputs"
+    }, "Text Input"), " instead."), /* @__PURE__ */ React.createElement("li", null, "When more than one value is required or accepted in the field. Use", " ", /* @__PURE__ */ React.createElement(NavigateTo, {
+      to: "multi-select"
+    }, "Multi-Select"), " instead."), /* @__PURE__ */ React.createElement("li", null, "When a boolean selection is required (such as on/off, yes/no, etc). Use", " ", /* @__PURE__ */ React.createElement(NavigateTo, {
+      to: "checkbox"
+    }, "Checkboxes"), ",", " ", /* @__PURE__ */ React.createElement(NavigateTo, {
+      to: "radio-buttons"
+    }, "Radio Buttons"), " or", " ", /* @__PURE__ */ React.createElement(NavigateTo, {
+      to: "toggle"
+    }, "Toggles"), " instead.")))
+  },
   basic: {
-    label: "Basic",
-    description: "info about basic text areas",
+    label: "Basic Text Areas",
+    description: () => /* @__PURE__ */ React.createElement("p", null, "Basic Text Areas include a label and a large input field. By default a Text Area is three lines tall, but the height can be adjusted."),
     examples: {
-      basic: {
+      standard: {
         react: code`
                     function DemoComponent() {
-                        function numLinesValidator(n) {
-                            return function(value) {
-                                const lines = typeof value === "string" ? value.split("\\n").length : 0;
-                                if (lines !== n) {
-                                    return {
-                                        numLines: {
-                                            actualLines: lines,
-                                            requiredLines: n
-                                        }
-                                    };
-                                }
-                                return null;
-                            };
-                        }
+                        const { formValue, formMeta, updateForm } = useSpsForm({ notes: "" });
 
-                        const { formValue, formMeta, updateForm } = useSpsForm({
-                            haiku: ""
-                        }, {
-                            "haiku": [numLinesValidator(3)]
-                        });
+                        return (
+                            <div className="sfg-row">
+                                <div className="sfg-col-4">
+                                    <SpsLabel for={formMeta.fields.notes}>Notes</SpsLabel>
+                                    <SpsTextarea
+                                        value={formValue.notes}
+                                        formMeta={formMeta.fields.notes}
+                                        rows={5}
+                                    />
+                                </div>
+                            </div>
+                        );
+                    }
+                `
+      }
+    }
+  },
+  placeholder: {
+    label: "Placeholder Text",
+    description: ({ NavigateTo }) => /* @__PURE__ */ React.createElement("p", null, "Certain inputs may benefit from placeholder text to aid the user in providing a valid value."),
+    examples: {
+      placeholder: {
+        react: code`
+                    function DemoComponent() {
+                      const { formValue, formMeta, updateForm } = useSpsForm({ companyDescription: "" });
 
-                        return <>
-                            <SpsLabel for={formMeta.fields.haiku}
-                                help="A haiku is a three-line poem of 5, 7, and 5 syllables respectively."
-                                errors={() =>
-                                    formMeta.fields.haiku.hasError("numLines") && (
-                                        <>
-                                        You need {formMeta.fields.haiku.errors["numLines"].requiredLines} lines,
-                                        but you've only written {formMeta.fields.haiku.errors["numLines"].actualLines} lines!
-                                    </>
-                                )
-                            }>
-                                Haiku
-                            </SpsLabel>
-                            <SpsTextarea placeholder="Write a haiku" rows={3}
-                                formMeta={formMeta.fields.haiku}
-                                value={formValue.haiku}
-                            ></SpsTextarea>
-                        </>
+                      return (
+                          <div className="sfg-row">
+                              <div className="sfg-col-4">
+                                  <SpsLabel for={formMeta.fields.companyDescription}>Company Description</SpsLabel>
+                                  <SpsTextarea
+                                      value={formValue.companyDescription}
+                                      formMeta={formMeta.fields.companyDescription}
+                                      placeholder="Describe your company"
+                                  />
+                              </div>
+                          </div>
+                      );
                     }
                 `
       }
     }
   },
-  b_description: {
-    label: "Description",
-    description: "info about text areas with descriptions",
+  additional_text: {
+    label: "Additional Descriptive Text",
+    description: ({ NavigateTo }) => /* @__PURE__ */ React.createElement("p", null, "For occasions when additional context beyond a placeholder is required, text in the form of a short phrase can appear below the input."),
     examples: {
-      description: {
+      placeholder: {
         react: code`
                     function DemoComponent() {
-                        const { formValue, formMeta, updateForm } = useSpsForm({
-                            textareaWithDescription: ""
-                        });
+                      const { formValue, formMeta, updateForm } = useSpsForm({ campaignNotes: "" });
 
-                        return <>
-                            <SpsLabel for={formMeta.fields.textareaWithDescription}
-                                description="This is a brief description of the field to provide additional context."
-                            >
-                                Label
-                            </SpsLabel>
-                            <SpsTextarea formMeta={formMeta.fields.textareaWithDescription}
-                                value={formValue.textareaWithDescription}
-                            />
-                        </>
+                      return (
+                          <div className="sfg-row">
+                              <div className="sfg-col-4">
+                                  <SpsLabel for={formMeta.fields.campaignNotes}>Campaign Notes</SpsLabel>
+                                  <SpsTextarea
+                                      value={formValue.campaignNotes}
+                                      formMeta={formMeta.fields.campaignNotes}
+                                      additionalText="List any additional comments, questions or information about this campaign."
+                                  />
+                              </div>
+                          </div>
+                      );
                     }
                 `
       }
     }
   },
-  c_disabled: {
-    label: "Disabled",
-    description: "info about disabled text areas",
+  disabled: {
+    label: "Disabled State",
+    description: () => /* @__PURE__ */ React.createElement("p", null, "The Disabled State prevents a user from modifying the text input while still allowing visibility to its information."),
     examples: {
-      disabled: {
+      standard: {
         react: code`
                     function DemoComponent() {
-                        const { formValue, formMeta, updateForm } = useSpsForm({
-                            notes: "This is the value of the textarea but you can't edit it right now"
-                        });
+                        const { formValue, formMeta, updateForm } = useSpsForm({ notes: "Some notes here" });
 
-                        return <>
-                            <SpsLabel for={formMeta.fields.notes}>Notes</SpsLabel>
-                            <SpsTextarea disabled rows={5}
-                                formMeta={formMeta.fields.notes}
-                                value={formValue.notes}
-                            ></SpsTextarea>
-                        </>
+                        return (
+                            <div className="sfg-row">
+                                <div className="sfg-col-4">
+                                    <SpsLabel for={formMeta.fields.notes}>Notes</SpsLabel>
+                                    <SpsTextarea
+                                        value={formValue.notes}
+                                        formMeta={formMeta.fields.notes}
+                                        disabled
+                                    />
+                                </div>
+                            </div>
+                        );
                     }
                 `
       }
@@ -37557,11 +37614,13 @@ const MANIFEST = {
     components: [SpsTaskQueue],
     examples: SpsTaskQueueExamples
   },
-  "Text Input": {
+  "Text Inputs": {
+    description: () => /* @__PURE__ */ React.createElement("p", null, "Text Inputs consist of a Label and a field in which a user enters a short value."),
     components: [SpsTextInput],
     examples: SpsTextInputExamples
   },
-  Textarea: {
+  "Text Areas": {
+    description: () => /* @__PURE__ */ React.createElement("p", null, "Text Areas consist of a Label and a field in which a user enters a long value."),
     components: [SpsTextarea],
     examples: SpsTextareaExamples
   },

package/lib/text-input/SpsTextInput.d.ts

@@ -12,11 +12,12 @@ declare const propTypes: {
     onChange: PropTypes.Requireable<React.ChangeEventHandler<HTMLInputElement>>;
     placeholder: PropTypes.Requireable<string>;
     value: PropTypes.Requireable<string>;
+    additionalText: PropTypes.Requireable<string>;
     children: PropTypes.Requireable<PropTypes.ReactNodeLike>;
     className: PropTypes.Requireable<string>;
     "data-testid": PropTypes.Requireable<string>;
     unsafelyReplaceClassName: PropTypes.Requireable<string>;
 };
 export declare type SpsTextInputProps = PropTypes.InferTS<typeof propTypes, HTMLInputElement>;
-export declare const SpsTextInput: React.ForwardRefExoticComponent<Pick<SpsTextInputProps, "accept" | "acceptCharset" | "action" | "allowFullScreen" | "allowTransparency" | "alt" | "as" | "async" | "autoComplete" | "autoFocus" | "autoPlay" | "capture" | "cellPadding" | "cellSpacing" | "charSet" | "challenge" | "checked" | "cite" | "classID" | "cols" | "colSpan" | "content" | "controls" | "coords" | "crossOrigin" | "data" | "dateTime" | "default" | "defer" | "disabled" | "download" | "encType" | "form" | "formAction" | "formEncType" | "formMethod" | "formNoValidate" | "formTarget" | "frameBorder" | "headers" | "height" | "high" | "href" | "hrefLang" | "htmlFor" | "httpEquiv" | "integrity" | "keyParams" | "keyType" | "kind" | "label" | "list" | "loop" | "low" | "manifest" | "marginHeight" | "marginWidth" | "max" | "maxLength" | "media" | "mediaGroup" | "method" | "min" | "minLength" | "multiple" | "muted" | "name" | "nonce" | "noValidate" | "open" | "optimum" | "pattern" | "placeholder" | "playsInline" | "poster" | "preload" | "readOnly" | "rel" | "required" | "reversed" | "rows" | "rowSpan" | "sandbox" | "scope" | "scoped" | "scrolling" | "seamless" | "selected" | "shape" | "size" | "sizes" | "span" | "src" | "srcDoc" | "srcLang" | "srcSet" | "start" | "step" | "summary" | "target" | "type" | "useMap" | "value" | "width" | "wmode" | "wrap" | "defaultChecked" | "defaultValue" | "suppressContentEditableWarning" | "suppressHydrationWarning" | "accessKey" | "className" | "contentEditable" | "contextMenu" | "dir" | "draggable" | "hidden" | "id" | "lang" | "slot" | "spellCheck" | "style" | "tabIndex" | "title" | "translate" | "radioGroup" | "role" | "about" | "datatype" | "inlist" | "prefix" | "property" | "resource" | "typeof" | "vocab" | "autoCapitalize" | "autoCorrect" | "autoSave" | "color" | "itemProp" | "itemScope" | "itemType" | "itemID" | "itemRef" | "results" | "security" | "unselectable" | "inputMode" | "is" | "aria-activedescendant" | "aria-atomic" | "aria-autocomplete" | "aria-busy" | "aria-checked" | "aria-colcount" | "aria-colindex" | "aria-colspan" | "aria-controls" | "aria-current" | "aria-describedby" | "aria-details" | "aria-disabled" | "aria-dropeffect" | "aria-errormessage" | "aria-expanded" | "aria-flowto" | "aria-grabbed" | "aria-haspopup" | "aria-hidden" | "aria-invalid" | "aria-keyshortcuts" | "aria-label" | "aria-labelledby" | "aria-level" | "aria-live" | "aria-modal" | "aria-multiline" | "aria-multiselectable" | "aria-orientation" | "aria-owns" | "aria-placeholder" | "aria-posinset" | "aria-pressed" | "aria-readonly" | "aria-relevant" | "aria-required" | "aria-roledescription" | "aria-rowcount" | "aria-rowindex" | "aria-rowspan" | "aria-selected" | "aria-setsize" | "aria-sort" | "aria-valuemax" | "aria-valuemin" | "aria-valuenow" | "aria-valuetext" | "children" | "dangerouslySetInnerHTML" | "onCopy" | "onCopyCapture" | "onCut" | "onCutCapture" | "onPaste" | "onPasteCapture" | "onCompositionEnd" | "onCompositionEndCapture" | "onCompositionStart" | "onCompositionStartCapture" | "onCompositionUpdate" | "onCompositionUpdateCapture" | "onFocus" | "onFocusCapture" | "onBlur" | "onBlurCapture" | "onChange" | "onChangeCapture" | "onBeforeInput" | "onBeforeInputCapture" | "onInput" | "onInputCapture" | "onReset" | "onResetCapture" | "onSubmit" | "onSubmitCapture" | "onInvalid" | "onInvalidCapture" | "onLoad" | "onLoadCapture" | "onError" | "onErrorCapture" | "onKeyDown" | "onKeyDownCapture" | "onKeyPress" | "onKeyPressCapture" | "onKeyUp" | "onKeyUpCapture" | "onAbort" | "onAbortCapture" | "onCanPlay" | "onCanPlayCapture" | "onCanPlayThrough" | "onCanPlayThroughCapture" | "onDurationChange" | "onDurationChangeCapture" | "onEmptied" | "onEmptiedCapture" | "onEncrypted" | "onEncryptedCapture" | "onEnded" | "onEndedCapture" | "onLoadedData" | "onLoadedDataCapture" | "onLoadedMetadata" | "onLoadedMetadataCapture" | "onLoadStart" | "onLoadStartCapture" | "onPause" | "onPauseCapture" | "onPlay" | "onPlayCapture" | "onPlaying" | "onPlayingCapture" | "onProgress" | "onProgressCapture" | "onRateChange" | "onRateChangeCapture" | "onSeeked" | "onSeekedCapture" | "onSeeking" | "onSeekingCapture" | "onStalled" | "onStalledCapture" | "onSuspend" | "onSuspendCapture" | "onTimeUpdate" | "onTimeUpdateCapture" | "onVolumeChange" | "onVolumeChangeCapture" | "onWaiting" | "onWaitingCapture" | "onAuxClick" | "onAuxClickCapture" | "onClick" | "onClickCapture" | "onContextMenu" | "onContextMenuCapture" | "onDoubleClick" | "onDoubleClickCapture" | "onDrag" | "onDragCapture" | "onDragEnd" | "onDragEndCapture" | "onDragEnter" | "onDragEnterCapture" | "onDragExit" | "onDragExitCapture" | "onDragLeave" | "onDragLeaveCapture" | "onDragOver" | "onDragOverCapture" | "onDragStart" | "onDragStartCapture" | "onDrop" | "onDropCapture" | "onMouseDown" | "onMouseDownCapture" | "onMouseEnter" | "onMouseLeave" | "onMouseMove" | "onMouseMoveCapture" | "onMouseOut" | "onMouseOutCapture" | "onMouseOver" | "onMouseOverCapture" | "onMouseUp" | "onMouseUpCapture" | "onSelect" | "onSelectCapture" | "onTouchCancel" | "onTouchCancelCapture" | "onTouchEnd" | "onTouchEndCapture" | "onTouchMove" | "onTouchMoveCapture" | "onTouchStart" | "onTouchStartCapture" | "onPointerDown" | "onPointerDownCapture" | "onPointerMove" | "onPointerMoveCapture" | "onPointerUp" | "onPointerUpCapture" | "onPointerCancel" | "onPointerCancelCapture" | "onPointerEnter" | "onPointerEnterCapture" | "onPointerLeave" | "onPointerLeaveCapture" | "onPointerOver" | "onPointerOverCapture" | "onPointerOut" | "onPointerOutCapture" | "onGotPointerCapture" | "onGotPointerCaptureCapture" | "onLostPointerCapture" | "onLostPointerCaptureCapture" | "onScroll" | "onScrollCapture" | "onWheel" | "onWheelCapture" | "onAnimationStart" | "onAnimationStartCapture" | "onAnimationEnd" | "onAnimationEndCapture" | "onAnimationIteration" | "onAnimationIterationCapture" | "onTransitionEnd" | "onTransitionEndCapture" | "key" | "icon" | "data-testid" | "unsafelyReplaceClassName" | "formMeta" | "formControl"> & React.RefAttributes<HTMLInputElement>>;
+export declare const SpsTextInput: React.ForwardRefExoticComponent<Pick<SpsTextInputProps, "accept" | "acceptCharset" | "action" | "allowFullScreen" | "allowTransparency" | "alt" | "as" | "async" | "autoComplete" | "autoFocus" | "autoPlay" | "capture" | "cellPadding" | "cellSpacing" | "charSet" | "challenge" | "checked" | "cite" | "classID" | "cols" | "colSpan" | "content" | "controls" | "coords" | "crossOrigin" | "data" | "dateTime" | "default" | "defer" | "disabled" | "download" | "encType" | "form" | "formAction" | "formEncType" | "formMethod" | "formNoValidate" | "formTarget" | "frameBorder" | "headers" | "height" | "high" | "href" | "hrefLang" | "htmlFor" | "httpEquiv" | "integrity" | "keyParams" | "keyType" | "kind" | "label" | "list" | "loop" | "low" | "manifest" | "marginHeight" | "marginWidth" | "max" | "maxLength" | "media" | "mediaGroup" | "method" | "min" | "minLength" | "multiple" | "muted" | "name" | "nonce" | "noValidate" | "open" | "optimum" | "pattern" | "placeholder" | "playsInline" | "poster" | "preload" | "readOnly" | "rel" | "required" | "reversed" | "rows" | "rowSpan" | "sandbox" | "scope" | "scoped" | "scrolling" | "seamless" | "selected" | "shape" | "size" | "sizes" | "span" | "src" | "srcDoc" | "srcLang" | "srcSet" | "start" | "step" | "summary" | "target" | "type" | "useMap" | "value" | "width" | "wmode" | "wrap" | "defaultChecked" | "defaultValue" | "suppressContentEditableWarning" | "suppressHydrationWarning" | "accessKey" | "className" | "contentEditable" | "contextMenu" | "dir" | "draggable" | "hidden" | "id" | "lang" | "slot" | "spellCheck" | "style" | "tabIndex" | "title" | "translate" | "radioGroup" | "role" | "about" | "datatype" | "inlist" | "prefix" | "property" | "resource" | "typeof" | "vocab" | "autoCapitalize" | "autoCorrect" | "autoSave" | "color" | "itemProp" | "itemScope" | "itemType" | "itemID" | "itemRef" | "results" | "security" | "unselectable" | "inputMode" | "is" | "aria-activedescendant" | "aria-atomic" | "aria-autocomplete" | "aria-busy" | "aria-checked" | "aria-colcount" | "aria-colindex" | "aria-colspan" | "aria-controls" | "aria-current" | "aria-describedby" | "aria-details" | "aria-disabled" | "aria-dropeffect" | "aria-errormessage" | "aria-expanded" | "aria-flowto" | "aria-grabbed" | "aria-haspopup" | "aria-hidden" | "aria-invalid" | "aria-keyshortcuts" | "aria-label" | "aria-labelledby" | "aria-level" | "aria-live" | "aria-modal" | "aria-multiline" | "aria-multiselectable" | "aria-orientation" | "aria-owns" | "aria-placeholder" | "aria-posinset" | "aria-pressed" | "aria-readonly" | "aria-relevant" | "aria-required" | "aria-roledescription" | "aria-rowcount" | "aria-rowindex" | "aria-rowspan" | "aria-selected" | "aria-setsize" | "aria-sort" | "aria-valuemax" | "aria-valuemin" | "aria-valuenow" | "aria-valuetext" | "children" | "dangerouslySetInnerHTML" | "onCopy" | "onCopyCapture" | "onCut" | "onCutCapture" | "onPaste" | "onPasteCapture" | "onCompositionEnd" | "onCompositionEndCapture" | "onCompositionStart" | "onCompositionStartCapture" | "onCompositionUpdate" | "onCompositionUpdateCapture" | "onFocus" | "onFocusCapture" | "onBlur" | "onBlurCapture" | "onChange" | "onChangeCapture" | "onBeforeInput" | "onBeforeInputCapture" | "onInput" | "onInputCapture" | "onReset" | "onResetCapture" | "onSubmit" | "onSubmitCapture" | "onInvalid" | "onInvalidCapture" | "onLoad" | "onLoadCapture" | "onError" | "onErrorCapture" | "onKeyDown" | "onKeyDownCapture" | "onKeyPress" | "onKeyPressCapture" | "onKeyUp" | "onKeyUpCapture" | "onAbort" | "onAbortCapture" | "onCanPlay" | "onCanPlayCapture" | "onCanPlayThrough" | "onCanPlayThroughCapture" | "onDurationChange" | "onDurationChangeCapture" | "onEmptied" | "onEmptiedCapture" | "onEncrypted" | "onEncryptedCapture" | "onEnded" | "onEndedCapture" | "onLoadedData" | "onLoadedDataCapture" | "onLoadedMetadata" | "onLoadedMetadataCapture" | "onLoadStart" | "onLoadStartCapture" | "onPause" | "onPauseCapture" | "onPlay" | "onPlayCapture" | "onPlaying" | "onPlayingCapture" | "onProgress" | "onProgressCapture" | "onRateChange" | "onRateChangeCapture" | "onSeeked" | "onSeekedCapture" | "onSeeking" | "onSeekingCapture" | "onStalled" | "onStalledCapture" | "onSuspend" | "onSuspendCapture" | "onTimeUpdate" | "onTimeUpdateCapture" | "onVolumeChange" | "onVolumeChangeCapture" | "onWaiting" | "onWaitingCapture" | "onAuxClick" | "onAuxClickCapture" | "onClick" | "onClickCapture" | "onContextMenu" | "onContextMenuCapture" | "onDoubleClick" | "onDoubleClickCapture" | "onDrag" | "onDragCapture" | "onDragEnd" | "onDragEndCapture" | "onDragEnter" | "onDragEnterCapture" | "onDragExit" | "onDragExitCapture" | "onDragLeave" | "onDragLeaveCapture" | "onDragOver" | "onDragOverCapture" | "onDragStart" | "onDragStartCapture" | "onDrop" | "onDropCapture" | "onMouseDown" | "onMouseDownCapture" | "onMouseEnter" | "onMouseLeave" | "onMouseMove" | "onMouseMoveCapture" | "onMouseOut" | "onMouseOutCapture" | "onMouseOver" | "onMouseOverCapture" | "onMouseUp" | "onMouseUpCapture" | "onSelect" | "onSelectCapture" | "onTouchCancel" | "onTouchCancelCapture" | "onTouchEnd" | "onTouchEndCapture" | "onTouchMove" | "onTouchMoveCapture" | "onTouchStart" | "onTouchStartCapture" | "onPointerDown" | "onPointerDownCapture" | "onPointerMove" | "onPointerMoveCapture" | "onPointerUp" | "onPointerUpCapture" | "onPointerCancel" | "onPointerCancelCapture" | "onPointerEnter" | "onPointerEnterCapture" | "onPointerLeave" | "onPointerLeaveCapture" | "onPointerOver" | "onPointerOverCapture" | "onPointerOut" | "onPointerOutCapture" | "onGotPointerCapture" | "onGotPointerCaptureCapture" | "onLostPointerCapture" | "onLostPointerCaptureCapture" | "onScroll" | "onScrollCapture" | "onWheel" | "onWheelCapture" | "onAnimationStart" | "onAnimationStartCapture" | "onAnimationEnd" | "onAnimationEndCapture" | "onAnimationIteration" | "onAnimationIterationCapture" | "onTransitionEnd" | "onTransitionEndCapture" | "key" | "icon" | "data-testid" | "unsafelyReplaceClassName" | "formMeta" | "formControl" | "additionalText"> & React.RefAttributes<HTMLInputElement>>;
 export {};

package/lib/textarea/SpsTextarea.d.ts

@@ -12,11 +12,12 @@ declare const propTypes: {
     ref: PropTypes.Requireable<React.MutableRefObject<HTMLDivElement>>;
     rows: PropTypes.Requireable<number>;
     value: PropTypes.Requireable<string>;
+    additionalText: PropTypes.Requireable<string>;
     children: PropTypes.Requireable<PropTypes.ReactNodeLike>;
     className: PropTypes.Requireable<string>;
     "data-testid": PropTypes.Requireable<string>;
     unsafelyReplaceClassName: PropTypes.Requireable<string>;
 };
 export declare type SpsTextareaProps = PropTypes.InferTS<typeof propTypes, HTMLTextAreaElement>;
-export declare function SpsTextarea({ className, disabled, formControl, formMeta, id, name, onChange, placeholder, ref, rows, "data-testid": testId, unsafelyReplaceClassName, value, ...rest }: SpsTextareaProps): JSX.Element;
+export declare function SpsTextarea({ className, disabled, formControl, formMeta, id, name, onChange, placeholder, ref, rows, "data-testid": testId, unsafelyReplaceClassName, value, additionalText, ...rest }: SpsTextareaProps): JSX.Element;
 export {};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@spscommerce/ds-react",
   "description": "SPS Design System React components",
-  "version": "5.21.5",
+  "version": "5.22.0",
   "author": "SPS Commerce",
   "license": "UNLICENSED",
   "repository": "https://github.com/spscommerce/design-system/tree/main/packages/@spscommerce/ds-react",
@@ -28,11 +28,11 @@
   },
   "peerDependencies": {
     "@react-stately/collections": "^3.3.3",
-    "@spscommerce/ds-colors": "5.21.5",
-    "@spscommerce/ds-illustrations": "5.21.5",
-    "@spscommerce/ds-shared": "5.21.5",
-    "@spscommerce/positioning": "5.21.5",
-    "@spscommerce/utils": "5.21.5",
+    "@spscommerce/ds-colors": "5.22.0",
+    "@spscommerce/ds-illustrations": "5.22.0",
+    "@spscommerce/ds-shared": "5.22.0",
+    "@spscommerce/positioning": "5.22.0",
+    "@spscommerce/utils": "5.22.0",
     "moment": "^2.25.3",
     "moment-timezone": "^0.5.28",
     "react": "^16.9.0",
@@ -40,11 +40,11 @@
   },
   "devDependencies": {
     "@react-stately/collections": "^3.3.3",
-    "@spscommerce/ds-colors": "5.21.5",
-    "@spscommerce/ds-illustrations": "5.21.5",
-    "@spscommerce/ds-shared": "5.21.5",
-    "@spscommerce/positioning": "5.21.5",
-    "@spscommerce/utils": "5.21.5",
+    "@spscommerce/ds-colors": "5.22.0",
+    "@spscommerce/ds-illustrations": "5.22.0",
+    "@spscommerce/ds-shared": "5.22.0",
+    "@spscommerce/positioning": "5.22.0",
+    "@spscommerce/utils": "5.22.0",
     "@testing-library/react": "^9.3.2",
     "@types/prop-types": "^15.7.1",
     "@types/react": "^16.9.0",