@carbon/react 1.110.0 → 1.111.0-rc.0

package/es/components/Button/ButtonBase.js

@@ -7,8 +7,8 @@
 
 import { usePrefix } from "../../internal/usePrefix.js";
 import { useId } from "../../internal/useId.js";
-import React from "react";
 import classNames from "classnames";
+import React from "react";
 import { jsx } from "react/jsx-runtime";
 //#region src/components/Button/ButtonBase.tsx
 /**

package/es/components/ButtonSet/ButtonSet.js

@@ -7,8 +7,8 @@
 
 import { usePrefix } from "../../internal/usePrefix.js";
 import useIsomorphicEffect from "../../internal/useIsomorphicEffect.js";
-import React, { forwardRef, useEffect, useRef, useState } from "react";
 import classNames from "classnames";
+import React, { forwardRef, useEffect, useRef, useState } from "react";
 import PropTypes from "prop-types";
 import { jsx } from "react/jsx-runtime";
 //#region src/components/ButtonSet/ButtonSet.tsx
@@ -76,9 +76,23 @@ const ButtonSet = forwardRef((props, ref) => {
 });
 ButtonSet.displayName = "ButtonSet";
 ButtonSet.propTypes = {
+	/**
+	* Specify the content of your ButtonSet
+	*/
 	children: PropTypes.node,
+	/**
+	* Specify an optional className to be added to your ButtonSet
+	*/
 	className: PropTypes.string,
+	/**
+	* fluid: button set resize to the size of the container up to a maximum dependant on the
+	* number of buttons.
+	*/
 	fluid: PropTypes.bool,
+	/**
+	* Specify the button arrangement of the set (vertically stacked or
+	* horizontal) - ignored when fluid is true
+	*/
 	stacked: PropTypes.bool
 };
 //#endregion

package/es/components/ChatButton/ChatButton.Skeleton.js

@@ -6,8 +6,8 @@
  */
 
 import { usePrefix } from "../../internal/usePrefix.js";
-import "react";
 import classNames from "classnames";
+import "react";
 import PropTypes from "prop-types";
 import { jsx } from "react/jsx-runtime";
 //#region src/components/ChatButton/ChatButton.Skeleton.tsx
