@carbon/react 1.110.0 → 1.111.0-rc.0

package/lib/components/Tag/DismissibleTag.js

@@ -17,10 +17,10 @@ const require_index = require("../AILabel/index.js");
 const require_mergeRefs = require("../../tools/mergeRefs.js");
 const require_isEllipsisActive = require("./isEllipsisActive.js");
 const require_Tag = require("./Tag.js");
-let react = require("react");
-react = require_runtime.__toESM(react);
 let classnames = require("classnames");
 classnames = require_runtime.__toESM(classnames);
+let react = require("react");
+react = require_runtime.__toESM(react);
 let prop_types = require("prop-types");
 prop_types = require_runtime.__toESM(prop_types);
 let react_jsx_runtime = require("react/jsx-runtime");
@@ -99,9 +99,21 @@ const DismissibleTag = (0, react.forwardRef)(({ className, decorator, disabled,
 	});
 });
 DismissibleTag.propTypes = {
+	/**
+	* Provide a custom className that is applied to the containing <span>
+	*/
 	className: prop_types.default.string,
+	/**
+	* **Experimental:** Provide a `decorator` component to be rendered inside the `DismissibleTag` component
+	*/
 	decorator: prop_types.default.node,
+	/**
+	* Specify if the `DismissibleTag` is disabled
+	*/
 	disabled: prop_types.default.bool,
+	/**
+	* Specify the tooltip alignment for the dismiss button
+	*/
 	dismissTooltipAlignment: prop_types.default.oneOf([
 		"top",
 		"bottom",
@@ -116,15 +128,46 @@ DismissibleTag.propTypes = {
 		"right-end",
 		"right-start"
 	]),
+	/**
+	* Provide a custom tooltip label for the dismiss button
+	*/
 	dismissTooltipLabel: prop_types.default.string,
+	/**
+	* Specify the id for the tag.
+	*/
 	id: prop_types.default.string,
+	/**
+	* Click handler for filter tag close button.
+	*/
 	onClose: prop_types.default.func,
+	/**
+	* A component used to render an icon.
+	*/
 	renderIcon: prop_types.default.oneOfType([prop_types.default.func, prop_types.default.object]),
+	/**
+	* Specify the size of the Tag. Currently supports either `sm`,
+	* `md` (default) or `lg` sizes.
+	*/
 	size: prop_types.default.oneOf(Object.keys(require_Tag.SIZES)),
+	/**
+	* **Experimental:** Provide a `Slug` component to be rendered inside the `DismissibleTag` component
+	*/
 	slug: require_deprecate.deprecate(prop_types.default.node, "The `slug` prop has been deprecated and will be removed in the next major version. Use the decorator prop instead."),
+	/**
+	* Provide text to be rendered inside of a the tag.
+	*/
 	text: prop_types.default.string,
+	/**
+	* Provide a custom `title` to be inserted in the tag.
+	*/
 	tagTitle: prop_types.default.string,
+	/**
+	* Text to show on clear filters
+	*/
 	title: prop_types.default.string,
+	/**
+	* Specify the type of the `Tag`
+	*/
 	type: prop_types.default.oneOf(Object.keys(require_Tag.TYPES))
 };
 //#endregion

package/lib/components/Tag/OperationalTag.js

@@ -14,10 +14,10 @@ const require_Tooltip = require("../Tooltip/Tooltip.js");
 const require_mergeRefs = require("../../tools/mergeRefs.js");
 const require_isEllipsisActive = require("./isEllipsisActive.js");
 const require_Tag = require("./Tag.js");
-let react = require("react");
-react = require_runtime.__toESM(react);
 let classnames = require("classnames");
 classnames = require_runtime.__toESM(classnames);
+let react = require("react");
+react = require_runtime.__toESM(react);
 let prop_types = require("prop-types");
 prop_types = require_runtime.__toESM(prop_types);
 let react_jsx_runtime = require("react/jsx-runtime");
@@ -93,12 +93,34 @@ const OperationalTag = (0, react.forwardRef)(({ className, disabled, id, renderI
 	});
 });
 OperationalTag.propTypes = {
+	/**
+	* Provide a custom className that is applied to the containing <span>
+	*/
 	className: prop_types.default.string,
+	/**
+	* Specify if the `OperationalTag` is disabled
+	*/
 	disabled: prop_types.default.bool,
+	/**
+	* Specify the id for the tag.
+	*/
 	id: prop_types.default.string,
+	/**
+	* A component used to render an icon.
+	*/
 	renderIcon: prop_types.default.oneOfType([prop_types.default.func, prop_types.default.object]),
+	/**
+	* Specify the size of the Tag. Currently supports either `sm`,
+	* `md` (default) or `lg` sizes.
+	*/
 	size: prop_types.default.oneOf(Object.keys(require_Tag.SIZES)),
+	/**
+	* Provide text to be rendered inside of a the tag.
+	*/
 	text: prop_types.default.string,
+	/**
+	* Specify the type of the `Tag`
+	*/
 	type: prop_types.default.oneOf(Object.keys(TYPES))
 };
 //#endregion

