@carbon/react 1.110.0 → 1.111.0-rc.0

package/lib/components/FileUploader/FileUploaderButton.js

@@ -6,17 +6,17 @@
  */
 
 const require_runtime = require("../../_virtual/_rolldown/runtime.js");
-const require_noopFn = require("../../internal/noopFn.js");
 const require_usePrefix = require("../../internal/usePrefix.js");
 const require_keys = require("../../internal/keyboard/keys.js");
 const require_match = require("../../internal/keyboard/match.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_Button = require("../Button/Button.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");
@@ -100,23 +100,70 @@ function FileUploaderButton({ accept, buttonKind = "primary", className, disable
 	] });
 }
 FileUploaderButton.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 underlying button
+	*/
 	buttonKind: prop_types.default.oneOf(require_Button.ButtonKinds),
+	/**
+	* Provide a custom className to be applied to the container node
+	*/
 	className: prop_types.default.string,
+	/**
+	* Specify whether you want to disable any updates to the FileUploaderButton
+	* label
+	*/
 	disableLabelChanges: prop_types.default.bool,
+	/**
+	* Specify whether file input is disabled
+	*/
 	disabled: prop_types.default.bool,
+	/**
+	* Provide a unique id for the underlying `<input>` node
+	*/
 	id: prop_types.default.string,
+	/**
+	* Provide the label text to be read by screen readers when interacting with
+	* this control
+	*/
 	labelText: prop_types.default.node,
+	/**
+	* 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,
+	/**
+	* Provide an optional `onChange` hook that is called each time the `<input>`
+	* value changes
+	*/
 	onChange: prop_types.default.func,
+	/**
+	* Provide an optional `onClick` hook that is called each time the button is
+	* clicked
+	*/
 	onClick: prop_types.default.func,
+	/**
+	* Provide an accessibility role for the `<FileUploaderButton>`
+	*/
 	role: prop_types.default.string,
+	/**
+	* Specify the size of the FileUploaderButton, from a list of available
+	* sizes.
+	*/
 	size: prop_types.default.oneOf([
 		"sm",
 		"md",
 		"lg"
 	]),
+	/**
+	* Provide a custom tabIndex value for the `<FileUploaderButton>`
+	*/
 	tabIndex: require_deprecate.deprecate(prop_types.default.number, "The `tabIndex` prop for `FileUploaderButton` has been deprecated since it now renders a button element by default.")
 };
 //#endregion

package/lib/components/FileUploader/FileUploaderDropContainer.js

@@ -6,17 +6,17 @@
  */
 
 const require_runtime = require("../../_virtual/_rolldown/runtime.js");
-const require_noopFn = require("../../internal/noopFn.js");
 const require_usePrefix = require("../../internal/usePrefix.js");
 const require_keys = require("../../internal/keyboard/keys.js");
 const require_match = require("../../internal/keyboard/match.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_events = require("../../tools/events.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");
@@ -139,18 +139,60 @@ function FileUploaderDropContainer({ accept = [], className, id, disabled, label
 	});
 }
 FileUploaderDropContainer.propTypes = {
+	/**
+	* Specify the types of files that this input should be able to receive
+	*/
 	accept: prop_types.default.arrayOf(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,
+	/**
+	* Provide a unique id for the underlying `<input>` node
+	*/
 	id: prop_types.default.string,
+	/**
+	* Provide the label text to be read by screen readers when interacting with
+	* this control
+	*/
 	labelText: prop_types.default.string.isRequired,
+	/**
+	* 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 function to be called when the button element
+	* is clicked
+	*/
 	onClick: prop_types.default.func,
+	/**
+	* Provide a custom regex pattern for the acceptedTypes
+	*/
 	pattern: prop_types.default.string,
+	/**
+	* Provide an accessibility role for the `<FileUploaderButton>`
+	*/
 	role: require_deprecate.deprecate(prop_types.default.number, "The `role` prop for `FileUploaderButton` has been deprecated since it now renders a button element by default, and has an implicit role of button."),
+	/**
+	* Provide a custom tabIndex value for the `<FileUploaderButton>`
+	*/
 	tabIndex: require_deprecate.deprecate(prop_types.default.number, "The `tabIndex` prop for `FileUploaderButton` has been deprecated since it now renders a button element by default.")
 };
 //#endregion

package/lib/components/FileUploader/FileUploaderItem.js

@@ -6,19 +6,19 @@
  */
 
 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_keys = require("../../internal/keyboard/keys.js");
 const require_match = require("../../internal/keyboard/match.js");
 const require_useIsomorphicEffect = require("../../internal/useIsomorphicEffect.js");
 const require_useId = require("../../internal/useId.js");
+const require_noopFn = require("../../internal/noopFn.js");
 const require_Tooltip = require("../Tooltip/Tooltip.js");
 const require_Filename = require("./Filename.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");
@@ -131,22 +131,51 @@ function FileUploaderItem({ uuid, name, status = "uploading", iconDescription, o
 	});
 }
 FileUploaderItem.propTypes = {
+	/**
+	* Error message body for an invalid file upload
+	*/
 	errorBody: prop_types.default.string,
+	/**
+	* Error message subject for an invalid file upload
+	*/
 	errorSubject: prop_types.default.string,
+	/**
+	* Description of status icon (displayed in native tooltip)
+	*/
 	iconDescription: prop_types.default.string,
+	/**
+	* Specify if the currently uploaded file is invalid
+	*/
 	invalid: prop_types.default.bool,
+	/**
+	* Name of the uploaded file
+	*/
 	name: prop_types.default.string,
+	/**
+	* Event handler that is called after removing a file from the file uploader
+	* The event handler signature looks like `onDelete(evt, { uuid })`
+	*/
 	onDelete: prop_types.default.func,
+	/**
+	* Specify the size of the FileUploaderButton, from a list of available
+	* sizes.
+	*/
 	size: prop_types.default.oneOf([
 		"sm",
 		"md",
 		"lg"
 	]),
+	/**
+	* Status of the file upload
+	*/
 	status: prop_types.default.oneOf([
 		"uploading",
 		"edit",
 		"complete"
 	]),
+	/**
+	* Unique identifier for the file object
+	*/
 	uuid: prop_types.default.string
 };
 //#endregion

