@carbon/react 1.110.0-rc.0 → 1.111.0-rc.0

package/es/components/MultiSelect/MultiSelect.js

@@ -6,7 +6,7 @@
  */
 
 import { usePrefix } from "../../internal/usePrefix.js";
-import { ArrowDown, Delete, Enter, Escape, Space } from "../../internal/keyboard/keys.js";
+import { ArrowDown, Delete, Enter, Escape, Space, Tab } from "../../internal/keyboard/keys.js";
 import { match } from "../../internal/keyboard/match.js";
 import useIsomorphicEffect from "../../internal/useIsomorphicEffect.js";
 import { useId } from "../../internal/useId.js";
@@ -141,6 +141,7 @@ const MultiSelect = React.forwardRef(({ autoAlign = false, className: containerC
 				if (match(e, ArrowDown) && selectedItems.length === 0) setInputFocused(false);
 				if (match(e, Escape) && isOpen) setInputFocused(true);
 				if (match(e, Enter) && isOpen) setInputFocused(true);
+				if (match(e, Tab) && isOpen) setIsOpenWrapper(false);
 			}
 		}
 	});
@@ -419,45 +420,192 @@ const MultiSelect = React.forwardRef(({ autoAlign = false, className: containerC
 MultiSelect.displayName = "MultiSelect";
 MultiSelect.propTypes = {
 	...sortingPropTypes,
+	/**
+	* **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,
+	/**
+	* Provide a custom class name to be added to the outermost node in the
+	* component
+	*/
 	className: PropTypes.string,
+	/**
+	* Specify the text that should be read for screen readers that describes total items selected
+	*/
 	clearSelectionDescription: PropTypes.string,
+	/**
+	* Specify the text that should be read for screen readers to clear selection.
+	*/
 	clearSelectionText: PropTypes.string,
+	/**
+	* Provide a compare function that is used to determine the ordering of
+	* options. See 'sortItems' for more control. Consider
+	* declaring function with `useCallback` to prevent unnecessary re-renders.
+	*/
 	compareItems: PropTypes.func,
+	/**
+	* **Experimental**: Provide a decorator component to be rendered inside the `MultiSelect` component
+	*/
 	decorator: PropTypes.node,
+	/**
+	* Specify the direction of the multiselect dropdown. Can be either top or bottom.
+	*/
 	direction: PropTypes.oneOf(["top", "bottom"]),
+	/**
+	* Disable the control
+	*/
 	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 helper text that is used alongside the control label for
+	* additional help
+	*/
 	helperText: PropTypes.node,
+	/**
+	* Specify whether the title text should be hidden or not
+	*/
 	hideLabel: PropTypes.bool,
+	/**
+	* Specify a custom `id`
+	*/
 	id: PropTypes.string.isRequired,
+	/**
+	* Allow users to pass in arbitrary items from their collection that are
+	* pre-selected
+	*/
 	initialSelectedItems: PropTypes.array,
+	/**
+	* Is the current selection invalid?
+	*/
 	invalid: PropTypes.bool,
+	/**
+	* If invalid, what is the error?
+	*/
 	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. Consider
+	* declaring function with `useCallback` to prevent unnecessary re-renders.
+	*/
 	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,
+	/**
+	* Generic `label` that will be used as the textual representation of what
+	* this field is for
+	*/
 	label: PropTypes.node.isRequired,
+	/**
+	* `true` to use the light version.
+	*/
 	light: deprecate(PropTypes.bool, "The `light` prop for `MultiSelect` has been deprecated in favor of the new `Layer` component. It will be removed in the next major release."),
+	/**
+	* Specify the locale of the control. Used for the default `compareItems`
+	* used for sorting the list of items in the control.
+	*/
 	locale: PropTypes.string,
+	/**
+	* `onChange` is a utility for this controlled component to communicate to a
+	* consuming component what kind of internal state changes are occurring.
+	*/
 	onChange: PropTypes.func,
+	/**
+	* `onMenuChange` is a utility for this controlled component to communicate to a
+	* consuming component that the menu was open(`true`)/closed(`false`).
+	*/
 	onMenuChange: PropTypes.func,
+	/**
+	* Initialize the component with an open(`true`)/closed(`false`) menu.
+	*/
 	open: PropTypes.bool,
+	/**
+	* Whether or not the Dropdown is readonly
+	*/
 	readOnly: PropTypes.bool,
+	/**
+	* For full control of the selected items
+	*/
 	selectedItems: PropTypes.array,
+	/**
+	* Specify feedback (mode) of the selection.
+	* `top`: selected item jumps to top
+	* `fixed`: selected item stays at it's position
+	* `top-after-reopen`: selected item jump to top after reopen dropdown
+	*/
 	selectionFeedback: PropTypes.oneOf([
 		"top",
 		"fixed",
 		"top-after-reopen"
 	]),
+	/**
+	* 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 a method that sorts all options in the control. Overriding this
+	* prop means that you also have to handle the sort logic for selected versus
+	* un-selected items. If you just want to control ordering, consider the
+	* `compareItems` prop instead.
+	*
+	* The return value should be a number whose sign indicates the relative order
+	* of the two elements: negative if a is less than b, positive if a is greater
+	* than b, and zero if they are equal.
+	*
+	* sortItems :
+	*   (items: Array<Item>, {
+	*     selectedItems: Array<Item>,
+	*     itemToString: Item => string,
+	*     compareItems: (itemA: string, itemB: string, {
+	*       locale: string
+	*     }) => number,
+	*     locale: string,
+	*   }) => Array<Item>
+	*/
 	sortItems: PropTypes.func,
+	/**
+	* Provide text to be used in a `<label>` element that is tied to the
+	* multiselect via ARIA attributes.
+	*/
 	titleText: PropTypes.node,
+	/**
+	* Translates component strings using your i18n tool.
+	*/
 	translateWithId: PropTypes.func,
+	/**
+	* Specify 'inline' to create an inline multi-select.
+	*/
 	type: ListBoxTypePropType,
+	/**
+	* Specify title to show title on hover
+	*/
 	useTitleInItem: 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
 };
 //#endregion

package/es/components/MultiSelect/MultiSelectPropTypes.js

@@ -14,7 +14,32 @@ import PropTypes from "prop-types";
 * LICENSE file in the root directory of this source tree.
 */
 const sortingPropTypes = {
+	/**
+	* Provide a compare function that is used to determine the ordering of
+	* options. `compareItems` has the following function signature:
+	*
+	* compareFunction :
+	*  (itemA: string, itemB: string, { locale: string }) => number
+	*/
 	compareItems: PropTypes.func,
+	/**
+	* Provide a method that sorts all options in the control. Overriding this
+	* prop means that you also have to handle the sort logic for selected versus
+	* un-selected items. If you just want to control ordering, consider the
+	* `compareItems` prop instead.
+	*
+	* `sortItems` has the following signature:
+	*
+	* sortItems :
+	*   (items: Array<Item>, {
+	*     selectedItems: Array<Item>,
+	*     itemToString: Item => string,
+	*     compareItems: (itemA: string, itemB: string, {
+	*       locale: string
+	*     }) => number,
+	*     locale: string,
+	*   }) => Array<Item>
+	*/
 	sortItems: PropTypes.func
 };
 //#endregion

package/es/components/Notification/Notification.js

@@ -58,9 +58,21 @@ function NotificationActionButton({ children, className: customClassName, onClic
 	});
 }
 NotificationActionButton.propTypes = {
+	/**
+	* Specify the content of the notification action button.
+	*/
 	children: PropTypes.node,
+	/**
+	* Specify an optional className to be applied to the notification action button
+	*/
 	className: PropTypes.string,
+	/**
+	* Specify if the visual treatment of the button should be for an inline notification
+	*/
 	inline: PropTypes.bool,
+	/**
+	* Optionally specify a click handler for the notification action button.
+	*/
 	onClick: PropTypes.func
 };
 function NotificationButton({ "aria-label": ariaLabel = "close notification", ariaLabel: deprecatedAriaLabel, className, type = "button", renderIcon: IconTag = Close, name, notificationType = "toast", ...rest }) {
@@ -80,16 +92,39 @@ function NotificationButton({ "aria-label": ariaLabel = "close notification", ar
 	});
 }
 NotificationButton.propTypes = {
+	/**
+	* 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.
+	*/
 	ariaLabel: deprecate(PropTypes.string, "This prop syntax has been deprecated. Please use the new `aria-label`."),
+	/**
+	* Specify an optional className to be applied to the notification button
+	*/
 	className: PropTypes.string,
+	/**
+	* Specify an optional icon for the Button through a string,
+	* if something but regular "close" icon is desirable
+	*/
 	name: PropTypes.string,
+	/**
+	* Specify the notification type
+	*/
 	notificationType: PropTypes.oneOf([
 		"toast",
 		"inline",
 		"actionable"
 	]),
+	/**
+	* A component used to render an icon.
+	*/
 	renderIcon: PropTypes.oneOfType([PropTypes.func, PropTypes.object]),
+	/**
+	* Optional prop to specify the type of the Button
+	*/
 	type: PropTypes.string
 };
 /**
@@ -201,12 +236,34 @@ function ToastNotification({ ["aria-label"]: ariaLabel, ariaLabel: deprecatedAri
 	});
 }
 ToastNotification.propTypes = {
+	/**
+	* Provide a description for "close" icon button that can be read by screen readers
+	*/
 	["aria-label"]: PropTypes.string,
+	/**
+	* Deprecated, please use `aria-label` instead.
+	* Provide a description for "close" icon button that can be read by screen readers
+	*/
 	ariaLabel: deprecate(PropTypes.string, "This prop syntax has been deprecated. Please use the new `aria-label`."),
+	/**
+	* Specify the caption
+	*/
 	caption: PropTypes.string,
+	/**
+	* Specify the content
+	*/
 	children: PropTypes.node,
+	/**
+	* Specify an optional className to be applied to the notification box
+	*/
 	className: PropTypes.string,
+	/**
+	* Specify the close button should be disabled, or not
+	*/
 	hideCloseButton: PropTypes.bool,
+	/**
+	* Specify what state the notification represents
+	*/
 	kind: PropTypes.oneOf([
 		"error",
 		"info",
@@ -215,17 +272,42 @@ ToastNotification.propTypes = {
 		"warning",
 		"warning-alt"
 	]),
+	/**
+	* Specify whether you are using the low contrast variant of the ToastNotification.
+	*/
 	lowContrast: PropTypes.bool,
+	/**
+	* Provide a function that is called when menu is closed
+	*/
 	onClose: PropTypes.func,
+	/**
+	* Provide a function that is called when the close button is clicked
+	*/
 	onCloseButtonClick: PropTypes.func,
+	/**
+	* By default, this value is "status". You can also provide an alternate
+	* role if it makes sense from the accessibility-side
+	*/
 	role: PropTypes.oneOf([
 		"alert",
 		"log",
 		"status"
 	]),
+	/**
+	* Provide a description for "status" icon that can be read by screen readers
+	*/
 	statusIconDescription: PropTypes.string,
+	/**
+	* Specify the subtitle
+	*/
 	subtitle: PropTypes.string,
+	/**
+	* Specify an optional duration the notification should be closed in
+	*/
 	timeout: PropTypes.number,
+	/**
+	* Specify the title
+	*/
 	title: PropTypes.string
 };
 function InlineNotification({ ["aria-label"]: ariaLabel, children, title, subtitle, role = "status", onClose, onCloseButtonClick = noopFn, statusIconDescription, className, kind = "error", lowContrast, hideCloseButton = false, ...rest }) {
@@ -284,10 +366,25 @@ function InlineNotification({ ["aria-label"]: ariaLabel, children, title, subtit
 	});
 }
 InlineNotification.propTypes = {
+	/**
+	* Provide a description for "close" icon button that can be read by screen readers
+	*/
 	["aria-label"]: PropTypes.string,
+	/**
+	* Specify the content
+	*/
 	children: PropTypes.node,
+	/**
+	* Specify an optional className to be applied to the notification box
+	*/
 	className: PropTypes.string,
+	/**
+	* Specify the close button should be disabled, or not
+	*/
 	hideCloseButton: PropTypes.bool,
+	/**
+	* Specify what state the notification represents
+	*/
 	kind: PropTypes.oneOf([
 		"error",
 		"info",
@@ -296,16 +393,38 @@ InlineNotification.propTypes = {
 		"warning",
 		"warning-alt"
 	]),
+	/**
+	* Specify whether you are using the low contrast variant of the InlineNotification.
+	*/
 	lowContrast: PropTypes.bool,
+	/**
+	* Provide a function that is called when menu is closed
+	*/
 	onClose: PropTypes.func,
+	/**
+	* Provide a function that is called when the close button is clicked
+	*/
 	onCloseButtonClick: PropTypes.func,
+	/**
+	* By default, this value is "status". You can also provide an alternate
+	* role if it makes sense from the accessibility-side.
+	*/
 	role: PropTypes.oneOf([
 		"alert",
 		"log",
 		"status"
 	]),
+	/**
+	* Provide a description for "status" icon that can be read by screen readers
+	*/
 	statusIconDescription: PropTypes.string,
+	/**
+	* Specify the subtitle
+	*/
 	subtitle: PropTypes.string,
+	/**
+	* Specify the title
+	*/
 	title: PropTypes.string
 };
 function ActionableNotification({ actionButtonLabel, ["aria-label"]: ariaLabel, ariaLabel: deprecatedAriaLabel, caption, children, role = "alertdialog", onActionButtonClick, onClose, onCloseButtonClick = noopFn, statusIconDescription, className, inline = false, kind = "error", lowContrast, hideCloseButton = false, hasFocus = true, closeOnEscape = true, title, subtitle, ...rest }) {
@@ -435,16 +554,47 @@ function ActionableNotification({ actionButtonLabel, ["aria-label"]: ariaLabel,
 	});
 }
 ActionableNotification.propTypes = {
+	/**
+	* Pass in the action button label that will be rendered within the ActionableNotification.
+	*/
 	actionButtonLabel: PropTypes.string,
+	/**
+	* Provide a description for "close" icon button that can be read by screen readers
+	*/
 	["aria-label"]: PropTypes.string,
+	/**
+	* Deprecated, please use `aria-label` instead.
+	* Provide a description for "close" icon button that can be read by screen readers
+	*/
 	ariaLabel: deprecate(PropTypes.string, "This prop syntax has been deprecated. Please use the new `aria-label`."),
+	/**
+	* Specify the caption
+	*/
 	caption: PropTypes.string,
+	/**
+	* Specify the content
+	*/
 	children: PropTypes.node,
+	/**
+	* Specify an optional className to be applied to the notification box
+	*/
 	className: PropTypes.string,
+	/**
+	* Specify if pressing the escape key should close notifications
+	*/
 	closeOnEscape: PropTypes.bool,
+	/**
+	* Specify if focus should be moved to the component when the notification contains actions
+	*/
 	hasFocus: deprecate(PropTypes.bool, "hasFocus is deprecated. To conform to accessibility requirements hasFocus should always be `true` for ActionableNotification. If you were setting this prop to `false`, consider using the Callout component instead."),
+	/**
+	* Specify the close button should be disabled, or not
+	*/
 	hideCloseButton: PropTypes.bool,
 	inline: PropTypes.bool,
+	/**
+	* Specify what state the notification represents
+	*/
 	kind: PropTypes.oneOf([
 		"error",
 		"info",
@@ -453,13 +603,40 @@ ActionableNotification.propTypes = {
 		"warning",
 		"warning-alt"
 	]),
+	/**
+	* Specify whether you are using the low contrast variant of the ActionableNotification.
+	*/
 	lowContrast: PropTypes.bool,
+	/**
+	* Provide a function that is called when the action is clicked
+	*/
 	onActionButtonClick: PropTypes.func,
+	/**
+	* Provide a function that is called when menu is closed
+	*/
 	onClose: PropTypes.func,
+	/**
+	* Provide a function that is called when the close button is clicked
+	*/
 	onCloseButtonClick: PropTypes.func,
+	/**
+	* Provide an accessible role to be used. Defaults to `alertdialog`. Any other
+	* value will disable the wrapping of focus. To remain accessible, additional
+	* work is required. See the storybook docs for more info:
+	* https://react.carbondesignsystem.com/?path=/docs/components-notifications-actionable--overview#using-the-role-prop
+	*/
 	role: PropTypes.string,
+	/**
+	* Provide a description for "status" icon that can be read by screen readers
+	*/
 	statusIconDescription: PropTypes.string,
+	/**
+	* Specify the subtitle
+	*/
 	subtitle: PropTypes.node,
+	/**
+	* Specify the title
+	*/
 	title: PropTypes.string
 };
 const mapping = {
@@ -518,9 +695,21 @@ function Callout({ actionButtonLabel, children, onActionButtonClick, title, titl
 	});
 }
 Callout.propTypes = {
+	/**
+	* Pass in the action button label that will be rendered within the ActionableNotification.
+	*/
 	actionButtonLabel: PropTypes.string,
+	/**
+	* Specify the content
+	*/
 	children: PropTypes.node,
+	/**
+	* Specify an optional className to be applied to the notification box
+	*/
 	className: PropTypes.string,
+	/**
+	* Specify what state the notification represents
+	*/
 	kind: deprecateValuesWithin(PropTypes.oneOf([
 		"error",
 		"info",
@@ -529,11 +718,29 @@ Callout.propTypes = {
 		"warning",
 		"warning-alt"
 	]), ["warning", "info"], propMappingFunction),
+	/**
+	* Specify whether you are using the low contrast variant of the Callout.
+	*/
 	lowContrast: PropTypes.bool,
+	/**
+	* Provide a function that is called when the action is clicked
+	*/
 	onActionButtonClick: PropTypes.func,
+	/**
+	* Provide a description for "status" icon that can be read by screen readers
+	*/
 	statusIconDescription: PropTypes.string,
+	/**
+	* Specify the subtitle
+	*/
 	subtitle: PropTypes.node,
+	/**
+	* Specify the title
+	*/
 	title: PropTypes.string,
+	/**
+	* Specify the id for the element containing the title
+	*/
 	titleId: PropTypes.string
 };
 let didWarnAboutDeprecation = false;

package/es/components/NumberInput/NumberInput.Skeleton.js

@@ -26,8 +26,17 @@ function NumberInputSkeleton({ hideLabel, className, size = "md", ...rest }) {
 	});
 }
 NumberInputSkeleton.propTypes = {
+	/**
+	* Specify an optional className to add to the form item wrapper.
+	*/
 	className: PropTypes.string,
+	/**
+	* Specify whether the label should be hidden, or not
+	*/
 	hideLabel: PropTypes.bool,
+	/**
+	* Specify the size of the Number Input.
+	*/
 	size: PropTypes.oneOf([
 		"sm",
 		"md",