@carbon/ibm-products 2.89.0 → 2.90.0

package/es/components/Saving/Saving.js

@@ -13,7 +13,6 @@ import React, { forwardRef } from "react";
 import PropTypes from "prop-types";
 import { Button, InlineLoading } from "@carbon/react";
 import { CheckmarkOutline, ErrorFilled, ErrorOutline, Save } from "@carbon/react/icons";
-
 //#region src/components/Saving/Saving.tsx
 /**
 * Copyright IBM Corp. 2021, 2024
@@ -79,27 +78,68 @@ const Saving = forwardRef(({ secondaryButtonText, className, defaultIconDescript
 	}, statusObj[status]?.text)));
 });
 Saving.propTypes = {
+	/**
+	* Provide an optional class to be applied to the containing node.
+	*/
 	className: PropTypes.string,
+	/**
+	* Description for default state icon (manual).
+	*/
 	defaultIconDescription: PropTypes.string,
+	/**
+	* Default text for the save button (manual). Per design guidelines you probably don't want to display this in the auto mode.
+	*/
 	defaultText: PropTypes.string,
+	/**
+	* Description for fail state icon (manual).
+	*/
 	failIconDescription: PropTypes.string,
+	/**
+	* Text for failure state.
+	*/
 	failText: PropTypes.string,
+	/**
+	* Description for in progress state icon (manual).
+	*/
 	inProgressIconDescription: PropTypes.string,
+	/**
+	* Text for in progress state.
+	*/
 	inProgressText: PropTypes.string,
+	/**
+	* Function handler for cancel button (manual).
+	*/
 	onRequestCancel: PropTypes.func,
+	/**
+	* Function handler for save button (manual).
+	*/
 	onRequestSave: PropTypes.func,
+	/**
+	* Text for the secondary or cancel button (manual).
+	*/
 	secondaryButtonText: PropTypes.string,
+	/**
+	* The status of the save. default being the untouched default state -> in-progress being a save has been initiated -> fail or success being the outcome.
+	*/
 	status: PropTypes.oneOf([
 		"default",
 		"in-progress",
 		"success",
 		"fail"
 	]).isRequired,
+	/**
+	* Description for success state icon (manual).
+	*/
 	successIconDescription: PropTypes.string,
+	/**
+	* Text for success state
+	*/
 	successText: PropTypes.string,
+	/**
+	* Designates the style of the save component. Manual uses a set of buttons and auto just displays a string. See usage guidelines for additional information.
+	*/
 	type: PropTypes.oneOf(["manual", "auto"]).isRequired
 };
 Saving.displayName = componentName;
-
 //#endregion
-export { Saving };
+export { Saving };

package/es/components/ScrollGradient/ScrollGradient.js

@@ -14,7 +14,6 @@ import { ScrollStates, useIsOverflow } from "./constants.js";
 import React, { useEffect, useRef, useState } from "react";
 import PropTypes from "prop-types";
 import { usePrefix } from "@carbon/react";
-
 //#region src/components/ScrollGradient/ScrollGradient.jsx
 /**
 * Copyright IBM Corp. 2024, 2025
@@ -162,14 +161,24 @@ let ScrollGradient = React.forwardRef(({ children, className, color, onScroll =
 ScrollGradient = pkg.checkComponentEnabled(ScrollGradient, componentName);
 ScrollGradient.displayName = componentName;
 ScrollGradient.propTypes = {
+	/**
+	* Provide the contents of the ScrollGradient.
+	*/
 	children: PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.node), PropTypes.node]),
+	/**
+	* Provide an optional class to be applied to the containing node.
+	*/
 	className: PropTypes.string,
+	/** @type {string} Fade out color. Any valid CSS color value works */
 	color: PropTypes.string,
+	/** @type {(element: HTMLElement) => {}} Optional function to get reference to scrollable DOM element */
 	getScrollElementRef: PropTypes.func,
+	/** @type {boolean} Set to true if you want to hide gradient on the start side (top or left) of scrollable element. */
 	hideStartGradient: PropTypes.bool,
+	/** @type {Function} Optional scroll handler */
 	onScroll: PropTypes.func,
+	/** @type {string} Optional classname for scroll element. */
 	scrollElementClassName: PropTypes.string
 };
-
 //#endregion
-export { ScrollGradient };
+export { ScrollGradient };

package/es/components/ScrollGradient/constants.js

