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

package/lib/components/Notification/Notification.js

@@ -62,9 +62,21 @@ function NotificationActionButton({ children, className: customClassName, onClic
 	});
 }
 NotificationActionButton.propTypes = {
+	/**
+	* Specify the content of the notification action button.
+	*/
 	children: prop_types.default.node,
+	/**
+	* Specify an optional className to be applied to the notification action button
+	*/
 	className: prop_types.default.string,
+	/**
+	* Specify if the visual treatment of the button should be for an inline notification
+	*/
 	inline: prop_types.default.bool,
+	/**
+	* Optionally specify a click handler for the notification action button.
+	*/
 	onClick: prop_types.default.func
 };
 function NotificationButton({ "aria-label": ariaLabel = "close notification", ariaLabel: deprecatedAriaLabel, className, type = "button", renderIcon: IconTag = _carbon_icons_react.Close, name, notificationType = "toast", ...rest }) {
@@ -84,16 +96,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"]: 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`."),
+	/**
+	* Specify an optional className to be applied to the notification button
+	*/
 	className: prop_types.default.string,
+	/**
+	* Specify an optional icon for the Button through a string,
+	* if something but regular "close" icon is desirable
+	*/
 	name: prop_types.default.string,
+	/**
+	* Specify the notification type
+	*/
 	notificationType: prop_types.default.oneOf([
 		"toast",
 		"inline",
 		"actionable"
 	]),
+	/**
+	* A component used to render an icon.
+	*/
 	renderIcon: prop_types.default.oneOfType([prop_types.default.func, prop_types.default.object]),
+	/**
+	* Optional prop to specify the type of the Button
+	*/
 	type: prop_types.default.string
 };
 /**
@@ -205,12 +240,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"]: prop_types.default.string,
+	/**
+	* Deprecated, please use `aria-label` instead.
+	* Provide a description for "close" icon button that can be read by screen readers
+	*/
 	ariaLabel: require_deprecate.deprecate(prop_types.default.string, "This prop syntax has been deprecated. Please use the new `aria-label`."),
+	/**
+	* Specify the caption
+	*/
 	caption: prop_types.default.string,
+	/**
+	* Specify the content
+	*/
 	children: prop_types.default.node,
+	/**
+	* Specify an optional className to be applied to the notification box
+	*/
 	className: prop_types.default.string,
+	/**
+	* Specify the close button should be disabled, or not
+	*/
 	hideCloseButton: prop_types.default.bool,
