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

package/es/components/Slider/Slider.js

@@ -826,38 +826,142 @@ const Slider = (props) => {
 	});
 };
 Slider.propTypes = {
+	/**
+	* The `ariaLabel` for the `<input>`.
+	*/
 	ariaLabelInput: PropTypes.string,
+	/**
+	* The child nodes.
+	*/
 	children: PropTypes.node,
+	/**
+	* The CSS class name for the slider.
+	*/
 	className: PropTypes.string,
+	/**
+	* `true` to disable this slider.
+	*/
 	disabled: PropTypes.bool,
+	/**
+	* The callback to format the label associated with the minimum/maximum value.
+	*/
 	formatLabel: PropTypes.func,
+	/**
+	* `true` to hide the number input box.
+	*/
 	hideTextInput: PropTypes.bool,
+	/**
+	* The ID of the `<input>`.
+	*/
 	id: PropTypes.string,
+	/**
+	* The `type` attribute of the `<input>`.
+	*/
 	inputType: PropTypes.string,
+	/**
+	* `Specify whether the Slider is currently invalid
+	*/
 	invalid: PropTypes.bool,
+	/**
+	* Provide the text that is displayed when the Slider is in an invalid state
+	*/
 	invalidText: PropTypes.node,
+	/**
+	* The label for the slider.
+	*/
 	labelText: PropTypes.node,
+	/**
+	* Specify whether you want the underlying label to be visually hidden
+	*/
 	hideLabel: PropTypes.bool,
+	/**
+	* `true` to use the light version.
+	*/
 	light: deprecate(PropTypes.bool, "The `light` prop for `Slider` 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."),
+	/**
+	* The maximum value.
+	*/
 	max: PropTypes.number.isRequired,
+	/**
+	* The label associated with the maximum value.
+	*/
 	maxLabel: PropTypes.string,
+	/**
+	* The minimum value.
+	*/
 	min: PropTypes.number.isRequired,
+	/**
+	* The label associated with the minimum value.
+	*/
 	minLabel: PropTypes.string,
+	/**
+	* The `name` attribute of the `<input>`.
+	*/
 	name: PropTypes.string,
+	/**
+	* Provide an optional function to be called when the input element
+	* loses focus
+	*/
 	onBlur: PropTypes.func,
+	/**
+	* The callback to get notified of change in value.
+	*/
 	onChange: PropTypes.func,
+	/**
+	* Provide an optional function to be called when a key is pressed in the number input.
+	*/
 	onInputKeyUp: PropTypes.func,
+	/**
+	* The callback to get notified of value on handle release.
+	*/
 	onRelease: PropTypes.func,
+	/**
+	* Whether the slider should be read-only
+	*/
 	readOnly: PropTypes.bool,
+	/**
+	* `true` to specify if the control is required.
+	*/
 	required: PropTypes.bool,
+	/**
+	* A value determining how much the value should increase/decrease by moving the thumb by mouse. If a value other than 1 is provided and the input is *not* hidden, the new step requirement should be added to a visible label. Values outside the `step` increment will be considered invalid.
+	*/
 	step: PropTypes.number,
+	/**
+	* A value determining how much the value should increase/decrease by Shift+arrow keys,
+	* which will be `(max - min) / stepMultiplier`.
+	*/
 	stepMultiplier: PropTypes.number,
+	/**
+	* Supply a method to translate internal strings with your i18n tool of
+	* choice. Translation keys are available on the `translationIds` field for
+	* this component.
+	*/
 	translateWithId: PropTypes.func,
+	/**
+	* The `ariaLabel` for the upper bound `<input>` when there are two handles.
+	*/
 	unstable_ariaLabelInputUpper: PropTypes.string,
+	/**
+	* The `name` attribute of the upper bound `<input>` when there are two handles.
+	*/
 	unstable_nameUpper: PropTypes.string,
+	/**
+	* The upper bound when there are two handles.
+	*/
 	unstable_valueUpper: PropTypes.number,
+	/**
+	* The value of the slider. When there are two handles, value is the lower
+	* bound.
+	*/
 	value: PropTypes.number.isRequired,
+	/**
+	* Specify whether the Slider is in a warning state.
+	*/
 	warn: PropTypes.bool,
+	/**
+	* Provide the text displayed when the Slider is in a warning state.
+	*/
 	warnText: PropTypes.node
 };
 //#endregion