@@ -7,7 +7,6 @@
 
 import { useIsomorphicEffect } from "../../global/js/hooks/useIsomorphicEffect.js";
 import { useCallback, useEffect, useState } from "react";
-
 //#region src/components/ScrollGradient/constants.js
 /**
 * Copyright IBM Corp. 2024
@@ -60,6 +59,5 @@ const useIsOverflow = (ref) => {
 		yScrollable: isVerticallyScrollable
 	};
 };
-
 //#endregion
-export { ScrollStates, useIsOverflow };
+export { ScrollStates, useIsOverflow };

package/es/components/SearchBar/SearchBar.js

@@ -12,7 +12,6 @@ import { getDevtoolsProps } from "../../global/js/utils/devtools.js";
 import React, { useEffect, useState } from "react";
 import PropTypes from "prop-types";
 import { Button, MultiSelect, Search } from "@carbon/react";
-
 //#region src/components/SearchBar/SearchBar.tsx
 /**
 * Copyright IBM Corp. 2024, 2024
@@ -113,25 +112,53 @@ const conditionalScopePropValidator = (props, propName, componentName, ...rest)
 	/**@ts-ignore */
 	return PropTypes.string(props, propName, componentName, ...rest);
 };
-const deprecatedProps = { titleText: PropTypes.string };
+const deprecatedProps = { 
+/**
+* **Deprecated**
+*
+* Provide accessible label text for the scopes MultiSelect.
+*/
+titleText: PropTypes.string };
 SearchBar.propTypes = {
+	/** @type {string} Optional additional class name. */
 	className: PropTypes.string,
+	/** @type {string} The label text for the search text input. */
 	clearButtonLabelText: PropTypes.string.isRequired,
+	/**
+	* Whether or not the scopes MultiSelect label is visually hidden.
+	*/
 	hideScopesLabel: PropTypes.bool,
+	/** @type {string} The label text for the search text input. */
 	labelText: PropTypes.string.isRequired,
+	/** @type {Function} Function handler for when the user changes their query search. */
 	onChange: PropTypes.func,
+	/** @type {Function} Function handler for when the user submits a search. */
 	onSubmit: PropTypes.func,
+	/** @type {string} Placeholder text to be displayed in the search input. */
 	placeholderText: PropTypes.string.isRequired,
+	/** @type {Function} Function to get the text for each scope to display in dropdown. */
 	scopeToString: PropTypes.func,
+	/** @type {Array<any>} Array of allowed search scopes. */
+	/**@ts-ignore */
 	scopes: PropTypes.arrayOf(PropTypes.oneOfType([PropTypes.string, PropTypes.object])),
+	/** @type {string} The name text for the search scope type. */
 	scopesTypeLabel: conditionalScopePropValidator,
+	/** @type {Array<any> Array of initially selected search scopes. */
+	/**@ts-ignore */
 	selectedScopes: PropTypes.arrayOf(PropTypes.oneOfType([PropTypes.string, PropTypes.object])),
+	/**
+	* Optional custom sorting algorithm for an array of scope items.
+	* By default, scope items are sorted in ascending alphabetical order,
+	* with "selected" items moved to the start of the scope items array.
+	*/
 	sortItems: PropTypes.func,
+	/** @type {string} The label text for the search submit button. */
 	submitLabel: PropTypes.string.isRequired,
+	/** @type {func} Callback function for translating MultiSelect's child ListBoxMenuIcon SVG title. */
 	translateWithId: PropTypes.func,
+	/** @type {string} Search query value. */
 	value: PropTypes.string,
 	...deprecatedProps
 };
-
 //#endregion
-export { SearchBar };
+export { SearchBar };

package/es/components/SidePanel/SidePanel.js

@@ -24,7 +24,6 @@ import { Button, Heading, IconButton, Layer, Section } from "@carbon/react";
 import { ArrowLeft, Close } from "@carbon/react/icons";
 import { Resizer } from "@carbon-labs/react-resizer";
 import { moderate02 } from "@carbon/motion";
-
 //#region src/components/SidePanel/SidePanel.tsx
 /**
 * Copyright IBM Corp. 2020, 2025
@@ -488,10 +487,23 @@ const SidePanel = React.forwardRef((props, ref) => {
 	})) : null;
 });
 const deprecatedProps = {
+	/**
+	* **deprecated**
+	*  **Experimental:** Provide a `Slug` component to be rendered inside the `SidePanel` component
+	*/
 	slug: PropTypes.node,
