@carbon/react 1.110.0 → 1.111.0-rc.0

package/lib/components/Dialog/Dialog.js

@@ -6,10 +6,10 @@
  */
 
 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_useId = require("../../internal/useId.js");
+const require_noopFn = require("../../internal/noopFn.js");
 const require_deprecate = require("../../prop-types/deprecate.js");
 const require_index = require("../IconButton/index.js");
 const require_index$1 = require("../Button/index.js");
@@ -17,10 +17,10 @@ const require_index$2 = require("../ButtonSet/index.js");
 const require_useResizeObserver = require("../../internal/useResizeObserver.js");
 const require_index$3 = require("../Layer/index.js");
 const require_InlineLoading = require("../InlineLoading/InlineLoading.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");
@@ -108,18 +108,59 @@ const Dialog = react.default.forwardRef(({ children, className, focusAfterCloseR
 });
 Dialog.displayName = "Dialog";
 Dialog.propTypes = {
+	/**
+	* Provide children to be rendered inside of the Dialog
+	*/
 	children: prop_types.default.node,
+	/**
+	* Specify an optional className to be applied to the modal root node
+	*/
 	className: prop_types.default.string,
+	/**
+	* Provide a ref to return focus to once the dialog is closed.
+	*/
 	focusAfterCloseRef: prop_types.default.oneOfType([prop_types.default.func, prop_types.default.shape({ current: prop_types.default.any })]),
+	/**
+	* Modal specifies whether the Dialog is modal or non-modal. This cannot be
+	* changed while open=true
+	*/
 	modal: prop_types.default.bool,
+	/**
+	* Specify a handler for closing Dialog.
+	* The handler should care of closing Dialog, e.g. changing `open` prop.
+	*/
 	onRequestClose: prop_types.default.func,
+	/**
+	* open initial state
+	*/
 	open: prop_types.default.bool,
+	/**
+	* Specify the role of the dialog for accessibility
+	*/
 	role: prop_types.default.oneOf(["dialog", "alertdialog"]),
+	/**
+	* Specify a label for screen readers
+	*/
 	"aria-label": prop_types.default.string,
+	/**
+	* Specify the ID of an element that labels this dialog
+	*/
 	"aria-labelledby": prop_types.default.string,
+	/**
+	* Specify the ID of an element that describes this dialog
+	*/
 	"aria-describedby": prop_types.default.string,
+	/**
+	* Specify a label for screen readers
+	*/
 	ariaLabel: require_deprecate.deprecate(prop_types.default.string, "This prop syntax has been deprecated. Please use the new `aria-label`"),
+	/**
+	* Specify the ID of an element that labels this dialog
+	*/
 	ariaLabelledBy: require_deprecate.deprecate(prop_types.default.string, "This prop syntax has been deprecated. Please use the new `aria-labelledby`"),
+	/**
+	* Specify the ID of an element that describes this dialog
+	*/
 	ariaDescribedBy: require_deprecate.deprecate(prop_types.default.string, "This prop syntax has been deprecated. Please use the new `aria-describedby`")
 };
 const DialogHeader = react.default.forwardRef(({ children, ...rest }, ref) => {
@@ -131,7 +172,11 @@ const DialogHeader = react.default.forwardRef(({ children, ...rest }, ref) => {
 	});
 });
 DialogHeader.displayName = "DialogHeader";
-DialogHeader.propTypes = { children: prop_types.default.node };
+DialogHeader.propTypes = { 
+/**
+* Provide the contents to be rendered inside of this component
+*/
+children: prop_types.default.node };
 const DialogControls = react.default.forwardRef(({ children, ...rest }, ref) => {
 	return /* @__PURE__ */ (0, react_jsx_runtime.jsx)("div", {
 		className: `${require_usePrefix.usePrefix()}--dialog__header-controls`,
@@ -141,7 +186,11 @@ const DialogControls = react.default.forwardRef(({ children, ...rest }, ref) =>
 	});
 });
 DialogControls.displayName = "DialogControls";
-DialogControls.propTypes = { children: prop_types.default.node };
+DialogControls.propTypes = { 
+/**
+* Provide children to be rendered inside of this component
+*/
+children: prop_types.default.node };
 const DialogCloseButton = react.default.forwardRef(({ onClick, ...rest }, ref) => {
 	const prefix = require_usePrefix.usePrefix();
 	return /* @__PURE__ */ (0, react_jsx_runtime.jsx)(require_index.IconButton, {
@@ -163,7 +212,11 @@ const DialogCloseButton = react.default.forwardRef(({ onClick, ...rest }, ref) =
 	});
 });
 DialogCloseButton.displayName = "DialogCloseButton";
-DialogCloseButton.propTypes = { onClick: prop_types.default.func };
+DialogCloseButton.propTypes = { 
+/**
+* Specify a click handler applied to the IconButton
+*/
+onClick: prop_types.default.func };
 const DialogTitle = react.default.forwardRef(({ children, className, id, ...rest }, ref) => {
 	const prefix = require_usePrefix.usePrefix();
 	const { dialogId, setTitleId } = (0, react.useContext)(DialogContext);
@@ -184,8 +237,17 @@ const DialogTitle = react.default.forwardRef(({ children, className, id, ...rest
 });
 DialogTitle.displayName = "DialogTitle";
 DialogTitle.propTypes = {
+	/**
+	* Provide the contents to be rendered inside of this component
+	*/
 	children: prop_types.default.node,
+	/**
+	* Specify an optional className to be applied to the title node
+	*/
 	className: prop_types.default.string,
+	/**
+	* Specify an optional id for the title element
+	*/
 	id: prop_types.default.string
 };
 const DialogSubtitle = react.default.forwardRef(({ children, className, id, ...rest }, ref) => {
@@ -208,8 +270,17 @@ const DialogSubtitle = react.default.forwardRef(({ children, className, id, ...r
 });
 DialogSubtitle.displayName = "DialogSubtitle";
 DialogSubtitle.propTypes = {
+	/**
+	* Provide the contents to be rendered inside of this component
+	*/
 	children: prop_types.default.node,
+	/**
+	* Specify an optional className to be applied to the subtitle node
+	*/
 	className: prop_types.default.string,
+	/**
+	* Specify an optional id for the subtitle element
+	*/
 	id: prop_types.default.string
 };
 const DialogBody = react.default.forwardRef(({ children, className, hasScrollingContent, ...rest }, ref) => {
@@ -248,8 +319,17 @@ const DialogBody = react.default.forwardRef(({ children, className, hasScrolling
 });
 DialogBody.displayName = "DialogBody";
 DialogBody.propTypes = {
+	/**
+	* Provide the contents to be rendered inside of this component
+	*/
 	children: prop_types.default.node,
+	/**
+	* Specify an optional className to be applied to the body node
+	*/
 	className: prop_types.default.string,
+	/**
+	* Specify whether the content has overflow that should be scrollable
+	*/
 	hasScrollingContent: prop_types.default.bool
 };
 const DialogFooter = react.default.forwardRef(({ children, className, onRequestClose = require_noopFn.noopFn, onSecondarySubmit, onRequestSubmit = require_noopFn.noopFn, primaryButtonText = "Save", primaryButtonDisabled = false, secondaryButtonText = "Cancel", secondaryButtons, loadingStatus = "inactive", loadingDescription, loadingIconDescription, onLoadingSuccess = require_noopFn.noopFn, danger = false, dangerDescription = "", ...rest }, ref) => {
@@ -316,14 +396,41 @@ const DialogFooter = react.default.forwardRef(({ children, className, onRequestC
 });
 DialogFooter.displayName = "DialogFooter";
 DialogFooter.propTypes = {
+	/**
+	* Provide the contents to be rendered inside of this component
+	*/
 	children: prop_types.default.node,
+	/**
+	* Specify an optional className to be applied to the footer node
+	*/
 	className: prop_types.default.string,
+	/**
+	* Specify a handler for closing dialog.
+	*/
 	onRequestClose: prop_types.default.func,
+	/**
+	* Specify a handler for the secondary button.
+	*/
 	onSecondarySubmit: prop_types.default.func,
+	/**
+	* Specify a handler for submitting dialog.
+	*/
 	onRequestSubmit: prop_types.default.func,
+	/**
+	* Specify the text for the primary button
+	*/
 	primaryButtonText: prop_types.default.node,
+	/**
+	* Specify whether the Button should be disabled, or not
+	*/
 	primaryButtonDisabled: prop_types.default.bool,
+	/**
+	* Specify the text for the secondary button
+	*/
 	secondaryButtonText: prop_types.default.node,
+	/**
+	* Specify an array of config objects for secondary buttons
+	*/
 	secondaryButtons: (props, propName, componentName) => {
 		if (props.secondaryButtons) {
 			if (!Array.isArray(props.secondaryButtons) || props.secondaryButtons.length !== 2) return /* @__PURE__ */ new Error(`${propName} needs to be an array of two button config objects`);
@@ -337,16 +444,36 @@ DialogFooter.propTypes = {
 		}
 		return null;
 	},
+	/**
+	* Specify whether the Dialog is for dangerous actions
+	*/
 	danger: prop_types.default.bool,
+	/**
+	* Specify the message read by screen readers for the danger primary button.
+	* Defaults to an empty string; provide localized text to opt in.
+	*/
 	dangerDescription: prop_types.default.string,
+	/**
+	* Specify loading status
+	*/
 	loadingStatus: prop_types.default.oneOf([
 		"inactive",
 		"active",
 		"finished",
 		"error"
 	]),
+	/**
+	* Specify the description for the loading text
+	*/
 	loadingDescription: prop_types.default.string,
+	/**
+	* Specify the description for the loading icon
+	*/
 	loadingIconDescription: prop_types.default.string,
+	/**
+	* Provide an optional handler to be invoked when loading is
+	* successful
+	*/
 	onLoadingSuccess: prop_types.default.func
 };
 //#endregion

package/lib/components/Dropdown/Dropdown.Skeleton.js

@@ -8,10 +8,10 @@
 const require_runtime = require("../../_virtual/_rolldown/runtime.js");
 const require_usePrefix = require("../../internal/usePrefix.js");
 const require_ListBoxPropTypes = require("../ListBox/ListBoxPropTypes.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,8 +31,17 @@ const DropdownSkeleton = ({ className, size, hideLabel, ...rest }) => {
 	});
 };
 DropdownSkeleton.propTypes = {
+	/**
+	* Specify an optional className to add.
+	*/
 	className: prop_types.default.string,
+	/**
+	* Specify whether the label should be hidden, or not
+	*/
 	hideLabel: prop_types.default.bool,
+	/**
+	* Specify the size of the ListBox.
+	*/
 	size: require_ListBoxPropTypes.ListBoxSizePropType
 };
 //#endregion

package/lib/components/Dropdown/Dropdown.js

@@ -17,10 +17,10 @@ const require_ListBoxPropTypes = require("../ListBox/ListBoxPropTypes.js");
 const require_FormContext = require("../FluidForm/FormContext.js");
 const require_index$2 = require("../ListBox/index.js");
 const require_mergeRefs = require("../../tools/mergeRefs.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");
@@ -317,43 +317,152 @@ const Dropdown = react.default.forwardRef(({ autoAlign = false, className: conta
 });
 Dropdown.displayName = "Dropdown";
 Dropdown.propTypes = {
+	/**
+	* 'aria-label' of the ListBox component.
+	* Specify a label to be read by screen readers on the container node
+	*/
 	["aria-label"]: prop_types.default.string,
+	/**
+	* Deprecated, please use `aria-label` instead.
+	* Specify a label to be read by screen readers on the container note.
+	*/
 	ariaLabel: require_deprecate.deprecate(prop_types.default.string, "This prop syntax has been deprecated. Please use the new `aria-label`."),
+	/**
+	* **Experimental**: Will attempt to automatically align the floating element
+	* to avoid collisions with the viewport and being clipped by ancestor
+	* elements. Requires React v17+
+	* @see https://github.com/carbon-design-system/carbon/issues/18714
+	*/
 	autoAlign: prop_types.default.bool,
+	/**
+	* Provide a custom className to be applied on the cds--dropdown node
+	*/
 	className: prop_types.default.string,
+	/**
+	* **Experimental**: Provide a `decorator` component to be rendered inside the `Dropdown` component
+	*/
 	decorator: prop_types.default.node,
+	/**
+	* Specify the direction of the dropdown. Can be either top or bottom.
+	*/
 	direction: prop_types.default.oneOf(["top", "bottom"]),
+	/**
+	* Disable the control
+	*/
 	disabled: prop_types.default.bool,
+	/**
+	* Additional props passed to Downshift.
+	*
+	* **Use with caution:** anything you define here overrides the components'
+	* internal handling of that prop. Downshift APIs and internals are subject to
+	* change, and in some cases they can not be shimmed by Carbon to shield you
+	* from potentially breaking changes.
+	*/
 	downshiftProps: prop_types.default.object,
+	/**
+	* Provide helper text that is used alongside the control label for
+	* additional help
+	*/
 	helperText: prop_types.default.node,
+	/**
+	* Specify whether the title text should be hidden or not
+	*/
 	hideLabel: prop_types.default.bool,
+	/**
+	* Specify a custom `id`
+	*/
 	id: prop_types.default.string.isRequired,
+	/**
+	* Allow users to pass in an arbitrary item or a string (in case their items are an array of strings)
+	* from their collection that are pre-selected
+	*/
 	initialSelectedItem: prop_types.default.oneOfType([
 		prop_types.default.object,
 		prop_types.default.string,
 		prop_types.default.number
 	]),
+	/**
+	* Specify if the currently selected value is invalid.
+	*/
 	invalid: prop_types.default.bool,
+	/**
+	* Message which is displayed if the value is invalid.
+	*/
 	invalidText: prop_types.default.node,
+	/**
+	* Renders an item as a custom React node instead of a string.
+	*/
 	itemToElement: prop_types.default.func,
+	/**
+	* Helper function passed to downshift that allows the library to render a
+	* given item to a string label. By default, it extracts the `label` field
+	* from a given item to serve as the item label in the list.
+	*/
 	itemToString: prop_types.default.func,
+	/**
+	* We try to stay as generic as possible here to allow individuals to pass
+	* in a collection of whatever kind of data structure they prefer
+	*/
 	items: prop_types.default.array.isRequired,
+	/**
+	* Generic `label` that will be used as the textual representation of what
+	* this field is for
+	*/
 	label: prop_types.default.node.isRequired,
+	/**
+	* `true` to use the light version.
+	*/
 	light: require_deprecate.deprecate(prop_types.default.bool, "The `light` prop for `Dropdown` has been deprecated in favor of the new `Layer` component. It will be removed in the next major release."),
+	/**
+	* `onChange` is a utility for this controlled component to communicate to a
+	* consuming component what kind of internal state changes are occurring.
+	*/
 	onChange: prop_types.default.func,
+	/**
+	* Whether or not the Dropdown is readonly
+	*/
 	readOnly: prop_types.default.bool,
+	/**
+	* An optional callback to render the currently selected item as a react element instead of only
+	* as a string.
+	*/
 	renderSelectedItem: prop_types.default.func,
+	/**
+	* In the case you want to control the dropdown selection entirely.
+	*/
 	selectedItem: prop_types.default.oneOfType([
 		prop_types.default.object,
 		prop_types.default.string,
 		prop_types.default.number
 	]),
+	/**
+	* Specify the size of the ListBox. Currently supports either `xs`, `sm`, `md` or `lg` as an option.
+	*/
 	size: require_ListBoxPropTypes.ListBoxSizePropType,
+	/**
+	* **Experimental**: Provide a `Slug` component to be rendered inside the `Dropdown` component
+	*/
 	slug: require_deprecate.deprecate(prop_types.default.node, "The `slug` prop for `Dropdown` has been deprecated in favor of the new `decorator` prop. It will be removed in the next major release."),
+	/**
+	* Provide the title text that will be read by a screen reader when
+	* visiting this control
+	*/
 	titleText: prop_types.default.node.isRequired,
+	/**
+	* Translates component strings using your i18n tool.
+	*/
 	translateWithId: prop_types.default.func,
+	/**
+	* The dropdown type, `default` or `inline`
+	*/
 	type: require_ListBoxPropTypes.ListBoxTypePropType,
+	/**
+	* 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/ErrorBoundary/ErrorBoundaryContext.js

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

package/lib/components/ExpandableSearch/ExpandableSearch.js

@@ -13,10 +13,10 @@ const require_events = require("../../tools/events.js");
 const require_mergeRefs = require("../../tools/mergeRefs.js");
 const require_utils = require("../Search/utils.js");
 const require_index = require("../Search/index.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 react_jsx_runtime = require("react/jsx-runtime");
 //#region src/components/ExpandableSearch/ExpandableSearch.tsx
 /**

package/lib/components/FeatureFlags/index.js

@@ -69,6 +69,9 @@ const FeatureFlags = ({ children, flags = {}, enableV12TileDefaultIcons = false,
 };
 FeatureFlags.propTypes = {
 	children: prop_types.default.node,
+	/**
+	* Provide the feature flags to enabled or disabled in the current Rea,ct tree
+	*/
 	flags: require_deprecate.deprecate(prop_types.default.objectOf(prop_types.default.bool), "The `flags` prop for `FeatureFlag` has been deprecated. Please run the `featureflag-deprecate-flags-prop` codemod to migrate to individual boolean props.npx @carbon/upgrade migrate featureflag-deprecate-flags-prop --write"),
 	enableV12TileDefaultIcons: prop_types.default.bool,
 	enableV12TileRadioIcons: prop_types.default.bool,

package/lib/components/FileUploader/FileUploader.Skeleton.js

@@ -9,10 +9,10 @@ const require_runtime = require("../../_virtual/_rolldown/runtime.js");
 const require_usePrefix = require("../../internal/usePrefix.js");
 const require_index = require("../SkeletonText/index.js");
 const require_Button_Skeleton = require("../Button/Button.Skeleton.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");
@@ -41,6 +41,10 @@ function FileUploaderSkeleton({ className, ...rest }) {
 		]
 	});
 }
-FileUploaderSkeleton.propTypes = { className: prop_types.default.string };
+FileUploaderSkeleton.propTypes = { 
+/**
+* Specify an optional className to add.
+*/
+className: prop_types.default.string };
 //#endregion
 exports.default = FileUploaderSkeleton;

package/lib/components/FileUploader/FileUploader.js

@@ -15,10 +15,10 @@ const require_index = require("../FeatureFlags/index.js");
 const require_Button = require("../Button/Button.js");
 const require_Filename = require("./Filename.js");
 const require_FileUploaderButton = require("./FileUploaderButton.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");
@@ -258,26 +258,83 @@ const FileUploader = (0, react.forwardRef)(({ accept, buttonKind, buttonLabel, c
 });
 FileUploader.displayName = "FileUploader";
 FileUploader.propTypes = {
+	/**
+	* Specify the types of files that this input should be able to receive
+	*/
 	accept: prop_types.default.arrayOf(prop_types.default.string),
+	/**
+	* Specify the type of the `<FileUploaderButton>`
+	*/
 	buttonKind: prop_types.default.oneOf(require_Button.ButtonKinds),
+	/**
+	* Provide the label text to be read by screen readers when interacting with
+	* the `<FileUploaderButton>`
+	*/
 	buttonLabel: prop_types.default.string,
+	/**
+	* Provide a custom className to be applied to the container node
+	*/
 	className: prop_types.default.string,
+	/**
+	* Specify whether file input is disabled
+	*/
 	disabled: prop_types.default.bool,
+	/**
+	* Specify the status of the File Upload
+	*/
 	filenameStatus: prop_types.default.oneOf([
 		"edit",
 		"complete",
 		"uploading"
 	]).isRequired,
+	/**
+	* Provide a description for the complete/close icon that can be read by screen readers
+	*/
 	iconDescription: prop_types.default.string,
+	/**
+	* Specify the description text of this `<FileUploader>`
+	*/
 	labelDescription: prop_types.default.string,
+	/**
+	* Specify the title text of this `<FileUploader>`
+	*/
 	labelTitle: prop_types.default.string,
+	/**
+	* Maximum file size allowed in bytes. Files larger than this will be marked invalid
+	*/
 	maxFileSize: prop_types.default.number,
+	/**
+	* Specify if the component should accept multiple files to upload
+	*/
 	multiple: prop_types.default.bool,
+	/**
+	* Provide a name for the underlying `<input>` node
+	*/
 	name: prop_types.default.string,
+	/**
+	* Event handler that is called after files are added to the uploader
+	* The event handler signature looks like `onAddFiles(evt, { addedFiles })`
+	*/
 	onAddFiles: prop_types.default.func,
+	/**
+	* Provide an optional `onChange` hook that is called each time the input is
+	* changed
+	*/
 	onChange: prop_types.default.func,
+	/**
+	* Provide an optional `onClick` hook that is called each time the
+	* FileUploader is clicked
+	*/
 	onClick: prop_types.default.func,
+	/**
+	* Provide an optional `onDelete` hook that is called when an uploaded item
+	* is removed
+	*/
 	onDelete: prop_types.default.func,
+	/**
+	* Specify the size of the FileUploaderButton, from a list of available
+	* sizes.
+	*/
 	size: prop_types.default.oneOf([
 		"sm",
 		"small",