package/es/components/Stack/Stack.js

@@ -57,10 +57,30 @@ const Stack = forwardRef((props, ref) => {
 	});
 });
 Stack.propTypes = {
+	/**
+	* Provide a custom element type to render as the outermost element in
+	* the Stack component. By default, this component will render a `div`.
+	*/
 	as: PropTypes.elementType,
+	/**
+	* Provide the elements that will be rendered as children inside of the Stack
+	* component. These elements will have having spacing between them according
+	* to the `step` and `orientation` prop
+	*/
 	children: PropTypes.node,
+	/**
+	* Provide a custom class name to be used by the outermost element rendered by
+	* Stack
+	*/
 	className: PropTypes.string,
+	/**
+	* Provide either a custom value or a step from the spacing scale to be used
+	* as the gap in the layout
+	*/
 	gap: PropTypes.oneOfType([PropTypes.string, PropTypes.oneOf(SPACING_STEPS)]),
+	/**
+	* Specify the orientation of them items in the Stack
+	*/
 	orientation: PropTypes.oneOf(["horizontal", "vertical"])
 };
 //#endregion

package/es/components/StructuredList/StructuredList.Skeleton.js

@@ -57,7 +57,13 @@ function StructuredListSkeleton({ rowCount = 5, className, ...rest }) {
 	});
 }
 StructuredListSkeleton.propTypes = {
+	/**
+	* Specify an optional className to add.
+	*/
 	className: PropTypes.string,
+	/**
+	* number of table rows
+	*/
 	rowCount: PropTypes.number
 };
 //#endregion

package/es/components/StructuredList/StructuredList.js

@@ -48,13 +48,38 @@ function StructuredListWrapper(props) {
 	});
 }
 StructuredListWrapper.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`."),
+	/**
+	* Provide the contents of your StructuredListWrapper
+	*/
 	children: PropTypes.node,
+	/**
+	* Specify an optional className to be applied to the container node
+	*/
 	className: PropTypes.string,
+	/**
+	* Specify if structured list is condensed, default is false
+	*/
 	isCondensed: PropTypes.bool,
+	/**
+	* Specify if structured list is flush, not valid for selection variant, default is false
+	*/
 	isFlush: PropTypes.bool,
+	/**
+	* Specify whether your StructuredListWrapper should have selections
+	*/
 	selection: PropTypes.bool,
+	/**
+	* Specify which row will be selected initially
+	*/
 	selectedInitialRow: PropTypes.string
 };
 function StructuredListHead(props) {
@@ -67,7 +92,13 @@ function StructuredListHead(props) {
 	});
 }
 StructuredListHead.propTypes = {
+	/**
+	* Provide the contents of your StructuredListHead
+	*/
 	children: PropTypes.node,
+	/**
+	* Specify an optional className to be applied to the node
+	*/
 	className: PropTypes.string
 };
 function StructuredListBody(props) {
@@ -80,9 +111,18 @@ function StructuredListBody(props) {
 	});
 }
 StructuredListBody.propTypes = {
+	/**
+	* Provide the contents of your StructuredListBody
+	*/
 	children: PropTypes.node,
+	/**
+	* Specify an optional className to be applied to the container node
+	*/
 	className: PropTypes.string,
 	head: PropTypes.bool,
+	/**
+	* Provide a handler that is invoked on the key down event for the control
+	*/
 	onKeyDown: PropTypes.func
 };
 const GridRowContext = React.createContext(null);
@@ -134,13 +174,37 @@ function StructuredListRow(props) {
 	});
 }
 StructuredListRow.propTypes = {
+	/**
+	* Provide the contents of your StructuredListRow
+	*/
 	children: PropTypes.node,
+	/**
+	* Specify an optional className to be applied to the container node
+	*/
 	className: PropTypes.string,
+	/**
+	* Specify whether your StructuredListRow should be used as a header row
+	*/
 	head: PropTypes.bool,
+	/**
+	* Specify whether a `<label>` should be used
+	*/
 	label: deprecate(PropTypes.bool, `\nThe \`label\` prop is no longer needed and will be removed in the next major version of Carbon.`),
+	/**
+	* Provide a handler that is invoked on the click
+	*/
 	onClick: PropTypes.func,