package/lib/components/Tag/SelectableTag.js

@@ -15,10 +15,10 @@ const require_mergeRefs = require("../../tools/mergeRefs.js");
 const require_useControllableState = require("../../internal/useControllableState.js");
 const require_isEllipsisActive = require("./isEllipsisActive.js");
 const require_Tag = require("./Tag.js");
-let react = require("react");
-react = require_runtime.__toESM(react);
 let classnames = require("classnames");
 classnames = require_runtime.__toESM(classnames);
+let react = require("react");
+react = require_runtime.__toESM(react);
 let prop_types = require("prop-types");
 prop_types = require_runtime.__toESM(prop_types);
 let react_jsx_runtime = require("react/jsx-runtime");
@@ -92,15 +92,46 @@ const SelectableTag = (0, react.forwardRef)(({ className, disabled, id, renderIc
 	});
 });
 SelectableTag.propTypes = {
+	/**
+	* Provide a custom className that is applied to the containing <span>
+	*/
 	className: prop_types.default.string,
+	/**
+	* Specify if the `SelectableTag` is disabled
+	*/
 	disabled: prop_types.default.bool,
+	/**
+	* Specify the id for the tag.
+	*/
 	id: prop_types.default.string,
+	/**
+	* A component used to render an icon.
+	*/
 	renderIcon: prop_types.default.oneOfType([prop_types.default.func, prop_types.default.object]),
+	/**
+	* Provide an optional hook that is called when selected is changed
+	*/
 	onChange: prop_types.default.func,
+	/**
+	* Provide an optional function to be called when the tag is clicked.
+	*/
 	onClick: prop_types.default.func,
+	/**
+	* Specify the state of the selectable tag.
+	*/
 	selected: prop_types.default.bool,
+	/**
+	* Specify the default state of the selectable tag.
+	*/
 	defaultSelected: prop_types.default.bool,
+	/**
+	* Specify the size of the Tag. Currently supports either `sm`,
+	* `md` (default) or `lg` sizes.
+	*/
 	size: prop_types.default.oneOf(Object.keys(require_Tag.SIZES)),
+	/**
+	* Provide text to be rendered inside of a the tag.
+	*/
 	text: prop_types.default.string
 };
 //#endregion

package/lib/components/Tag/Tag.Skeleton.js

@@ -7,10 +7,10 @@
 
 const require_runtime = require("../../_virtual/_rolldown/runtime.js");
 const require_usePrefix = require("../../internal/usePrefix.js");
-let react = require("react");
-react = require_runtime.__toESM(react);
 let classnames = require("classnames");
 classnames = require_runtime.__toESM(classnames);
+let react = require("react");
+react = require_runtime.__toESM(react);
 let prop_types = require("prop-types");
 prop_types = require_runtime.__toESM(prop_types);
 let react_jsx_runtime = require("react/jsx-runtime");