package/lib/components/FileUploader/Filename.js

@@ -51,15 +51,33 @@ function Filename({ iconDescription = "Uploading file", status = "uploading", in
 	}
 }
 Filename.propTypes = {
+	/**
+	* Specify an id that describes the error to be read by screen readers when the filename is invalid
+	*/
 	["aria-describedby"]: prop_types.default.string,
+	/**
+	* Provide a description of the SVG icon to denote file upload status
+	*/
 	iconDescription: prop_types.default.string,
+	/**
+	* Specify if the file is invalid
+	*/
 	invalid: prop_types.default.bool,
+	/**
+	* Name of the uploaded file
+	*/
 	name: prop_types.default.string,
+	/**
+	* Status of the file upload
+	*/
 	status: prop_types.default.oneOf([
 		"edit",
 		"complete",
 		"uploading"
 	]),
+	/**
+	* Provide a custom tabIndex value for the `<Filename>`
+	*/
 	tabIndex: prop_types.default.number
 };
 //#endregion

package/lib/components/FluidComboBox/FluidComboBox.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,6 +32,10 @@ const FluidComboBoxSkeleton = ({ className, ...rest }) => {
 		})
 	});
 };
-FluidComboBoxSkeleton.propTypes = { className: prop_types.default.string };
+FluidComboBoxSkeleton.propTypes = { 
+/**
+* Specify an optional className to add.
+*/
+className: prop_types.default.string };
 //#endregion
 exports.default = FluidComboBoxSkeleton;

package/lib/components/FluidComboBox/FluidComboBox.js