+	/**
+	* **deprecated**
+	* Please use the `decorator` instead
+	* Optional prop that is intended for any scenario where something is being generated by AI to reinforce AI transparency, accountability, and explainability at the UI level.
+	*/
 	aiLabel: PropTypes.node
 };
 SidePanel.propTypes = {
+	/**
+	* Sets the action toolbar buttons
+	*/
+	/**@ts-ignore */
 	actionToolbarButtons: PropTypes.arrayOf(PropTypes.shape({
 		label: PropTypes.string,
 		leading: PropTypes.bool,
@@ -515,6 +527,22 @@ SidePanel.propTypes = {
 			"end"
 		])
 	})),
+	/**
+	* The primary actions to be shown in the side panel. Each action is
+	* specified as an object with optional fields: 'label' to supply the button
+	* label, 'kind' to select the button kind (must be 'primary', 'secondary' or
+	* 'ghost'), 'tooltipPosition' to select where the tooltip is placed around
+	* the button (must be 'top', 'right', 'bottom', or 'left'), 'tooltipAlignment'
+	* to select how the tooltip is aligned with the button (must be 'start',
+	* 'center', or 'end', 'loading' to display a loading indicator, and 'onClick' to
+	* receive notifications when the button is clicked. Additional fields in the
+	* object will be passed to the Button component, and these can include
+	* 'disabled', 'ref', 'className', and any other Button props. Any other
+	* fields in the object will be passed through to the button element as HTML
+	* attributes.
+	*
+	* See https://react.carbondesignsystem.com/?path=/docs/components-button--default#component-api
+	*/
 	actions: allPropTypes([PropTypes.arrayOf(PropTypes.shape({
 		...Button.propTypes,
 		kind: PropTypes.oneOf([
@@ -537,29 +565,104 @@ SidePanel.propTypes = {
 		]),
 		label: PropTypes.string,
 		loading: PropTypes.bool,
+		/**@ts-ignore */
 		onClick: Button.propTypes.onClick
 	}))]),
+	/**
+	* Determines if the title will animate on scroll
+	*/
 	animateTitle: PropTypes.bool,
+	/**
+	* Sets the body content of the side panel
+	*/
 	children: PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.node), PropTypes.node]).isRequired,
+	/**
+	* Sets an optional className to be added to the side panel outermost element
+	*/
 	className: PropTypes.string,
+	/**
+	* Sets the close button icon description
+	*/
 	closeIconDescription: PropTypes.string,
+	/**
+	* Sets the close button tooltip alignment
+	*/
 	closeIconTooltipAlignment: PropTypes.string,
+	/**
+	* Determines whether the side panel should render the condensed version (affects action buttons primarily)
+	*/
 	condensedActions: PropTypes.bool,
+	/**
+	* Sets the current step of the side panel
+	*/
 	currentStep: PropTypes.number,
+	/**
+	* Show/hide the "X" close button.
+	*/
 	hideCloseButton: PropTypes.bool,
+	/**
+	* Unique identifier
+	*/
 	id: PropTypes.string,
+	/**
+	* Determines whether the side panel should render with an overlay
+	*/
 	includeOverlay: PropTypes.bool,
+	/**
+	* Sets the label text which will display above the title text
+	*/
 	labelText: PropTypes.string,
+	/**
+	* Provide a ref to return focus to once the modal is closed.
+	*/
+	/**@ts-ignore */
 	launcherButtonRef: PropTypes.any,
+	/**
+	* Sets the icon description for the navigation back icon button
+	*/
 	navigationBackIconDescription: PropTypes.string,
+	/**
+	* Changes the current side panel page to the previous page
+	*/
 	onNavigationBack: PropTypes.func,
+	/**
+	* Specify a handler for closing the side panel.
+	* This handler closes the modal, e.g. changing `open` prop.
+	*/
 	onRequestClose: PropTypes.func,
+	/**
+	* Optional function called when the side panel exit animation is complete.
+	* This handler can be used for any state cleanup needed before the panel is removed from the DOM.
+	*/
 	onUnmount: PropTypes.func,
+	/**
+	* Determines whether the side panel should render or not
+	*/
 	open: PropTypes.bool.isRequired,
+	/**
+	* Determines if the side panel is on the right or left
+	*/
 	placement: PropTypes.oneOf(["left", "right"]),
+	/**
+	* Prevent closing on click outside of the panel
+	*/
 	preventCloseOnClickOutside: PropTypes.bool,
