carbon-react 116.2.2 → 117.1.0

package/lib/components/textbox/textbox.component.js

@@ -41,6 +41,8 @@ var _box = _interopRequireDefault(require("../box"));
 
 var _logger = _interopRequireDefault(require("../../__internal__/utils/logger"));
 
+var _guid = _interopRequireDefault(require("../../__internal__/utils/helpers/guid"));
+
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
 function _getRequireWildcardCache() { if (typeof WeakMap !== "function") return null; var cache = new WeakMap(); _getRequireWildcardCache = function () { return cache; }; return cache; }
@@ -66,6 +68,7 @@ const Textbox = /*#__PURE__*/_react.default.forwardRef(({
   labelSpacing,
   id,
   formattedValue,
+  inputHint,
   fieldHelp,
   error,
   warning,
@@ -102,13 +105,11 @@ const Textbox = /*#__PURE__*/_react.default.forwardRef(({
   "data-role": dataRole,
   enforceCharacterLimit = true,
   characterLimit,
-  warnOverLimit = false,
   helpAriaLabel,
   ...props
 }, ref) => {
   const characterCountValue = typeof value === "string" ? value : "";
-  const [maxLength, characterCount] = (0, _useCharacterCount.default)(characterCountValue, // TODO: Can be removed after the characterLimit type is changed to number
-  typeof characterLimit === "string" ? parseInt(characterLimit, 10) : characterLimit, warnOverLimit, enforceCharacterLimit);
+  const [maxLength, characterCount, characterCountHintId, characterCountHint] = (0, _useCharacterCount.default)(characterCountValue, characterLimit, enforceCharacterLimit);
   const {
     validationRedesignOptIn
   } = (0, _react.useContext)(_carbonProvider.NewValidationContext);
@@ -139,6 +140,12 @@ const Textbox = /*#__PURE__*/_react.default.forwardRef(({
     label,
     fieldHelp
   });
+  const hintId = (0, _react.useRef)((0, _guid.default)());
+  const characterCountHintIdValue = characterCount ? characterCountHintId : undefined;
+  const inputHintIdValue = inputHint ? hintId.current : undefined;
+  const hintIdValue = characterLimit ? characterCountHintIdValue : inputHintIdValue;
+  const ariaDescribedByValues = [validationRedesignOptIn ? undefined : ariaDescribedBy, hintIdValue];
+  const ariaDescribedByValue = ariaDescribedByValues.filter(Boolean).join(" ");
   const hasIconInside = !!(inputIcon || validationIconId && !validationOnLabel);
 
   const input = /*#__PURE__*/_react.default.createElement(_input.InputPresentation, {
@@ -162,7 +169,7 @@ const Textbox = /*#__PURE__*/_react.default.forwardRef(({
     align: align,
     "aria-invalid": !!error,
     "aria-labelledby": ariaLabelledBy,
-    "aria-describedby": validationRedesignOptIn ? undefined : ariaDescribedBy,
+    "aria-describedby": ariaDescribedByValue,
     autoFocus: autoFocus,
     deferTimeout: deferTimeout,
     disabled: disabled,
@@ -224,7 +231,10 @@ const Textbox = /*#__PURE__*/_react.default.forwardRef(({
     "data-element": dataElement,
     validationIconId: validationRedesignOptIn ? undefined : validationIconId,
     validationRedesignOptIn: validationRedesignOptIn
-  }, (0, _utils.filterStyledSystemMarginProps)(props)), validationRedesignOptIn && labelHelp && /*#__PURE__*/_react.default.createElement(_textbox.StyledHintText, null, labelHelp), validationRedesignOptIn ? /*#__PURE__*/_react.default.createElement(_box.default, {
+  }, (0, _utils.filterStyledSystemMarginProps)(props)), characterLimit || inputHint ? /*#__PURE__*/_react.default.createElement(_textbox.StyledInputHint, {
+    id: hintIdValue,
+    "data-element": "input-hint"
+  }, characterCountHint || inputHint) : null, validationRedesignOptIn && labelHelp && /*#__PURE__*/_react.default.createElement(_textbox.StyledHintText, null, labelHelp), validationRedesignOptIn ? /*#__PURE__*/_react.default.createElement(_box.default, {
     position: "relative"
   }, /*#__PURE__*/_react.default.createElement(_validationMessage.default, {
     error: error,
@@ -297,7 +307,7 @@ Textbox.propTypes = {
   "autoFocus": _propTypes.default.bool,
   "autoSave": _propTypes.default.string,
   "capture": _propTypes.default.oneOfType([_propTypes.default.oneOf(["environment", "user"]), _propTypes.default.bool]),
-  "characterLimit": _propTypes.default.oneOfType([_propTypes.default.number, _propTypes.default.string]),
+  "characterLimit": _propTypes.default.number,
   "checked": _propTypes.default.bool,
   "children": _propTypes.default.node,
   "className": _propTypes.default.string,
@@ -341,6 +351,7 @@ Textbox.propTypes = {
   "id": _propTypes.default.string,
   "info": _propTypes.default.oneOfType([_propTypes.default.string, _propTypes.default.bool]),
   "inlist": _propTypes.default.any,
+  "inputHint": _propTypes.default.string,
   "inputIcon": _propTypes.default.oneOf(["add", "admin", "alert_on", "alert", "analysis", "arrow_bottom_right_circle", "arrow_down", "arrow_left_boxed", "arrow_left_right_small", "arrow_left_small", "arrow_left", "arrow_right_small", "arrow_right", "arrow_top_left_circle", "arrow_up", "arrow", "arrows_left_right", "attach", "bank_with_card", "bank", "basket_with_squares", "basket", "bed", "bin", "block_arrow_right", "blocked_square", "blocked", "bold", "box_arrow_left", "boxed_shapes", "bulk_destroy", "bullet_list_dotted", "bullet_list_numbers", "bullet_list", "business", "calendar_today", "calendar", "call", "camera", "car_lock", "car_money", "car_repair", "card_view", "caret_down", "caret_large_down", "caret_large_left", "caret_large_right", "caret_large_up", "caret_left", "caret_right", "caret_up", "cart", "cash", "chart_bar", "chart_line", "chart_pie", "chat_notes", "chat", "chevron_down_thick", "chevron_down", "chevron_left_thick", "chevron_left", "chevron_right_thick", "chevron_right", "chevron_up_thick", "chevron_up", "circle_with_dots", "circles_connection", "clock", "close", "coins", "collaborate", "computer_clock", "connect", "construction", "contacts", "copy", "create", "credit_card_slash", "credit_card", "cross_circle", "cross", "csv", "dashboard", "delete", "delivery", "disconnect", "disputed", "document_right_align", "document_tick", "document_vertical_lines", "download", "draft", "drag_vertical", "drag", "drill", "dropdown", "duplicate", "edit", "edited", "ellipsis_horizontal", "ellipsis_vertical", "email_switch", "email", "entry", "envelope_dollar", "envelope_euro", "error_square", "error", "euro", "expand", "factory", "favourite_lined", "favourite", "fax", "feedback", "file_excel", "file_generic", "file_image", "file_pdf", "file_word", "files_leaning", "filter_new", "filter", "fit_height", "fit_width", "flag", "folder", "form_refresh", "gift", "go", "graduation_hat", "graph", "grid", "hand_cash_coins", "hand_cash_note", "help", "hide", "home", "image", "in_progress", "in_transit", "individual", "info", "italic", "key", "laptop", "ledger_arrow_left", "ledger_arrow_right", "ledger", "lightbulb_off", "lightbulb_on", "link", "list_view", "location", "locked", "logout", "lookup", "marker", "message", "minus_large", "minus", "mobile", "money_bag", "none", "old_warning", "palm_tree", "pause_circle", "pause", "pdf", "people_switch", "people", "percentage_boxed", "person_info", "person_tick", "person", "petrol_pump", "phone", "piggy_bank", "plane", "play_circle", "play", "plus_large", "plus", "pound", "print", "progress", "progressed", "question_hollow", "question_mark", "question", "refresh_clock", "refresh", "remove", "sage_coin", "save", "scan", "search", "services", "settings_old", "settings", "share", "shop", "sort_down", "sort_up", "spanner", "split_container", "split", "square_dot", "squares_nine", "stacked_boxes", "stacked_squares", "submitted", "sync", "tag", "talk", "theatre_masks", "three_boxes", "tick_circle", "tick_thick", "tick", "true_tick", "u_turn_left", "u_turn_right", "undo", "unlocked", "upload", "uploaded", "video", "view", "warning"]),
   "inputMode": _propTypes.default.oneOf(["decimal", "email", "none", "numeric", "search", "tel", "text", "url"]),
   "inputRef": _propTypes.default.func,
@@ -764,7 +775,6 @@ Textbox.propTypes = {
   "value": _propTypes.default.oneOfType([_propTypes.default.arrayOf(_propTypes.default.string), _propTypes.default.number, _propTypes.default.string]),
   "vocab": _propTypes.default.string,
   "warning": _propTypes.default.oneOfType([_propTypes.default.string, _propTypes.default.bool]),
-  "warnOverLimit": _propTypes.default.bool,
   "width": _propTypes.default.oneOfType([_propTypes.default.number, _propTypes.default.string])
 };
 Textbox.displayName = "Textbox";

package/lib/components/textbox/textbox.style.d.ts

@@ -1,5 +1,6 @@
 declare const ErrorBorder: import("styled-components").StyledComponent<"span", any, {
     warning: boolean;
 }, never>;
-declare const StyledHintText: import("styled-components").StyledComponent<"p", any, {}, never>;
-export { StyledHintText, ErrorBorder };
+declare const StyledInputHint: import("styled-components").StyledComponent<"p", any, {}, never>;
+declare const StyledHintText: import("styled-components").StyledComponent<"div", any, {}, never>;
+export { StyledHintText, ErrorBorder, StyledInputHint };

package/lib/components/textbox/textbox.style.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.ErrorBorder = exports.StyledHintText = void 0;
+exports.StyledInputHint = exports.ErrorBorder = exports.StyledHintText = void 0;
 
 var _styledComponents = _interopRequireWildcard(require("styled-components"));
 
@@ -25,7 +25,16 @@ const ErrorBorder = _styledComponents.default.span`
     `}
 `;
 exports.ErrorBorder = ErrorBorder;
-const StyledHintText = _styledComponents.default.p`
+const StyledInputHint = _styledComponents.default.p`
+  display: block;
+  flex: 1;
+  margin-top: -3px;
+  margin-bottom: 8px;
+  color: var(--colorsUtilityYin055);
+  white-space: pre-wrap;
+`;
+exports.StyledInputHint = StyledInputHint;
+const StyledHintText = _styledComponents.default.div`
   margin-top: 0px;
   margin-bottom: 8px;
   color: var(--colorsUtilityYin055);

package/lib/hooks/__internal__/useCharacterCount/useCharacterCount.d.ts

@@ -1,3 +1,8 @@
 /// <reference types="react" />
-declare const useCharacterCount: (value?: string, characterLimit?: number | undefined, warnOverLimit?: boolean, enforceCharacterLimit?: boolean) => [number | undefined, JSX.Element | null];
+declare const useCharacterCount: (value?: string, characterLimit?: number | undefined, enforceCharacterLimit?: boolean) => [
+    number | undefined,
+    JSX.Element | null,
+    string | undefined,
+    string | null
+];
 export default useCharacterCount;

package/lib/hooks/__internal__/useCharacterCount/useCharacterCount.js

@@ -11,17 +11,19 @@ var _characterCount = _interopRequireDefault(require("../../../__internal__/char
 
 var _useLocale = _interopRequireDefault(require("../useLocale"));
 
+var _guid = _interopRequireDefault(require("../../../__internal__/utils/helpers/guid"));
+
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
 function _getRequireWildcardCache() { if (typeof WeakMap !== "function") return null; var cache = new WeakMap(); _getRequireWildcardCache = function () { return cache; }; return cache; }
 
 function _interopRequireWildcard(obj) { if (obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
 
-const getFormatNumber = (value, locale) => new Intl.NumberFormat(locale).format(value);
-
-const useCharacterCount = (value = "", characterLimit, warnOverLimit = false, enforceCharacterLimit = true) => {
+const useCharacterCount = (value = "", characterLimit, enforceCharacterLimit = true) => {
   const isCharacterLimitValid = typeof characterLimit === "number" && !Number.isNaN(characterLimit);
   const l = (0, _useLocale.default)();
+  const hintString = l.characterCount.hintString();
+  const hintId = (0, _react.useRef)((0, _guid.default)());
   const isOverLimit = (0, _react.useMemo)(() => {
     if (value && isCharacterLimitValid) {
       return value.length > characterLimit;
@@ -30,11 +32,11 @@ const useCharacterCount = (value = "", characterLimit, warnOverLimit = false, en
     return false;
   }, [value, characterLimit, isCharacterLimitValid]);
   return [enforceCharacterLimit && isCharacterLimitValid ? characterLimit : undefined, isCharacterLimitValid ? /*#__PURE__*/_react.default.createElement(_characterCount.default, {
-    isOverLimit: isOverLimit && warnOverLimit,
-    value: getFormatNumber(value.length, l.locale()),
-    limit: getFormatNumber(characterLimit, l.locale()),
+    isOverLimit: isOverLimit,
+    value: value.length,
+    limit: characterLimit,
     "data-element": "character-limit"
-  }) : null];
+  }) : null, hintId.current, isCharacterLimitValid ? hintString : null];
 };
 
 var _default = useCharacterCount;

package/lib/locales/en-gb.js

@@ -25,6 +25,11 @@ const enGB = {
     no: () => "No",
     yes: () => "Yes"
   },
+  characterCount: {
+    hintString: () => "Input contains a character counter",
+    tooManyCharacters: (count, formattedCount) => count === 1 ? `You have ${formattedCount} character too many` : `You have ${formattedCount} characters too many`,
+    charactersLeft: (count, formattedCount) => count === 1 ? `You have ${formattedCount} character remaining` : `You have ${formattedCount} characters remaining`
+  },
   date: {
     dateFnsLocale: () => _dateFnsLocales.enGB
   },

package/lib/locales/locale.d.ts

@@ -11,6 +11,11 @@ interface Locale {
     batchSelection: {
         selected: (count: number | string) => string;
     };
+    characterCount: {
+        hintString: () => string;
+        tooManyCharacters: (count: number, formattedCount: string) => string;
+        charactersLeft: (count: number, formattedCount: string) => string;
+    };
     confirm: {
         no: () => string;
         yes: () => string;

package/lib/locales/pl-pl.d.ts

@@ -1,3 +1,5 @@
 import Locale from "./locale";
+export declare const PolishPlural: (singularNominativ: string, pluralNominativ: string, pluralGenitive: string, value: number) => string;
 declare const plPL: Locale;
+export { PolishPlural as PolishPlurals };
 export default plPL;

package/lib/locales/pl-pl.js

@@ -3,12 +3,25 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.default = void 0;
+exports.default = exports.PolishPlurals = exports.PolishPlural = void 0;
 
 var _dateFnsLocales = require("./date-fns-locales");
 
 const isSingular = count => (typeof count === "string" ? parseInt(count) : count) === 1;
 
+const PolishPlural = (singularNominativ, pluralNominativ, pluralGenitive, value) => {
+  if (value === 1) {
+    return singularNominativ;
+  }
+
+  if (value % 10 >= 2 && value % 10 <= 4 && (value % 100 < 10 || value % 100 >= 20)) {
+    return pluralNominativ;
+  }
+
+  return pluralGenitive;
+};
+
+exports.PolishPlurals = exports.PolishPlural = PolishPlural;
 const plPL = {
   locale: () => "pl-PL",
   actions: {
@@ -25,6 +38,11 @@ const plPL = {
     no: () => "Nie",
     yes: () => "Tak"
   },
+  characterCount: {
+    hintString: () => "Pole zawiera licznik znaków",
+    tooManyCharacters: (count, formattedCount) => `Masz o ${formattedCount} ${PolishPlural("znak", "znaki", "znaków", count)} za dużo`,
+    charactersLeft: (count, formattedCount) => `Masz ${formattedCount} ${PolishPlural("pozostały", "pozostałe", "pozostałych", count)} ${PolishPlural("znak", "znaki", "znaków", count)}`
+  },
   date: {
     dateFnsLocale: () => _dateFnsLocales.pl
   },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "carbon-react",
-  "version": "116.2.2",
+  "version": "117.1.0",
   "description": "A library of reusable React components for easily building user interfaces.",
   "files": [
     "lib",