+	/**
+	* Provide a handler that is invoked on the key down event for the control,
+	*/
 	onKeyDown: PropTypes.func,
+	/**
+	* Mark if this row should be selectable
+	*/
 	selection: PropTypes.bool,
+	/**
+	* Specify row id so that it can be used for initial selection
+	*/
 	id: PropTypes.string
 };
 function StructuredListInput(props) {
@@ -168,12 +232,33 @@ function StructuredListInput(props) {
 	});
 }
 StructuredListInput.propTypes = {
+	/**
+	* Specify an optional className to be applied to the input
+	*/
 	className: PropTypes.string,
+	/**
+	* Specify whether the underlying input should be checked by default
+	*/
 	defaultChecked: deprecate(PropTypes.bool, `\nThe prop \`defaultChecked\` is no longer needed and will be removed in the next major version of Carbon.`),
+	/**
+	* Specify a custom `id` for the input
+	*/
 	id: PropTypes.string,
+	/**
+	* Provide a `name` for the input
+	*/
 	name: PropTypes.string,
+	/**
+	* Provide an optional hook that is called each time the input is updated
+	*/
 	onChange: PropTypes.func,
+	/**
+	* Provide a `title` for the input
+	*/
 	title: PropTypes.string,
+	/**
+	* Specify the value of the input
+	*/
 	value: deprecate(PropTypes.oneOfType([PropTypes.string, PropTypes.number]).isRequired, `\nThe prop \`value\` will be removed in the next major version of Carbon.`)
 };
 function StructuredListCell(props) {
@@ -199,9 +284,21 @@ function StructuredListCell(props) {
 	});
 }
 StructuredListCell.propTypes = {
+	/**
+	* Provide the contents of your StructuredListCell
+	*/
 	children: PropTypes.node,
+	/**
+	* Specify an optional className to be applied to the container node
+	*/
 	className: PropTypes.string,
+	/**
+	* Specify whether your StructuredListCell should be used as a header cell
+	*/
 	head: PropTypes.bool,
+	/**
+	* Specify whether your StructuredListCell should have text wrapping
+	*/
 	noWrap: PropTypes.bool
 };
 //#endregion

package/es/components/Switch/IconSwitch.js

@@ -77,6 +77,9 @@ const IconSwitch = forwardRef((props, ref) => {
 });
 IconSwitch.displayName = "IconSwitch";
 IconSwitch.propTypes = {
+	/**
+	* Specify how the trigger should align with the tooltip
+	*/
 	align: PropTypes.oneOf([
 		"top",
 		"top-left",
@@ -87,21 +90,65 @@ IconSwitch.propTypes = {
 		"left",
 		"right"
 	]),
+	/**
+	* Children to be rendered inside of the `IconSwitch`.
+	*/
 	children: PropTypes.node,
+	/**
+	* Specify an optional className to be added to your `IconSwitch`.
+	*/
 	className: PropTypes.string,
+	/**
+	* Whether the `IconSwitch` should be disabled.
+	*/
 	disabled: PropTypes.bool,
+	/**
+	* Specify the duration in milliseconds to delay before displaying the tooltip
+	*/
 	enterDelayMs: PropTypes.number,
+	/**
+	* The index of the `IconSwitch`.
+	*
+	* Reserved for usage in `ContentSwitcher`.
+	*/
 	index: PropTypes.number,
+	/**
+	* Specify the duration in milliseconds to delay before hiding the tooltip
+	*/
 	leaveDelayMs: PropTypes.number,
+	/**
+	* The name of the `IconSwitch`.
+	*/
 	name: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
+	/**
+	* A handler that is invoked when a user clicks on the control.
+	*
+	* Reserved for usage in `ContentSwitcher`.
+	*/
 	onClick: PropTypes.func,
+	/**
+	* A handler that is invoked on the key down event for the control.
+	*
+	* Reserved for usage in `ContentSwitcher`.
+	*/
 	onKeyDown: PropTypes.func,
+	/**
+	* Whether the `IconSwitch` is selected.
+	*
+	* Reserved for usage in `ContentSwitcher`.
+	*/
 	selected: PropTypes.bool,
+	/**
+	* Specify the size of the underlying icon-only button.
+	*/
 	size: PropTypes.oneOf([
 		"sm",
 		"md",
 		"lg"
 	]),
+	/**
+	* `Tooltip` text.
+	*/
 	text: PropTypes.string
 };
 //#endregion

package/es/components/Switch/Switch.js

@@ -61,14 +61,44 @@ const Switch = React.forwardRef((props, tabRef) => {
 });
 Switch.displayName = "Switch";
 Switch.propTypes = {
+	/**
+	* Provide child elements to be rendered inside of the Switch
+	*/
 	children: PropTypes.node,
+	/**
+	* Specify an optional className to be added to your Switch
+	*/
 	className: PropTypes.string,
+	/**
+	* Specify whether or not the Switch should be disabled
+	*/
 	disabled: PropTypes.bool,
+	/**
+	* The index of your Switch in your ContentSwitcher that is used for event handlers.
+	* Reserved for usage in ContentSwitcher
+	*/
 	index: PropTypes.number,
+	/**
+	* Provide the name of your Switch that is used for event handlers
+	*/
 	name: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
+	/**
+	* A handler that is invoked when a user clicks on the control.
+	* Reserved for usage in ContentSwitcher
+	*/
 	onClick: PropTypes.func,
+	/**
+	* A handler that is invoked on the key down event for the control.
+	* Reserved for usage in ContentSwitcher
+	*/
 	onKeyDown: PropTypes.func,
+	/**
+	* Whether your Switch is selected. Reserved for usage in ContentSwitcher
+	*/
 	selected: PropTypes.bool,
+	/**
+	* Provide the contents of your Switch
+	*/
 	text: PropTypes.string
 };
 //#endregion

package/es/components/TabContent/TabContent.js

@@ -30,8 +30,17 @@ function TabContent(props) {
 	});
 }
 TabContent.propTypes = {
+	/**
+	* Pass in content to render inside the TabContent
+	*/
 	children: PropTypes.node,
+	/**
+	* Provide a className for the tab content container
+	*/
 	className: PropTypes.string,
+	/**
+	* Specify whether the TabContent is selected
+	*/
 	selected: PropTypes.bool
 };
 //#endregion