@@ -32,7 +32,14 @@ function TagSkeleton({ className, size, ...rest }) {
 	});
 }
 TagSkeleton.propTypes = {
+	/**
+	* Specify an optional className to add.
+	*/
 	className: prop_types.default.string,
+	/**
+	* Specify the size of the Tag. Currently supports either `sm` or
+	* default sizes.
+	*/
 	size: prop_types.default.oneOf(["sm"])
 };
 //#endregion

package/lib/components/Tag/Tag.js

@@ -16,10 +16,10 @@ const require_useMergedRefs = require("../../internal/useMergedRefs.js");
 const require_DefinitionTooltip = require("../Tooltip/DefinitionTooltip.js");
 const require_index = require("../AILabel/index.js");
 const require_isEllipsisActive = require("./isEllipsisActive.js");
-let react = require("react");
-react = require_runtime.__toESM(react);
 let classnames = require("classnames");
 classnames = require_runtime.__toESM(classnames);
+let react = require("react");
+react = require_runtime.__toESM(react);
 let prop_types = require("prop-types");
 prop_types = require_runtime.__toESM(prop_types);
 let react_jsx_runtime = require("react/jsx-runtime");
@@ -150,18 +150,59 @@ const Tag = react.default.forwardRef(({ children, className, decorator, id, type
 	});
 });
 Tag.propTypes = {
+	/**
+	* Provide an alternative tag or component to use instead of the default
+	* wrapping element
+	*/
 	as: prop_types.default.elementType,
+	/**
+	* Provide content to be rendered inside of a `Tag`
+	*/
 	children: prop_types.default.node,
+	/**
+	* Provide a custom className that is applied to the containing <span>
+	*/
 	className: prop_types.default.string,
+	/**
+	* **Experimental:** Provide a `decorator` component to be rendered inside the `Tag` component
+	*/
 	decorator: prop_types.default.node,
+	/**
+	* Specify if the `Tag` is disabled
+	*/
 	disabled: prop_types.default.bool,
+	/**
+	* Determine if `Tag` is a filter/chip
+	*/
 	filter: require_deprecate.deprecate(prop_types.default.bool, "The `filter` prop has been deprecated and will be removed in the next major version. Use DismissibleTag instead."),
+	/**
+	* Specify the id for the tag.
+	*/
 	id: prop_types.default.string,
+	/**
+	* Click handler for filter tag close button.
+	*/
 	onClose: require_deprecate.deprecate(prop_types.default.func, "The `onClose` prop has been deprecated and will be removed in the next major version. Use DismissibleTag instead."),
+	/**
+	* A component used to render an icon.
+	*/
 	renderIcon: prop_types.default.oneOfType([prop_types.default.func, prop_types.default.object]),
+	/**
+	* Specify the size of the Tag. Currently supports either `sm`,
+	* `md` (default) or `lg` sizes.
+	*/
 	size: prop_types.default.oneOf(Object.keys(SIZES)),
+	/**
+	* **Experimental:** Provide a `Slug` component to be rendered inside the `Tag` component
+	*/
 	slug: require_deprecate.deprecate(prop_types.default.node, "The `slug` prop has been deprecated and will be removed in the next major version. Use the decorator prop instead."),
+	/**
+	* Text to show on clear filters
+	*/
 	title: require_deprecate.deprecate(prop_types.default.string, "The `title` prop has been deprecated and will be removed in the next major version. Use DismissibleTag instead."),
+	/**
+	* Specify the type of the `Tag`
+	*/
 	type: prop_types.default.oneOf(Object.keys(TYPES))
 };
 //#endregion

package/lib/components/Text/Text.js