+	/**
+	* This is the selector to the element that contains all of the page content that will shrink if the panel is a slide in.
+	* This prop is required when using the `slideIn` variant of the side panel.
+	*/
+	/**@ts-ignore*/
 	selectorPageContent: PropTypes.string,
+	/**
+	* Specify a CSS selector that matches the DOM element that should
+	* be focused when the side panel opens
+	*/
+	/**@ts-ignore*/
 	selectorPrimaryFocus: PropTypes.string,
+	/**
+	* Sets the size of the side panel
+	*/
+	/**@ts-ignore*/
 	size: PropTypes.oneOf([
 		"xs",
 		"sm",
@@ -568,12 +671,22 @@ SidePanel.propTypes = {
 		"xl",
 		"2xl"
 	]),
+	/**
+	* Determines if this panel slides in
+	*/
+	/**@ts-ignore*/
 	slideIn: PropTypes.bool,
+	/**
+	* Sets the subtitle text
+	*/
 	subtitle: PropTypes.node,
+	/**
+	* Sets the title text
+	*/
+	/**@ts-ignore*/
 	title: PropTypes.string,
 	...deprecatedProps
 };
 SidePanel.displayName = componentName;
-
 //#endregion
-export { SidePanel };
+export { SidePanel };

package/es/components/SidePanel/constants.js

@@ -20,6 +20,5 @@ const SIDE_PANEL_SIZES = {
 	xl: "65rem",
 	"2xl": "80rem"
 };
-
 //#endregion
-export { SIDE_PANEL_SIZES };
+export { SIDE_PANEL_SIZES };

package/es/components/SimpleHeader/SimpleHeader.js

@@ -13,7 +13,6 @@ import { BreadcrumbWithOverflow } from "../BreadcrumbWithOverflow/BreadcrumbWith
 import React, { useCallback, useEffect } from "react";
 import PropTypes from "prop-types";
 import { Heading, Tooltip } from "@carbon/react";
-
 //#region src/components/SimpleHeader/SimpleHeader.jsx
 /**
 * Copyright IBM Corp. 2023, 2025
@@ -60,20 +59,33 @@ const SimpleHeader = ({ breadcrumbs, className, title, noTrailingSlash = true, m
 	}), title && /* @__PURE__ */ React.createElement(Heading, { className: (0, import_classnames.default)(`${blockClass}__title`) }, title));
 };
 SimpleHeader.propTypes = {
+	/** Header breadcrumbs */
 	breadcrumbs: PropTypes.arrayOf(PropTypes.shape({
+		/** breadcrumb item key */
 		key: PropTypes.string.isRequired,
+		/** breadcrumb item label */
 		label: PropTypes.string.isRequired,
+		/** breadcrumb item link */
 		href: PropTypes.string,
+		/** breadcrumb item title tooltip */
 		title: PropTypes.string,
+		/** Provide if this breadcrumb item represents the current page */
 		isCurrentPage: PropTypes.bool
 	})),
+	/** Header classname */
 	className: PropTypes.string,
+	/**	Maximum visible breadcrumb-items before overflow is used (values less than 1 are treated as 1) */
 	maxVisible: PropTypes.number,
+	/** A prop to omit the trailing slash for the breadcrumbs */
 	noTrailingSlash: PropTypes.bool,
+	/** Label for open/close overflow button used for breadcrumb items that do not fit */
 	overflowAriaLabel: PropTypes.string,
+	/**
+	* overflowTooltipAlign: align tooltip position
+	*/
 	overflowTooltipAlign: Tooltip.propTypes.align,
+	/** Header title */
 	title: PropTypes.string
 };
-
 //#endregion
-export { SimpleHeader };
+export { SimpleHeader };

package/es/components/SingleAddSelect/SingleAddSelect.js

@@ -10,7 +10,6 @@ import { prepareProps } from "../../global/js/utils/props-helper.js";
 import { AddSelect } from "../AddSelect/AddSelect.js";
 import React, { forwardRef } from "react";
 import PropTypes from "prop-types";
-
 //#region src/components/SingleAddSelect/SingleAddSelect.tsx
 const componentName = "SingleAddSelect";
 /**
@@ -38,29 +37,79 @@ const SingleAddSelect = forwardRef((props, ref) => {
 	});
 });
 SingleAddSelect.propTypes = {
+	/**
+	* optional class name
+	*/
+	/**@ts-ignore */
 	className: PropTypes.string,