@@ -25,7 +25,13 @@ const ChatButtonSkeleton = ({ className, size, ...rest }) => {
 	});
 };
 ChatButtonSkeleton.propTypes = {
+	/**
+	* Specify an optional className to add.
+	*/
 	className: PropTypes.string,
+	/**
+	* Specify the size of the `ChatButtonSkeleton`, from the following list of sizes:
+	*/
 	size: PropTypes.oneOf([
 		"sm",
 		"md",

package/es/components/ChatButton/ChatButton.js

@@ -7,8 +7,8 @@
 
 import { usePrefix } from "../../internal/usePrefix.js";
 import Button_default from "../Button/index.js";
-import React from "react";
 import classNames from "classnames";
+import React from "react";
 import PropTypes from "prop-types";
 import { jsx } from "react/jsx-runtime";
 //#region src/components/ChatButton/ChatButton.tsx
@@ -50,11 +50,29 @@ const ChatButton = React.forwardRef(function ChatButton({ className, children, d
 	});
 });
 ChatButton.propTypes = {
+	/**
+	* Provide the contents of your Select
+	*/
 	children: PropTypes.node,
+	/**
+	* Specify an optional className to be applied to the node containing the label and the select box
+	*/
 	className: PropTypes.string,
+	/**
+	* Specify whether the `ChatButton` should be disabled
+	*/
 	disabled: PropTypes.bool,
+	/**
+	* Specify whether the `ChatButton` should be rendered as a quick action button
+	*/
 	isQuickAction: PropTypes.bool,
+	/**
+	* Specify whether the quick action `ChatButton` should be rendered as selected. This disables the input
+	*/
 	isSelected: PropTypes.bool,
+	/**
+	* Specify the kind of `ChatButton` you want to create
+	*/
 	kind: PropTypes.oneOf([
 		"primary",
 		"secondary",
@@ -62,7 +80,13 @@ ChatButton.propTypes = {
 		"ghost",
 		"tertiary"
 	]),
+	/**
+	* A component used to render an icon.
+	*/
 	renderIcon: PropTypes.oneOfType([PropTypes.func, PropTypes.object]),
+	/**
+	* Specify the size of the `ChatButton`, from the following list of sizes:
+	*/
 	size: PropTypes.oneOf([
 		"sm",
 		"md",

package/es/components/Checkbox/Checkbox.Skeleton.js

@@ -6,8 +6,8 @@
  */
 
 import { usePrefix } from "../../internal/usePrefix.js";
-import "react";
 import classNames from "classnames";
+import "react";
 import PropTypes from "prop-types";
 import { jsx } from "react/jsx-runtime";
 //#region src/components/Checkbox/Checkbox.Skeleton.tsx
@@ -28,6 +28,10 @@ const CheckboxSkeleton = ({ className, ...rest }) => {
 		})
 	});
 };
-CheckboxSkeleton.propTypes = { className: PropTypes.string };
+CheckboxSkeleton.propTypes = { 
+/**
+* Specify an optional className to add.
+*/
+className: PropTypes.string };
 //#endregion
 export { CheckboxSkeleton as default };

package/es/components/Checkbox/Checkbox.js

@@ -5,17 +5,17 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import { noopFn } from "../../internal/noopFn.js";
 import { usePrefix } from "../../internal/usePrefix.js";
 import { Text } from "../Text/Text.js";
 import { useId } from "../../internal/useId.js";
+import { noopFn } from "../../internal/noopFn.js";
 import { deprecate } from "../../prop-types/deprecate.js";
 import { isComponentElement } from "../../internal/utils.js";
 import { hasHelperText } from "../../internal/hasHelperText.js";
 import { useNormalizedInputProps } from "../../internal/useNormalizedInputProps.js";
 import { AILabel } from "../AILabel/index.js";
-import React, { cloneElement } from "react";
 import classNames from "classnames";
+import React, { cloneElement } from "react";
 import PropTypes from "prop-types";
 import { Fragment, jsx, jsxs } from "react/jsx-runtime";
 import { WarningAltFilled, WarningFilled } from "@carbon/icons-react";
@@ -112,23 +112,80 @@ const Checkbox$1 = React.forwardRef(({ className, decorator, helperText, id, lab
 	});
 });
 Checkbox$1.propTypes = {
+	/**
+	* Specify whether the underlying input should be checked
+	*/
 	checked: PropTypes.bool,
+	/**
+	* Specify an optional className to be applied to the <label> node
+	*/
 	className: PropTypes.string,
+	/**
+	* **Experimental**: Provide a decorator component to be rendered inside the `Checkbox` component
+	*/
 	decorator: PropTypes.node,
+	/**
+	* Specify whether the underlying input should be checked by default
+	*/
 	defaultChecked: PropTypes.bool,
+	/**
+	* Specify whether the Checkbox should be disabled
+	*/
 	disabled: PropTypes.bool,
+	/**
+	* Provide text for the form group for additional help
+	*/
 	helperText: PropTypes.node,
+	/**
+	* Specify whether the label should be hidden, or not
+	*/
 	hideLabel: PropTypes.bool,
+	/**
+	* Provide an `id` to uniquely identify the Checkbox input
+	*/
 	id: PropTypes.string.isRequired,
+	/**
+	* Specify whether the Checkbox is in an indeterminate state
+	*/
 	indeterminate: PropTypes.bool,
+	/**
+	* Specify whether the Checkbox is currently invalid
+	*/
 	invalid: PropTypes.bool,
+	/**
+	* Provide the text that is displayed when the Checkbox is in an invalid state
+	*/
 	invalidText: PropTypes.node,
+	/**
+	* Provide a label to provide a description of the Checkbox input that you are
+	* exposing to the user
+	*/
 	labelText: PropTypes.node.isRequired,
+	/**
+	* Provide an optional handler that is called when the internal state of
+	* Checkbox changes. This handler is called with event and state info.
+	* `(event, { checked, id }) => void`
+	*/
 	onChange: PropTypes.func,
+	/**
+	* Specify whether the Checkbox is read-only
+	*/
 	readOnly: PropTypes.bool,
+	/**
+	* **Experimental**: Provide a `Slug` component to be rendered inside the `Checkbox` component
+	*/
 	slug: deprecate(PropTypes.node, "The `slug` prop has been deprecated and will be removed in the next major version. Use the decorator prop instead."),
+	/**
+	* Specify a title for the <label> node for the Checkbox
+	*/
 	title: PropTypes.string,
+	/**
+	* Specify whether the Checkbox is currently in warning state
+	*/
 	warn: PropTypes.bool,
+	/**
+	* Provide the text that is displayed when the Checkbox is in warning state
+	*/
 	warnText: PropTypes.node
 };
 Checkbox$1.displayName = "Checkbox";

package/es/components/CheckboxGroup/CheckboxGroup.js

@@ -13,8 +13,8 @@ import { hasHelperText } from "../../internal/hasHelperText.js";
 import { useNormalizedInputProps } from "../../internal/useNormalizedInputProps.js";
 import { AILabel } from "../AILabel/index.js";
 import Checkbox$1 from "../Checkbox/Checkbox.js";
-import { Children, cloneElement } from "react";
 import classNames from "classnames";
+import { Children, cloneElement } from "react";
 import PropTypes from "prop-types";
 import { Fragment, jsx, jsxs } from "react/jsx-runtime";
 import { WarningAltFilled, WarningFilled } from "@carbon/icons-react";
@@ -105,18 +105,58 @@ const CheckboxGroup = ({ children, className, decorator, helperText, invalid, in
 	});
 };
 CheckboxGroup.propTypes = {
+	/**
+	* Provide the children form elements to be rendered inside of the <fieldset>
+	*/
 	children: PropTypes.node,
+	/**
+	* Provide a custom className to be applied to the containing <fieldset> node
+	*/
 	className: PropTypes.string,
+	/**
+	* **Experimental**: Provide a decorator component to be rendered inside the `CheckboxGroup` component
+	*/
 	decorator: PropTypes.node,
+	/**
+	* Provide text for the form group for additional help
+	*/
 	helperText: PropTypes.node,
+	/**
+	* Specify whether the form group is currently invalid
+	*/
 	invalid: PropTypes.bool,
+	/**
+	* Provide the text that is displayed when the form group is in an invalid state
+	*/
 	invalidText: PropTypes.node,
+	/**
+	* Provide id for the fieldset <legend> which corresponds to the fieldset
+	* `aria-labelledby`
+	*/
 	legendId: PropTypes.node,
+	/**
+	* Provide the text to be rendered inside of the fieldset <legend>
+	*/
 	legendText: PropTypes.node.isRequired,
+	/**
+	* Provide the orientation for how the checkbox should be displayed
+	*/
 	orientation: PropTypes.oneOf(["horizontal", "vertical"]),
+	/**
+	* Whether the CheckboxGroup should be read-only
+	*/
 	readOnly: PropTypes.bool,
+	/**
+	* **Experimental**: Provide a `Slug` component to be rendered inside the `CheckboxGroup` component
+	*/
 	slug: deprecate(PropTypes.node, "The `slug` prop has been deprecated and will be removed in the next major version. Use the decorator prop instead."),
+	/**
+	* Specify whether the form group is currently in warning state
+	*/
 	warn: PropTypes.bool,
+	/**
+	* Provide the text that is displayed when the form group is in warning state
+	*/
 	warnText: PropTypes.node
 };
 //#endregion