@@ -52,12 +52,22 @@ const Text = (0, react.forwardRef)(({ as, children, dir = "auto", ...rest }, ref
 	});
 });
 Text.propTypes = {
+	/**
+	* Provide a custom element type used to render the outermost node
+	*/
 	as: prop_types.default.oneOfType([
 		prop_types.default.func,
 		prop_types.default.string,
 		prop_types.default.elementType
 	]),
+	/**
+	* Provide child elements or text to be rendered inside of this component
+	*/
 	children: prop_types.default.node,
+	/**
+	* Specify the text direction to be used for this component and any of its
+	* children
+	*/
 	dir: prop_types.default.oneOf([
 		"ltr",
 		"rtl",

package/lib/components/Text/TextDirection.js

@@ -36,12 +36,23 @@ const TextDirection = ({ children, dir = "auto", getTextDirection }) => {
 	});
 };
 TextDirection.propTypes = {
+	/**
+	* Provide children to be rendered inside of this component
+	*/
 	children: prop_types.default.node,
+	/**
+	* Specify the text direction for rendered children
+	*/
 	dir: prop_types.default.oneOf([
 		"ltr",
 		"rtl",
 		"auto"
 	]),
+	/**
+	* Optionally provide a custom function to get the text direction for a piece
+	* of text. Whatever is returned will become the value of the `dir` attribute
+	* on a node of text. Should return one of: 'ltr', 'rtl', or 'auto'
+	*/
 	getTextDirection: prop_types.default.func
 };
 //#endregion

package/lib/components/Text/TextDirectionContext.js

@@ -5,7 +5,6 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-require("../../_virtual/_rolldown/runtime.js");
 //#region src/components/Text/TextDirectionContext.ts
 /**
 * Copyright IBM Corp. 2016, 2026

package/lib/components/TextArea/TextArea.Skeleton.js

@@ -7,10 +7,10 @@
 
 const require_runtime = require("../../_virtual/_rolldown/runtime.js");
 const require_usePrefix = require("../../internal/usePrefix.js");
-let react = require("react");
-react = require_runtime.__toESM(react);
 let classnames = require("classnames");
 classnames = require_runtime.__toESM(classnames);
+let react = require("react");
+react = require_runtime.__toESM(react);
 let prop_types = require("prop-types");
 prop_types = require_runtime.__toESM(prop_types);
 let react_jsx_runtime = require("react/jsx-runtime");
@@ -31,7 +31,13 @@ const TextAreaSkeleton = (props) => {
 	});
 };
 TextAreaSkeleton.propTypes = {
+	/**
+	* Specify an optional className to add to the form item wrapper.
+	*/
 	className: prop_types.default.string,
+	/**
+	* Specify whether the label should be hidden, or not
+	*/
 	hideLabel: prop_types.default.bool
 };
 //#endregion

package/lib/components/TextArea/TextArea.js

@@ -6,11 +6,11 @@
  */
 
 const require_runtime = require("../../_virtual/_rolldown/runtime.js");
-const require_noopFn = require("../../internal/noopFn.js");
 const require_usePrefix = require("../../internal/usePrefix.js");
 const require_Text = require("../Text/Text.js");
 const require_useIsomorphicEffect = require("../../internal/useIsomorphicEffect.js");
 const require_useId = require("../../internal/useId.js");
+const require_noopFn = require("../../internal/noopFn.js");
 const require_deprecate = require("../../prop-types/deprecate.js");
 const require_utils = require("../../internal/utils.js");
 const require_useMergedRefs = require("../../internal/useMergedRefs.js");
@@ -18,10 +18,10 @@ const require_hasHelperText = require("../../internal/hasHelperText.js");
 const require_index = require("../AILabel/index.js");
 const require_FormContext = require("../FluidForm/FormContext.js");
 const require_getAnnouncement = require("../../internal/getAnnouncement.js");
-let react = require("react");
-react = require_runtime.__toESM(react);
 let classnames = require("classnames");
 classnames = require_runtime.__toESM(classnames);
+let react = require("react");
+react = require_runtime.__toESM(react);
 let prop_types = require("prop-types");
 prop_types = require_runtime.__toESM(prop_types);
 let react_jsx_runtime = require("react/jsx-runtime");