+	/**
+	* Specify what state the notification represents
+	*/
 	kind: prop_types.default.oneOf([
 		"error",
 		"info",
@@ -219,17 +276,42 @@ ToastNotification.propTypes = {
 		"warning",
 		"warning-alt"
 	]),
+	/**
+	* Specify whether you are using the low contrast variant of the ToastNotification.
+	*/
 	lowContrast: prop_types.default.bool,
+	/**
+	* Provide a function that is called when menu is closed
+	*/
 	onClose: prop_types.default.func,
+	/**
+	* Provide a function that is called when the close button is clicked
+	*/
 	onCloseButtonClick: prop_types.default.func,
+	/**
+	* By default, this value is "status". You can also provide an alternate
+	* role if it makes sense from the accessibility-side
+	*/
 	role: prop_types.default.oneOf([
 		"alert",
 		"log",
 		"status"
 	]),
+	/**
+	* Provide a description for "status" icon that can be read by screen readers
+	*/
 	statusIconDescription: prop_types.default.string,
+	/**
+	* Specify the subtitle
+	*/
 	subtitle: prop_types.default.string,
+	/**
+	* Specify an optional duration the notification should be closed in
+	*/
 	timeout: prop_types.default.number,
+	/**
+	* Specify the title
+	*/
 	title: prop_types.default.string
 };
 function InlineNotification({ ["aria-label"]: ariaLabel, children, title, subtitle, role = "status", onClose, onCloseButtonClick = require_noopFn.noopFn, statusIconDescription, className, kind = "error", lowContrast, hideCloseButton = false, ...rest }) {
@@ -288,10 +370,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"]: prop_types.default.string,
+	/**
+	* Specify the content
+	*/
 	children: prop_types.default.node,
+	/**
+	* Specify an optional className to be applied to the notification box
+	*/
 	className: prop_types.default.string,
+	/**
+	* Specify the close button should be disabled, or not
+	*/
 	hideCloseButton: prop_types.default.bool,
+	/**
+	* Specify what state the notification represents
+	*/
 	kind: prop_types.default.oneOf([
 		"error",
 		"info",
@@ -300,16 +397,38 @@ InlineNotification.propTypes = {
 		"warning",
 		"warning-alt"
 	]),
+	/**
+	* Specify whether you are using the low contrast variant of the InlineNotification.
+	*/
 	lowContrast: prop_types.default.bool,
+	/**
+	* Provide a function that is called when menu is closed
+	*/
 	onClose: prop_types.default.func,
+	/**
+	* Provide a function that is called when the close button is clicked
+	*/
 	onCloseButtonClick: prop_types.default.func,
+	/**
+	* By default, this value is "status". You can also provide an alternate
+	* role if it makes sense from the accessibility-side.
+	*/
 	role: prop_types.default.oneOf([
 		"alert",
 		"log",
 		"status"
 	]),
+	/**
+	* Provide a description for "status" icon that can be read by screen readers
+	*/
 	statusIconDescription: prop_types.default.string,
+	/**
+	* Specify the subtitle
+	*/
 	subtitle: prop_types.default.string,
+	/**
+	* Specify the title
+	*/
 	title: prop_types.default.string
 };
 function ActionableNotification({ actionButtonLabel, ["aria-label"]: ariaLabel, ariaLabel: deprecatedAriaLabel, caption, children, role = "alertdialog", onActionButtonClick, onClose, onCloseButtonClick = require_noopFn.noopFn, statusIconDescription, className, inline = false, kind = "error", lowContrast, hideCloseButton = false, hasFocus = true, closeOnEscape = true, title, subtitle, ...rest }) {
@@ -439,16 +558,47 @@ function ActionableNotification({ actionButtonLabel, ["aria-label"]: ariaLabel,
 	});
 }
 ActionableNotification.propTypes = {
+	/**
+	* Pass in the action button label that will be rendered within the ActionableNotification.
+	*/
 	actionButtonLabel: prop_types.default.string,
+	/**
+	* Provide a description for "close" icon button that can be read by screen readers
+	*/
 	["aria-label"]: prop_types.default.string,
+	/**
+	* Deprecated, please use `aria-label` instead.
+	* Provide a description for "close" icon button that can be read by screen readers
+	*/
 	ariaLabel: require_deprecate.deprecate(prop_types.default.string, "This prop syntax has been deprecated. Please use the new `aria-label`."),
+	/**
+	* Specify the caption
+	*/
 	caption: prop_types.default.string,
+	/**
+	* Specify the content
+	*/
 	children: prop_types.default.node,
+	/**
+	* Specify an optional className to be applied to the notification box
+	*/
 	className: prop_types.default.string,
+	/**
+	* Specify if pressing the escape key should close notifications
+	*/
 	closeOnEscape: prop_types.default.bool,
+	/**
+	* Specify if focus should be moved to the component when the notification contains actions
+	*/
 	hasFocus: require_deprecate.deprecate(prop_types.default.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: prop_types.default.bool,
 	inline: prop_types.default.bool,
+	/**
+	* Specify what state the notification represents
+	*/
 	kind: prop_types.default.oneOf([
 		"error",
 		"info",
@@ -457,13 +607,40 @@ ActionableNotification.propTypes = {
 		"warning",
 		"warning-alt"
 	]),
+	/**
+	* Specify whether you are using the low contrast variant of the ActionableNotification.
+	*/
 	lowContrast: prop_types.default.bool,
+	/**
+	* Provide a function that is called when the action is clicked
+	*/
 	onActionButtonClick: prop_types.default.func,
+	/**
+	* Provide a function that is called when menu is closed
+	*/
 	onClose: prop_types.default.func,
+	/**
+	* Provide a function that is called when the close button is clicked
+	*/
 	onCloseButtonClick: prop_types.default.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: prop_types.default.string,
+	/**
+	* Provide a description for "status" icon that can be read by screen readers
+	*/
 	statusIconDescription: prop_types.default.string,
+	/**
+	* Specify the subtitle
+	*/
 	subtitle: prop_types.default.node,
+	/**
+	* Specify the title
+	*/
 	title: prop_types.default.string
 };
 const mapping = {
@@ -522,9 +699,21 @@ function Callout({ actionButtonLabel, children, onActionButtonClick, title, titl
 	});
 }
 Callout.propTypes = {
+	/**
+	* Pass in the action button label that will be rendered within the ActionableNotification.
+	*/
 	actionButtonLabel: prop_types.default.string,
+	/**
+	* Specify the content
+	*/
 	children: prop_types.default.node,
+	/**
+	* Specify an optional className to be applied to the notification box
+	*/
 	className: prop_types.default.string,
+	/**
+	* Specify what state the notification represents
+	*/
 	kind: require_deprecateValuesWithin.deprecateValuesWithin(prop_types.default.oneOf([
 		"error",
 		"info",
@@ -533,11 +722,29 @@ Callout.propTypes = {
 		"warning",
 		"warning-alt"
 	]), ["warning", "info"], propMappingFunction),
+	/**
+	* Specify whether you are using the low contrast variant of the Callout.
+	*/
 	lowContrast: prop_types.default.bool,
+	/**
+	* Provide a function that is called when the action is clicked
+	*/
 	onActionButtonClick: prop_types.default.func,
+	/**
+	* Provide a description for "status" icon that can be read by screen readers
+	*/
 	statusIconDescription: prop_types.default.string,
+	/**
+	* Specify the subtitle
+	*/
 	subtitle: prop_types.default.node,
+	/**
+	* Specify the title
+	*/
 	title: prop_types.default.string,
+	/**
+	* Specify the id for the element containing the title
+	*/
 	titleId: prop_types.default.string
 };
 let didWarnAboutDeprecation = false;

package/lib/components/NumberInput/NumberInput.Skeleton.js

@@ -30,8 +30,17 @@ function NumberInputSkeleton({ hideLabel, className, size = "md", ...rest }) {
 	});
 }
 NumberInputSkeleton.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,
+	/**
+	* Specify the size of the Number Input.
+	*/
 	size: prop_types.default.oneOf([
 		"sm",
 		"md",

package/lib/components/NumberInput/NumberInput.js

@@ -471,18 +471,63 @@ const NumberInput = react.default.forwardRef((props, forwardRef) => {
 	});
 });
 NumberInput.propTypes = {
+	/**
+	* `true` to allow empty string.
+	*/
 	allowEmpty: prop_types.default.bool,
+	/**
+	* Specify an optional className to be applied to the wrapper node
+	*/
 	className: prop_types.default.string,
+	/**
+	* **Experimental**: Provide a `decorator` component to be rendered inside the `NumberInput` component
+	*/
 	decorator: prop_types.default.node,
+	/**
+	* Optional starting value for uncontrolled state
+	*/
 	defaultValue: prop_types.default.oneOfType([prop_types.default.number, prop_types.default.string]),
+	/**
+	* Specify if the wheel functionality for the input should be disabled, or no t
+	*/
 	disableWheel: prop_types.default.bool,
+	/**
+	* Specify if the control should be disabled, or not
+	*/
 	disabled: prop_types.default.bool,
+	/**
+	* **Experimental:** Specify Intl.NumberFormat options applied to internal
+	* number parsing and formatting. Use with `type="text"`, has no effect when
+	* `type="number"`.
+	* @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat#options
+	*/
 	formatOptions: require_NumberFormatPropTypes.NumberFormatOptionsPropType,
+	/**
+	* 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,
+	/**
+	* Specify whether you want the steppers to be hidden
+	*/
 	hideSteppers: prop_types.default.bool,
+	/**
+	* Provide a description for up/down icons that can be read by screen readers
+	*/
 	iconDescription: prop_types.default.string,
+	/**
+	* Specify a custom `id` for the input
+	*/
 	id: prop_types.default.string.isRequired,
+	/**
+	* Instruct the browser which keyboard to display on mobile devices. Defaults
+	* to `decimal`, but note that standard numeric keyboards vary across devices
+	* and operating systems.
+	* @see https://css-tricks.com/everything-you-ever-wanted-to-know-about-inputmode/
+	*/
 	inputMode: prop_types.default.oneOf([
 		"none",
 		"text",
@@ -493,33 +538,126 @@ NumberInput.propTypes = {
 		"decimal",
 		"search"
 	]),
+	/**
+	* Specify if the currently value is invalid.
+	*/
 	invalid: prop_types.default.bool,
+	/**
+	* Message which is displayed if the value is invalid.
+	*/
 	invalidText: prop_types.default.node,
+	/**
+	* Generic `label` that will be used as the textual representation of what
+	* this field is for
+	*/
 	label: prop_types.default.node,
+	/**
+	* `true` to use the light version.
+	*/
 	light: require_deprecate.deprecate(prop_types.default.bool, "The `light` prop for `NumberInput` is no longer needed and has been deprecated in v11 in favor of the new `Layer` component. It will be moved in the next major release."),
+	/**
+	* **Experimental:** Specify a [BCP47](https://www.ietf.org/rfc/bcp/bcp47.txt)
+	* language code for parsing and formatting. Use with `type="text"`, has no
+	* effect when `type="number"`.
+	*/
 	locale: prop_types.default.string,
+	/**
+	* The maximum value.
+	*/
 	max: prop_types.default.number,
+	/**
+	* The minimum value.
+	*/
 	min: prop_types.default.number,
+	/**
+	* Provide the value stepping should begin at when the input is empty
+	*/
 	stepStartValue: prop_types.default.number,
+	/**
+	* Provide an optional handler that is called when the input is blurred.
+	*/
 	onBlur: prop_types.default.func,
+	/**
+	* Provide an optional handler that is called when the stepper
+	* buttons are blurred.
+	*/
 	onStepperBlur: prop_types.default.func,
+	/**
+	* Provide an optional handler that is called when the internal state of
+	* NumberInput changes. This handler is called with event and state info.
+	* When type="number", this is called on every change of the input.
+	* When type="text", this is only called on blur after the number has been
+	* parsed and formatted.
+	* `(event, { value, direction }) => void`
+	*/
 	onChange: prop_types.default.func,
+	/**
+	* Provide an optional function to be called when the up/down button is clicked
+	*/
 	onClick: prop_types.default.func,
+	/**
+	* Provide an optional function to be called when a key is pressed in the number input
+	*/
 	onKeyUp: prop_types.default.func,
+	/**
+	* When type="text", provide an optional pattern to restrict user input. Has
+	* no effect when type="number".
+	*/
 	pattern: prop_types.default.string,
+	/**
+	* Specify if the component should be read-only
+	*/
 	readOnly: prop_types.default.bool,
+	/**
+	* Specify the size of the Number Input.
+	*/
 	size: prop_types.default.oneOf([
 		"sm",
 		"md",
 		"lg"
 	]),
+	/**
+	* **Experimental**: Provide a `Slug` component to be rendered inside the
+	* `NumberInput` component
+	*/
 	slug: require_deprecate.deprecate(prop_types.default.node, "The `slug` prop for `NumberInput` is no longer needed and has been deprecated in v11 in favor of the new `decorator` prop. It will be moved in the next major release."),
+	/**
+	* Specify how much the values should increase/decrease upon clicking on
+	* up/down button
+	*/
 	step: prop_types.default.number,
+	/**
+	* Translates component strings using your i18n tool.
+	*/
 	translateWithId: prop_types.default.func,
+	/**
+	* **Experimental**: Specify if the input should be of type text or number.
+	* Use type="text" with `locale`, `formatOptions`, and guide user input with
+	* `pattern` and `inputMode`.
+	*/
 	type: prop_types.default.oneOf(["number", "text"]),
+	/**
+	* Specify the value of the input
+	*/
 	value: prop_types.default.oneOfType([prop_types.default.number, prop_types.default.string]),
+	/**
+	* 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,
+	/**
+	* Optional validation function that is called with the input value and locale.
+	*
+	* - Return `false` to immediately fail validation.
+	* - Return `true` to pass this validation, but still run other checks (min, max, required, etc.).
+	* - Return `undefined` to defer entirely to built-in validation logic.
+	*
+	* This is called before other validations, giving consumers the ability
+	* to short-circuit or extend validation without replacing built-in rules.
+	*/
 	validate: prop_types.default.func
 };
 const Label = ({ disabled, id, hideLabel, label }) => {

package/lib/components/OrderedList/OrderedList.js

@@ -34,10 +34,25 @@ function OrderedList({ className, nested = false, native = false, isExpressive =
 	});
 }
 OrderedList.propTypes = {
+	/**
+	* Provide list items to be rendered in the ordered list
+	*/
 	children: prop_types.default.node,
+	/**
+	* Provide an optional className to be applied to the containing <ol> node
+	*/
 	className: prop_types.default.string,
+	/**
+	* Specify whether this ordered list expressive or not
+	*/
 	isExpressive: prop_types.default.bool,
+	/**
+	* Specify whether this ordered list should use native list styles instead of custom counter
+	*/
 	native: prop_types.default.bool,
+	/**
+	* Specify whether this ordered list is nested inside of another nested list
+	*/
 	nested: prop_types.default.bool
 };
 //#endregion

package/lib/components/OverflowMenu/OverflowMenu.js

@@ -287,6 +287,9 @@ const OverflowMenu = (0, react.forwardRef)(({ align, ["aria-label"]: ariaLabel =
 	}) });
 });
 OverflowMenu.propTypes = {
+	/**
+	* Specify how the trigger should align with the tooltip
+	*/
 	align: require_deprecateValuesWithin.deprecateValuesWithin(prop_types.default.oneOf([
 		"top",
 		"top-left",
@@ -322,34 +325,107 @@ OverflowMenu.propTypes = {
 		"right-start",
 		"right-end"
 	], require_mapPopoverAlign.mapPopoverAlign),
+	/**
+	* 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`."),
+	/**
+	* The child nodes.
+	*/
 	children: prop_types.default.node,
+	/**
+	* The CSS class names.
+	*/
 	className: prop_types.default.string,
+	/**
+	* The menu direction.
+	*/
 	direction: prop_types.default.oneOf(["top", require_FloatingMenu.DIRECTION_BOTTOM]),
+	/**
+	* `true` if the menu alignment should be flipped.
+	*/
 	flipped: prop_types.default.bool,
+	/**
+	* @deprecated Tab key is handled with event handler so no need for focus trap.
+	* Enable or disable focus trap behavior
+	*/
 	focusTrap: prop_types.default.bool,
+	/**
+	* The CSS class for the icon.
+	*/
 	iconClass: prop_types.default.string,
+	/**
+	* The icon description.
+	*/
 	iconDescription: prop_types.default.string,
+	/**
+	* The element ID.
+	*/
 	id: prop_types.default.string,
+	/**
+	* `true` to use the light version. For use on $ui-01 backgrounds only.
+	* Don't use this to make OverflowMenu background color same as container background color.
+	*/
 	light: require_deprecate.deprecate(prop_types.default.bool, "The `light` prop for `OverflowMenu` is no longer needed and has been deprecated. It will be removed in the next major release. Use the Layer component instead."),
+	/**
+	* The adjustment in position applied to the floating menu.
+	*/
 	menuOffset: prop_types.default.oneOfType([prop_types.default.shape({
 		top: prop_types.default.number.isRequired,
 		left: prop_types.default.number.isRequired
 	}), prop_types.default.func]),
+	/**
+	* The adjustment in position applied to the floating menu when flipped.
+	*/
 	menuOffsetFlip: prop_types.default.oneOfType([prop_types.default.shape({
 		top: prop_types.default.number.isRequired,
 		left: prop_types.default.number.isRequired
 	}), prop_types.default.func]),
+	/**
+	* The class to apply to the menu options
+	*/
 	menuOptionsClass: prop_types.default.string,
+	/**
+	* The event handler for the `click` event.
+	*/
 	onClick: prop_types.default.func,
+	/**
+	* Function called when menu is closed
+	*/
 	onClose: prop_types.default.func,
+	/**
+	* The event handler for the `focus` event.
+	*/
 	onFocus: prop_types.default.func,
+	/**
+	* The event handler for the `keydown` event.
+	*/
 	onKeyDown: prop_types.default.func,
+	/**
+	* Function called when menu is opened
+	*/
 	onOpen: prop_types.default.func,
+	/**
+	* `true` if the menu should be open.
+	*/
 	open: prop_types.default.bool,
+	/**
+	* A component used to render an icon.
+	*/
 	renderIcon: prop_types.default.oneOfType([prop_types.default.func, prop_types.default.object]),
+	/**
+	* Specify a CSS selector that matches the DOM element that should
+	* be focused when the OverflowMenu opens
+	*/
 	selectorPrimaryFocus: prop_types.default.string,
+	/**
+	* Specify the size of the OverflowMenu. Currently supports either `xs`, `sm`, `md` (default) or `lg` as an option.
+	*/
 	size: prop_types.default.oneOf([
 		"xs",
 		"sm",