package/es/components/Tabs/Tabs.Skeleton.js

@@ -45,7 +45,13 @@ function TabsSkeleton({ className, contained, ...rest }) {
 	});
 }
 TabsSkeleton.propTypes = {
+	/**
+	* Specify an optional className to add.
+	*/
 	className: PropTypes.string,
+	/**
+	* Provide the type of Tab
+	*/
 	contained: PropTypes.bool
 };
 //#endregion

package/es/components/Tabs/Tabs.d.ts

@@ -194,6 +194,9 @@ export interface TabListProps extends DivAttributes {
     scrollIntoView?: boolean;
     /**
      * Specify the size of the tabs.
+     *
+     * Supports `sm` and `md` for line tabs.
+     * Supports `sm`, `md`, and `lg` for contained tabs.
      */
     size?: 'sm' | 'md' | 'lg';
 }
@@ -256,6 +259,9 @@ declare namespace TabList {
         scrollIntoView: PropTypes.Requireable<boolean>;
         /**
          * Specify the size of the tabs.
+         *
+         * Supports `sm` and `md` for line tabs.
+         * Supports `sm`, `md`, and `lg` for contained tabs.
          */
         size: PropTypes.Requireable<string>;
     };
@@ -288,8 +294,12 @@ export interface TabListVerticalProps extends DivAttributes {
      * on component rerender
      */
     scrollIntoView?: boolean;
+    /**
+     * Specify the size of the tabs.
+     */
+    size?: 'sm' | 'md' | 'lg' | 'xl';
 }
-declare function TabListVertical({ activation, 'aria-label': label, children, className: customClassName, scrollIntoView, ...rest }: TabListVerticalProps): import("react/jsx-runtime").JSX.Element;
+declare function TabListVertical({ activation, 'aria-label': label, children, className: customClassName, scrollIntoView, size, ...rest }: TabListVerticalProps): import("react/jsx-runtime").JSX.Element;
 declare namespace TabListVertical {
     var propTypes: {
         /**
@@ -311,6 +321,10 @@ declare namespace TabListVertical {
          * Specify an optional className to be added to the container node
          */
         className: PropTypes.Requireable<string>;
+        /**
+         * Specify the size of the tabs.
+         */
+        size: PropTypes.Requireable<string>;
     };
 }
 /**