@@ -301,30 +301,110 @@ const TextArea = (0, react.forwardRef)((props, forwardRef) => {
 });
 TextArea.displayName = "TextArea";
 TextArea.propTypes = {
+	/**
+	* Provide a custom className that is applied to the wrapper node
+	*/
 	className: prop_types.default.string,
+	/**
+	* Specify the `cols` attribute for the underlying `<textarea>` node
+	*/
 	cols: prop_types.default.number,
+	/**
+	* Specify the method used for calculating the counter number
+	*/
 	counterMode: prop_types.default.oneOf(["character", "word"]),
+	/**
+	* **Experimental**: Provide a `decorator` component to be rendered inside the `TextArea` component
+	*/
 	decorator: prop_types.default.node,
+	/**
+	* Optionally provide the default value of the `<textarea>`
+	*/
 	defaultValue: prop_types.default.oneOfType([prop_types.default.string, prop_types.default.number]),
+	/**
+	* Specify whether the control is disabled
+	*/
 	disabled: prop_types.default.bool,
+	/**
+	* Specify whether to display the counter
+	*/
 	enableCounter: prop_types.default.bool,
+	/**
+	* Provide text that is used alongside the control label for additional help
+	*/
 	helperText: prop_types.default.node,
+	/**
+	* Specify whether you want the underlying label to be visually hidden
+	*/
 	hideLabel: prop_types.default.bool,
+	/**
+	* Provide a unique identifier for the control
+	*/
 	id: prop_types.default.string,
+	/**
+	* Specify whether the control is currently invalid
+	*/
 	invalid: prop_types.default.bool,
+	/**
+	* Provide the text that is displayed when the control is in an invalid state
+	*/
 	invalidText: prop_types.default.node,
+	/**
+	* Provide the text that will be read by a screen reader when visiting this
+	* control
+	*/
 	labelText: prop_types.default.node.isRequired,
+	/**
+	* `true` to use the light version. For use on $ui-01 backgrounds only.
+	* Don't use this to make tile background color same as container background color.
+	*/
 	light: require_deprecate.deprecate(prop_types.default.bool, "The `light` prop for `TextArea` has been deprecated in favor of the new `Layer` component. It will be removed in the next major release."),
+	/**
+	* Max entity count allowed for the textarea. This is needed in order for enableCounter to display
+	*/
 	maxCount: prop_types.default.number,
+	/**
+	* Optionally provide an `onChange` handler that is called whenever `<textarea>`
+	* is updated
+	*/
 	onChange: prop_types.default.func,
+	/**
+	* Optionally provide an `onClick` handler that is called whenever the
+	* `<textarea>` is clicked
+	*/
 	onClick: prop_types.default.func,
+	/**
+	* Optionally provide an `onKeyDown` handler that is called whenever `<textarea>`
+	* is keyed
+	*/
 	onKeyDown: prop_types.default.func,
+	/**
+	* Specify the placeholder attribute for the `<textarea>`
+	*/
 	placeholder: prop_types.default.string,
+	/**
+	* Whether the textarea should be read-only
+	*/
 	readOnly: prop_types.default.bool,
+	/**
+	* Specify the rows attribute for the `<textarea>`
+	*/
 	rows: prop_types.default.number,
+	/**
+	* **Experimental**: Provide a `Slug` component to be rendered inside the `TextArea` component
+	*/
 	slug: require_deprecate.deprecate(prop_types.default.node, "The `slug` prop for `TextArea` has been deprecated in favor of the new `decorator` prop. It will be removed in the next major release."),
+	/**
+	* Provide the current value of the `<textarea>`
+	*/
 	value: prop_types.default.oneOfType([prop_types.default.string, prop_types.default.number]),
+	/**
+	* Specify whether the control is currently in warning state
+	*/
 	warn: prop_types.default.bool,
+	/**
+	* Provide the text that is displayed when the control is in warning state
+	*/
 	warnText: prop_types.default.node
 };
 //#endregion

package/lib/components/TextInput/ControlledPasswordInput.js

@@ -6,16 +6,16 @@
  */
 
 const require_runtime = require("../../_virtual/_rolldown/runtime.js");
-const require_noopFn = require("../../internal/noopFn.js");
 const require_usePrefix = require("../../internal/usePrefix.js");
 const require_useId = require("../../internal/useId.js");