+	/**
+	* text description that appears under the title
+	*/
 	description: PropTypes.string,
+	/**
+	* label for global search input
+	*/
 	globalSearchLabel: PropTypes.string,
+	/**
+	* placeholder for global search input
+	*/
 	globalSearchPlaceholder: PropTypes.string,
+	/**
+	* object that contains the item data. for more information reference the
+	* "Structuring items" section in the docs tab
+	*/
+	/**@ts-ignore */
 	items: PropTypes.shape({ entries: PropTypes.arrayOf(PropTypes.shape({
 		children: PropTypes.object,
 		id: PropTypes.string.isRequired,
 		title: PropTypes.string.isRequired,
 		value: PropTypes.string.isRequired
 	})) }),
+	/**
+	* label that display above the list of items
+	*/
 	itemsLabel: PropTypes.string,
+	/**
+	* text to display when no results are found from the global search
+	*/
 	noResultsDescription: PropTypes.string,
+	/**
+	* title to display when no results are found from the global search
+	*/
 	noResultsTitle: PropTypes.string,
+	/**
+	* Determines if the component should be rendered within a Tearsheet component
+	*/
 	noTearsheet: PropTypes.bool,
+	/**
+	* function to call when the close button clicked
+	*/
 	onClose: PropTypes.func,
+	/**
+	* text for close button
+	*/
 	onCloseButtonText: PropTypes.string,
+	/**
+	* function to call when the submit button is clicked. returns a selection
+	*/
 	onSubmit: PropTypes.func,
+	/**
+	* text for the submit button
+	*/
 	onSubmitButtonText: PropTypes.string,
+	/**
+	* specifies if the component is open or not
+	*/
 	open: PropTypes.bool,
+	/**
+	* text that displays when displaying filtered items
+	*/
 	searchResultsLabel: PropTypes.string,
+	/**
+	* header text
+	*/
 	title: PropTypes.string
 };
 SingleAddSelect.displayName = componentName;
-
 //#endregion
-export { SingleAddSelect };
+export { SingleAddSelect };

package/es/components/StatusIcon/StatusIcon.js

@@ -12,7 +12,6 @@ import { getDevtoolsProps } from "../../global/js/utils/devtools.js";
 import React, { forwardRef } from "react";
 import PropTypes from "prop-types";
 import { CheckmarkFilled, CheckmarkOutline, ErrorFilled, InProgress, InformationSquareFilled, Misuse, Pending, UndefinedFilled, UnknownFilled, WarningAltFilled, WarningAltInvertedFilled } from "@carbon/react/icons";
-
 //#region src/components/StatusIcon/StatusIcon.tsx
 /**
 * Copyright IBM Corp. 2021, 2022
@@ -279,8 +278,17 @@ const StatusIcon = forwardRef(({ kind, theme, size, className, iconDescription,
 });
 StatusIcon.displayName = componentName;
 StatusIcon.propTypes = {
+	/**
+	* Provide an optional class to be applied to the modal root node.
+	*/
 	className: PropTypes.string,
+	/**
+	* A required prop that provides a title element and tooltip for the icon for accessibility purposes
+	*/
 	iconDescription: PropTypes.string.isRequired,
+	/**
+	* A required prop that displays the respective icon associated with the status
+	*/
 	kind: PropTypes.oneOf([
 		"fatal",
 		"critical",
@@ -294,14 +302,19 @@ StatusIcon.propTypes = {
 		"running",
 		"pending"
 	]).isRequired,
+	/**
+	* A required prop that displays the size of the icon associate with the status
+	*/
 	size: PropTypes.oneOf([
 		"sm",
 		"md",
 		"lg",
 		"xl"
 	]).isRequired,
+	/**
+	* A required prop that displays the theme of the icon associated with the status
+	*/
 	theme: PropTypes.oneOf(["light", "dark"]).isRequired
 };
-
 //#endregion
-export { StatusIcon };
+export { StatusIcon };

package/es/components/StatusIndicator/StatusIndicator.js

@@ -13,7 +13,6 @@ import React from "react";
 import PropTypes from "prop-types";
 import { Button } from "@carbon/react";
 import { Restart } from "@carbon/react/icons";