package/es/components/ClassPrefix/index.js

@@ -24,6 +24,9 @@ function ClassPrefix({ children, prefix }) {
 }
 ClassPrefix.propTypes = {
 	children: PropTypes.node,
+	/**
+	* The value used to prefix the CSS selectors used by Carbon components
+	*/
 	prefix: PropTypes.string.isRequired
 };
 //#endregion

package/es/components/CodeSnippet/CodeSnippet.Skeleton.js

@@ -6,8 +6,8 @@
  */
 
 import { usePrefix } from "../../internal/usePrefix.js";
-import "react";
 import classNames from "classnames";
+import "react";
 import PropTypes from "prop-types";
 import { jsx, jsxs } from "react/jsx-runtime";
 //#region src/components/CodeSnippet/CodeSnippet.Skeleton.tsx
@@ -47,7 +47,13 @@ function CodeSnippetSkeleton({ className: containerClassName, type = "single", .
 	});
 }
 CodeSnippetSkeleton.propTypes = {
+	/**
+	* Specify an optional className to be applied to the container node
+	*/
 	className: PropTypes.string,
+	/**
+	* The type of the code snippet, including single or multi
+	*/
 	type: PropTypes.oneOf(["single", "multi"])
 };
 //#endregion

package/es/components/CodeSnippet/CodeSnippet.js