+const require_noopFn = require("../../internal/noopFn.js");
 const require_deprecate = require("../../prop-types/deprecate.js");
 const require_hasHelperText = require("../../internal/hasHelperText.js");
 const require_util = require("./util.js");
-let react = require("react");
-react = require_runtime.__toESM(react);
 let classnames = require("classnames");
 classnames = require_runtime.__toESM(classnames);
+let react = require("react");
+react = require_runtime.__toESM(react);
 let prop_types = require("prop-types");
 prop_types = require_runtime.__toESM(prop_types);
 let react_jsx_runtime = require("react/jsx-runtime");
@@ -110,37 +110,101 @@ const ControlledPasswordInput = (0, react.forwardRef)(({ labelText, className, i
 });
 ControlledPasswordInput.displayName = "ControlledPasswordInput";
 ControlledPasswordInput.propTypes = {
+	/**
+	* Provide a custom className that is applied directly to the underlying
+	* `<input>` node
+	*/
 	className: prop_types.default.string,
+	/**
+	* Optionally provide the default value of the `<input>`
+	*/
 	defaultValue: prop_types.default.oneOfType([prop_types.default.string, prop_types.default.number]),
+	/**
+	* Specify whether the control is disabled
+	*/
 	disabled: prop_types.default.bool,
+	/**
+	* Provide text that is used alongside the control label for additional help
+	*/
 	helperText: prop_types.default.node,
+	/**
+	* Specify whether or not the underlying label is visually hidden
+	*/
 	hideLabel: prop_types.default.bool,
+	/**
+	* "Hide password" tooltip text on password visibility toggle
+	*/
 	hidePasswordLabel: prop_types.default.string,
+	/**
+	* Provide a unique identifier for the input field
+	*/
 	id: prop_types.default.string.isRequired,
+	/**
+	* Specify whether the control is currently invalid
+	*/
 	invalid: prop_types.default.bool,
+	/**
+	* Provide the text that is displayed when the control is in an invalid state
+	*/
 	invalidText: prop_types.default.node,
+	/**
+	* Provide the text that will be read by a screen reader when visiting this
+	* control
+	*/
 	labelText: prop_types.default.node.isRequired,
+	/**
+	* `true` to use the light version. For use on $ui-01 backgrounds only.
+	* Don't use this to make tile background color same as container background color.
+	*/
 	light: require_deprecate.deprecate(prop_types.default.bool, "The `light` prop for `ControlledPasswordInput` has been deprecated in favor of the new `Layer` component. It will be removed in the next major release."),
+	/**
+	* Optionally provide an `onChange` handler that is called whenever `<input>`
+	* is updated
+	*/
 	onChange: prop_types.default.func,
+	/**
+	* Optionally provide an `onClick` handler that is called whenever the
+	* `<input>` is clicked
+	*/
 	onClick: prop_types.default.func,
+	/**
+	* Specify the placeholder attribute for the `<input>`
+	*/
 	placeholder: prop_types.default.string,
+	/**
+	* "Show password" tooltip text on password visibility toggle
+	*/
 	showPasswordLabel: prop_types.default.string,
+	/**
+	* Specify the size of the Text Input.
+	*/
 	size: prop_types.default.oneOf([
 		"sm",
 		"md",
 		"lg"
 	]),
+	/**
+	* Specify the alignment of the tooltip to the icon-only button.
+	* Can be one of: start, center, or end.
+	*/
 	tooltipAlignment: prop_types.default.oneOf([
 		"start",
 		"center",
 		"end"
 	]),
+	/**
+	* Specify the direction of the tooltip for icon-only buttons.
+	* Can be either top, right, bottom, or left.
+	*/
 	tooltipPosition: prop_types.default.oneOf([
 		"top",
 		"right",
 		"bottom",
 		"left"
 	]),
+	/**
+	* Provide the current value of the `<input>`
+	*/
 	value: prop_types.default.oneOfType([prop_types.default.string, prop_types.default.number])
 };
 //#endregion