-
 //#region src/components/StatusIndicator/StatusIndicator.jsx
 /**
 * Copyright IBM Corp. 2024, 2024
@@ -53,13 +52,32 @@ StatusIndicator.deprecated = {
 StatusIndicator = pkg.checkComponentEnabled(StatusIndicator, componentName);
 StatusIndicator.displayName = componentName;
 StatusIndicator.propTypes = {
+	/**
+	* Provide the contents of the StatusIndicator.
+	*/
 	children: PropTypes.node.isRequired,
+	/**
+	* Provide an optional class to be applied to the containing node.
+	*/
 	className: PropTypes.string,
+	/**
+	* Optional callback function for the retry button.
+	*/
 	onRetry: PropTypes.func,
+	/**
+	* The text for the retry button.
+	*/
 	retryLabel: PropTypes.string,
+	/**
+	* Set to `true` to show the retry button.
+	*
+	* `retryLabel` and `onRetry` must also be defined.
+	*/
 	showRetry: PropTypes.bool,
+	/**
+	* The title that appears at the top of the list.
+	*/
 	title: PropTypes.node
 };
-
 //#endregion
-export { StatusIndicator };
+export { StatusIndicator };

package/es/components/StatusIndicator/StatusIndicatorStep.js

@@ -13,7 +13,6 @@ import React from "react";
 import PropTypes from "prop-types";
 import { InlineLoading } from "@carbon/react";
 import { CheckmarkOutline, CircleStroke, ErrorOutline } from "@carbon/react/icons";
-
 //#region src/components/StatusIndicator/StatusIndicatorStep.jsx
 /**
 * Copyright IBM Corp. 2024, 2024
@@ -47,9 +46,21 @@ StatusIndicatorStep.deprecated = {
 StatusIndicatorStep = pkg.checkComponentEnabled(StatusIndicatorStep, componentName);
 StatusIndicatorStep.displayName = componentName;
 StatusIndicatorStep.propTypes = {
+	/**
+	* Provide an optional class to be applied to the containing node.
+	*/
 	className: PropTypes.string,
+	/**
+	* The text associated with the icon.
+	*/
 	description: PropTypes.string.isRequired,
+	/**
+	* This message will appear below the description if the `status` is "error".
+	*/
 	errorMessage: PropTypes.string,
+	/**
+	* Each `status` represents a different icon..
+	*/
 	status: PropTypes.oneOf([
 		"inactive",
 		"active",
@@ -57,6 +68,5 @@ StatusIndicatorStep.propTypes = {
 		"finished"
 	]).isRequired
 };
-
 //#endregion
-export { StatusIndicatorStep };
+export { StatusIndicatorStep };

package/es/components/StringFormatter/StringFormatter.js

@@ -15,7 +15,6 @@ import { StringFormatterAlignment, deprecated_StringFormatterAlignment, propMapp
 import React, { useRef, useState } from "react";
 import PropTypes from "prop-types";
 import { DefinitionTooltip } from "@carbon/react";
-
 //#region src/components/StringFormatter/StringFormatter.jsx
 /**
 * Copyright IBM Corp. 2024, 2024
@@ -103,13 +102,20 @@ StringFormatter.validateAlignment = () => (props, propName, componentName) => {
 	}
 };
 StringFormatter.propTypes = {
+	/**
+	* Provide an optional class to be applied to the containing node.
+	*/
 	className: PropTypes.string,
+	/** Number of lines to clamp value. */
 	lines: PropTypes.number,
+	/** Specify the direction of the tooltip. Can be either top or bottom. */
 	tooltipDirection: allPropTypes([StringFormatter.validateAlignment(), PropTypes.oneOf(Object.values(deprecated_StringFormatterAlignment), Object.values(StringFormatterAlignment))]),
+	/** Whether or not the value should be truncated. if it exceeds lines. */
 	truncate: PropTypes.bool,
+	/** Value to format. */
 	value: PropTypes.string.isRequired,
+	/** Maximum width of value which should include */
 	width: PropTypes.string
 };
-
 //#endregion
-export { StringFormatter };
+export { StringFormatter };

package/es/components/StringFormatter/utils/enums.js

@@ -52,6 +52,5 @@ const propMappingFunction = (deprecatedValue) => {
 		[deprecated_StringFormatterAlignment.RIGHT_START]: StringFormatterAlignment.RIGHT_START
 	}[deprecatedValue];
 };
-
 //#endregion
-export { StringFormatterAlignment, deprecated_StringFormatterAlignment, propMappingFunction };
+export { StringFormatterAlignment, deprecated_StringFormatterAlignment, propMappingFunction };