@@ -14,8 +14,8 @@ import Button_default from "../Button/index.js";
 import { useResizeObserver } from "../../internal/useResizeObserver.js";
 import Copy_default from "../Copy/index.js";
 import CopyButton_default from "../CopyButton/index.js";
-import { useCallback, useRef, useState } from "react";
 import classNames from "classnames";
+import { useCallback, useRef, useState } from "react";
 import PropTypes from "prop-types";
 import { jsx, jsxs } from "react/jsx-runtime";
 import { ChevronDown } from "@carbon/icons-react";
@@ -159,6 +159,9 @@ function CodeSnippet({ align = "bottom", autoAlign = false, className, type = "s
 	});
 }
 CodeSnippet.propTypes = {
+	/**
+	* Specify how the trigger should align with the tooltip
+	*/
 	align: deprecateValuesWithin(PropTypes.oneOf([
 		"top",
 		"top-left",
@@ -194,30 +197,103 @@ CodeSnippet.propTypes = {
 		"right-start",
 		"right-end"
 	], mapPopoverAlign),
+	/**
+	* Specify a label to be read by screen readers on the containing textbox
+	* node
+	*/
 	["aria-label"]: PropTypes.string,
+	/**
+	* Deprecated, please use `aria-label` instead.
+	* Specify a label to be read by screen readers on the containing textbox
+	* node
+	*/
 	ariaLabel: deprecate(PropTypes.string, "This prop syntax has been deprecated. Please use the new `aria-label`."),
+	/**
+	* **Experimental**: Will attempt to automatically align the tooltip. Requires
+	* React v17+
+	* @see https://github.com/carbon-design-system/carbon/issues/18714
+	*/
 	autoAlign: PropTypes.bool,
+	/**
+	* Provide the content of your CodeSnippet as a node or string
+	*/
 	children: PropTypes.node,
+	/**
+	* Specify an optional className to be applied to the container node
+	*/
 	className: PropTypes.string,
+	/**
+	* Specify the description for the Copy Button
+	*/
 	copyButtonDescription: PropTypes.string,
+	/**
+	* Optional text to copy. If not specified, the `children` node's `innerText`
+	* will be used as the copy value.
+	*/
 	copyText: PropTypes.string,
+	/**
+	* Specify whether or not the CodeSnippet should be disabled
+	*/
 	disabled: PropTypes.bool,
+	/**
+	* Specify the string displayed when the snippet is copied
+	*/
 	feedback: PropTypes.string,
+	/**
+	* Specify the time it takes for the feedback message to timeout
+	*/
 	feedbackTimeout: PropTypes.number,
+	/**
+	* Specify whether or not a copy button should be used/rendered.
+	*/
 	hideCopyButton: PropTypes.bool,
+	/**
+	* Specify whether you are using the light variant of the Code Snippet,
+	* typically used for inline snippet to display an alternate color
+	*/
 	light: deprecate(PropTypes.bool, "The `light` prop for `CodeSnippet` has been deprecated in favor of the new `Layer` component. It will be removed in the next major release."),
+	/**
+	* Specify the maximum number of rows to be shown when in collapsed view
+	*/
 	maxCollapsedNumberOfRows: PropTypes.number,
+	/**
+	* Specify the maximum number of rows to be shown when in expanded view
+	*/
 	maxExpandedNumberOfRows: PropTypes.number,
+	/**
+	* Specify the minimum number of rows to be shown when in collapsed view
+	*/
 	minCollapsedNumberOfRows: PropTypes.number,
+	/**
+	* Specify the minimum number of rows to be shown when in expanded view
+	*/
 	minExpandedNumberOfRows: PropTypes.number,
+	/**
+	* An optional handler to listen to the `onClick` even fired by the Copy
+	* Button
+	*/
 	onClick: PropTypes.func,
+	/**
+	* Specify a string that is displayed when the Code Snippet has been
+	* interacted with to show more lines
+	*/
 	showLessText: PropTypes.string,
+	/**
+	* Specify a string that is displayed when the Code Snippet text is more
+	* than 15 lines
+	*/
 	showMoreText: PropTypes.string,
+	/**
+	* Provide the type of Code Snippet
+	*/
 	type: PropTypes.oneOf([
 		"single",
 		"inline",
 		"multi"
 	]),
+	/**
+	* Specify whether or not to wrap the text.
+	*/
 	wrapText: PropTypes.bool
 };
 //#endregion

package/es/components/ComboBox/ComboBox.js

@@ -22,8 +22,8 @@ import ListBox from "../ListBox/index.js";
 import ListBoxSelection from "../ListBox/next/ListBoxSelection.js";
 import ListBoxTrigger from "../ListBox/next/ListBoxTrigger.js";
 import { mergeRefs } from "../../tools/mergeRefs.js";
-import { cloneElement, forwardRef, useCallback, useContext, useEffect, useMemo, useRef, useState } from "react";
 import classNames from "classnames";
+import { cloneElement, forwardRef, useCallback, useContext, useEffect, useMemo, useRef, useState } from "react";
 import PropTypes from "prop-types";
 import { jsx, jsxs } from "react/jsx-runtime";
 import { Checkmark, WarningAltFilled, WarningFilled } from "@carbon/icons-react";
@@ -614,47 +614,187 @@ const ComboBox = forwardRef((props, ref) => {
 });
 ComboBox.displayName = "ComboBox";
 ComboBox.propTypes = {
+	/**
+	* Specify whether or not the ComboBox should allow a value that is
+	* not in the list to be entered in the input
+	*/
 	allowCustomValue: PropTypes.bool,
+	/**
+	* 'aria-label' of the ListBox component.
+	* Specify a label to be read by screen readers on the container node
+	*/
 	["aria-label"]: PropTypes.string,
+	/**
+	* Deprecated, please use `aria-label` instead.
+	* Specify a label to be read by screen readers on the container note.
+	* 'aria-label' of the ListBox component.
+	*/
 	ariaLabel: deprecate(PropTypes.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: PropTypes.bool,
+	/**
+	* An optional className to add to the container node
+	*/
 	className: PropTypes.string,
+	/**
+	* **Experimental**: Provide a decorator component to be rendered inside the `ComboBox` component
+	*/
 	decorator: PropTypes.node,
+	/**
+	* Specify the direction of the combobox dropdown. Can be either top or bottom.
+	*/
 	direction: PropTypes.oneOf(["top", "bottom"]),
+	/**
+	* Specify if the control should be disabled, or not
+	*/
 	disabled: PropTypes.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: PropTypes.object,
+	/**
+	* Provide a ref that will be mutated to contain an object of downshift
+	* action functions. These can be called to change the internal state of the
+	* downshift useCombobox hook.
+	*
+	* **Use with caution:** calling these actions modifies the internal state of
+	* downshift. It may conflict with or override the state management used within
+	* Combobox. 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.
+	*/
 	downshiftActions: PropTypes.exact({ current: PropTypes.any }),
+	/**
+	* Provide helper text that is used alongside the control label for
+	* additional help
+	*/
 	helperText: PropTypes.node,
+	/**
+	* Specify a custom `id` for the input
+	*/
 	id: PropTypes.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: PropTypes.oneOfType([
 		PropTypes.object,
 		PropTypes.string,
 		PropTypes.number
 	]),
+	/**
+	* Specify if the currently selected value is invalid.
+	*/
 	invalid: PropTypes.bool,
+	/**
+	* Message which is displayed if the value is invalid.
+	*/
 	invalidText: PropTypes.node,
+	/**
+	* Renders an item as a custom React node instead of a string.
+	*/
 	itemToElement: PropTypes.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: PropTypes.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: PropTypes.array.isRequired,
+	/**
+	* should use "light theme" (white background)?
+	*/
 	light: deprecate(PropTypes.bool, "The `light` prop for `Combobox` 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 when a specific dropdown item is selected.
+	* `({ selectedItem }) => void`
+	* @param {{ selectedItem }}
+	*/
 	onChange: PropTypes.func.isRequired,
+	/**
+	* Callback function to notify consumer when the text input changes.
+	* This provides support to change available items based on the text.
+	* `(inputText) => void`
+	* @param {string} inputText
+	*/
 	onInputChange: PropTypes.func,
+	/**
+	* Callback function that fires when the combobox menu toggle is clicked
+	* `(evt) => void`
+	* @param {MouseEvent} event
+	*/
 	onToggleClick: PropTypes.func,
+	/**
+	* Used to provide a placeholder text node before a user enters any input.
+	* This is only present if the control has no items selected
+	*/
 	placeholder: PropTypes.string,
+	/**
+	* Is the ComboBox readonly?
+	*/
 	readOnly: PropTypes.bool,
+	/**
+	* For full control of the selection
+	*/
 	selectedItem: PropTypes.oneOfType([
 		PropTypes.object,
 		PropTypes.string,
 		PropTypes.number
 	]),
+	/**
+	* Specify your own filtering logic by passing in a `shouldFilterItem`
+	* function that takes in the current input and an item and passes back
+	* whether or not the item should be filtered.
+	* this prop will be ignored if `typeahead` prop is enabled
+	*/
 	shouldFilterItem: PropTypes.func,
+	/**
+	* Specify the size of the ListBox. Currently supports either `xs`, `sm`, `md` or `lg` as an option.
+	*/
 	size: ListBoxSizePropType,
 	slug: deprecate(PropTypes.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 used in a `<label>` element that is tied to the
+	* combobox via ARIA attributes.
+	*/
 	titleText: PropTypes.node,
+	/**
+	* Translates component strings using your i18n tool.
+	*/
 	translateWithId: PropTypes.func,
+	/**
+	* **Experimental**: will enable autocomplete and typeahead for the input field
+	*/
 	typeahead: PropTypes.bool,
+	/**
+	* Specify whether the control is currently in warning state
+	*/
 	warn: PropTypes.bool,
+	/**
+	* Provide the text that is displayed when the control is in warning state
+	*/
 	warnText: PropTypes.node,
+	/**
+	* Specify native input attributes to place on the `<input>`, like maxLength.
+	* These are passed to downshift's getInputProps() and will override the
+	* internal input props.
+	* https://github.com/downshift-js/downshift?tab=readme-ov-file#getinputprops
+	*/
 	inputProps: PropTypes.object
 };
 //#endregion