@@ -9,10 +9,10 @@ const require_runtime = require("../../_virtual/_rolldown/runtime.js");
 const require_usePrefix = require("../../internal/usePrefix.js");
 const require_FormContext = require("../FluidForm/FormContext.js");
 const require_index = require("../ComboBox/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 prop_types = require("prop-types");
 prop_types = require_runtime.__toESM(prop_types);
 let react_jsx_runtime = require("react/jsx-runtime");
@@ -36,31 +36,92 @@ const FluidComboBox = react.default.forwardRef(function FluidComboBox({ classNam
 	});
 });
 FluidComboBox.propTypes = {
+	/**
+	* Specify an optional className to be applied to the outer FluidForm wrapper
+	*/
 	className: prop_types.default.string,
+	/**
+	* Specify the direction of the dropdown. Can be either top or bottom.
+	*/
 	direction: prop_types.default.oneOf(["top", "bottom"]),
+	/**
+	* Specify whether the `<input>` should be disabled
+	*/
 	disabled: prop_types.default.bool,
+	/**
+	* Specify a custom `id` for the `<input>`
+	*/
 	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,
+	/**
+	* Provide the text that is displayed when the control is in an invalid state
+	*/
 	invalidText: prop_types.default.node,
+	/**
+	* Specify if the `FluidComboBox` should render its menu items in condensed mode
+	*/
 	isCondensed: prop_types.default.bool,
+	/**
+	* 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,
+	/**
+	* `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.isRequired,
+	/**
+	* 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
 	]),
+	/**
+	* Provide the title text that will be read by a screen reader when
+	* visiting this control
+	*/
 	titleText: prop_types.default.node,
+	/**
+	* Translates component strings using your i18n tool.
+	*/
 	translateWithId: prop_types.default.func,
+	/**
+	* 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/FluidDatePicker/FluidDatePicker.Skeleton.js

@@ -8,10 +8,10 @@
 const require_runtime = require("../../_virtual/_rolldown/runtime.js");
 const require_usePrefix = require("../../internal/usePrefix.js");
 const require_FormContext = require("../FluidForm/FormContext.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");
@@ -58,7 +58,13 @@ const FluidDatePickerSkeleton = ({ className, datePickerType = "single", ...othe
 	});
 };
 FluidDatePickerSkeleton.propTypes = {
+	/**
+	* Specify an optional className to be applied to the outer FluidForm wrapper
+	*/
 	className: prop_types.default.string,
+	/**
+	* Specify which variant of the DatePicker the skeleton should mimic
+	*/
 	datePickerType: prop_types.default.oneOf([
 		"simple",
 		"single",

package/lib/components/FluidDatePicker/FluidDatePicker.js

@@ -9,10 +9,10 @@ const require_runtime = require("../../_virtual/_rolldown/runtime.js");
 const require_usePrefix = require("../../internal/usePrefix.js");
 const require_FormContext = require("../FluidForm/FormContext.js");
 const require_index = require("../DatePicker/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 prop_types = require("prop-types");
 prop_types = require_runtime.__toESM(prop_types);
 let react_jsx_runtime = require("react/jsx-runtime");
@@ -45,12 +45,33 @@ const FluidDatePicker = react.default.forwardRef(function FluidDatePicker({ clas
 	});
 });
 FluidDatePicker.propTypes = {
+	/**
+	* The child node(s)
+	*/
 	children: prop_types.default.node,
+	/**
+	* Specify an optional className to be applied to the outer FluidForm wrapper
+	*/
 	className: prop_types.default.string,
+	/**
+	* Specify whether or not the control is invalid
+	*/
 	invalid: prop_types.default.bool,
+	/**
+	* Provide the text that is displayed when the control is in error state
+	*/
 	invalidText: prop_types.default.node,
+	/**
+	* Whether the input should be read-only
+	*/
 	readOnly: prop_types.default.bool,
+	/**
+	* 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/FluidDropdown/FluidDropdown.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,6 +32,10 @@ const FluidDropdownSkeleton = ({ className, ...rest }) => {
 		})
 	});
 };
-FluidDropdownSkeleton.propTypes = { className: prop_types.default.string };
+FluidDropdownSkeleton.propTypes = { 
+/**
+* Specify an optional className to add.
+*/
+className: prop_types.default.string };
 //#endregion
 exports.default = FluidDropdownSkeleton;

package/lib/components/FluidDropdown/FluidDropdown.js

@@ -9,10 +9,10 @@ const require_runtime = require("../../_virtual/_rolldown/runtime.js");
 const require_usePrefix = require("../../internal/usePrefix.js");
 const require_FormContext = require("../FluidForm/FormContext.js");
 const require_index = require("../Dropdown/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 prop_types = require("prop-types");
 prop_types = require_runtime.__toESM(prop_types);
 let react_jsx_runtime = require("react/jsx-runtime");
@@ -36,32 +36,97 @@ const FluidDropdown = react.default.forwardRef(function FluidDropdown({ classNam
 	});
 });
 FluidDropdown.propTypes = {
+	/**
+	* Specify an optional className to be applied to the outer FluidForm wrapper
+	*/
 	className: prop_types.default.string,
+	/**
+	* Specify the direction of the dropdown. Can be either top or bottom.
+	*/
 	direction: prop_types.default.oneOf(["top", "bottom"]),
+	/**
+	* Specify whether the `<input>` should be disabled
+	*/
 	disabled: prop_types.default.bool,
+	/**
+	* Specify a custom `id` for the `<input>`
+	*/
 	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,
+	/**
+	* Provide the text that is displayed when the control is in an invalid state
+	*/
 	invalidText: prop_types.default.node,
+	/**
+	* Specify if the `FluidDropdown` should render its menu items in condensed mode
+	*/
 	isCondensed: prop_types.default.bool,
+	/**
+	* 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,
+	/**
+	* `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,
+	/**
+	* 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
 	]),
+	/**
+	* Provide the title text that will be read by a screen reader when
+	* visiting this control
+	*/
 	titleText: prop_types.default.node,
+	/**
+	* Translates component strings using your i18n tool.
+	*/
 	translateWithId: prop_types.default.func,
+	/**
+	* 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/FluidForm/FluidForm.js

@@ -9,10 +9,10 @@ const require_runtime = require("../../_virtual/_rolldown/runtime.js");
 const require_usePrefix = require("../../internal/usePrefix.js");
 const require_Form = require("../Form/Form.js");
 const require_FormContext = require("./FormContext.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");
@@ -35,7 +35,13 @@ const FluidForm = ({ className, children, ...other }) => {
 	});
 };
 FluidForm.propTypes = {
+	/**
+	* Provide children to be rendered inside of the <form> element
+	*/
 	children: prop_types.default.node,
+	/**
+	* Provide a custom className to be applied on the containing <form> node
+	*/
 	className: prop_types.default.string
 };
 //#endregion

package/lib/components/FluidForm/FormContext.js

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

package/lib/components/FluidMultiSelect/FluidMultiSelect.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,6 +32,10 @@ const FluidMultiSelectSkeleton = ({ className, ...rest }) => {
 		})
 	});
 };
-FluidMultiSelectSkeleton.propTypes = { className: prop_types.default.string };
+FluidMultiSelectSkeleton.propTypes = { 
+/**
+* Specify an optional className to add.
+*/
+className: prop_types.default.string };
 //#endregion
 exports.default = FluidMultiSelectSkeleton;