@carbon/react 1.110.0 → 1.111.0-rc.0

package/es/components/FluidMultiSelect/FluidMultiSelect.js

@@ -9,8 +9,8 @@ import { usePrefix } from "../../internal/usePrefix.js";
 import { FormContext } from "../FluidForm/FormContext.js";
 import { FilterableMultiSelect } from "../MultiSelect/FilterableMultiSelect.js";
 import { MultiSelect } from "../MultiSelect/MultiSelect.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/FluidMultiSelect/FluidMultiSelect.tsx
@@ -37,39 +37,167 @@ const FluidMultiSelect = React.forwardRef(function FluidMultiSelect({ className,
 	});
 });
 FluidMultiSelect.propTypes = {
+	/**
+	* Specify an optional className to be applied to the outer FluidForm wrapper
+	*/
 	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,
+	/**
+	* Specify the direction of the multiselect dropdown. Can be either top or bottom.
+	*/
 	direction: PropTypes.oneOf(["top", "bottom"]),
+	/**
+	* Specify whether the `<input>` should be disabled
+	*/
 	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,
+	/**
+	* Specify a custom `id` for the `<input>`
+	*/
 	id: PropTypes.string.isRequired,
+	/**
+	* Allow users to pass in arbitrary items from their collection that are
+	* pre-selected
+	*/
 	initialSelectedItems: PropTypes.array,
+	/**
+	* Specify if the currently selected value is invalid.
+	*/
 	invalid: PropTypes.bool,
+	/**
+	* Provide the text that is displayed when the control is in an invalid state
+	*/
 	invalidText: PropTypes.node,
+	/**
+	* Specify if the `FluidMultiSelect` should render its menu items in condensed mode
+	*/
 	isCondensed: PropTypes.bool,
+	/**
+	* Specify if the `FluidMultiSelect` should render the `filterable` variant of `FluidMultiSelect`
+	*/
 	isFilterable: PropTypes.bool,
+	/**
+	* 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,
+	/**
+	* 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,
+	/**
+	* **Filterable variant only** - `onInputValueChange` is a utility for this controlled component to communicate to
+	* the currently typed input.
+	*/
 	onInputValueChange: 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,
+	/**
+	* Whether or not the Multiselect 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"
 	]),
+	/**
+	* 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 the title text that will be read by a screen reader when
+	* visiting this control
+	*/
 	titleText: PropTypes.node,
+	/**
+	* Translates component strings using your i18n tool.
+	*/
 	translateWithId: PropTypes.func,
+	/**
+	* 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/FluidNumberInput/FluidNumberInput.Skeleton.js

@@ -7,8 +7,8 @@
 
 import { usePrefix } from "../../internal/usePrefix.js";
 import { FormContext } from "../FluidForm/FormContext.js";
-import "react";
 import classNames from "classnames";
+import "react";
 import PropTypes from "prop-types";
 import { jsx, jsxs } from "react/jsx-runtime";
 //#region src/components/FluidNumberInput/FluidNumberInput.Skeleton.tsx
@@ -29,6 +29,10 @@ const FluidNumberInputSkeleton = ({ className, ...other }) => {
 		})
 	});
 };
-FluidNumberInputSkeleton.propTypes = { className: PropTypes.string };
+FluidNumberInputSkeleton.propTypes = { 
+/**
+* Specify an optional className to be applied to the outer FluidForm wrapper
+*/
+className: PropTypes.string };
 //#endregion
 export { FluidNumberInputSkeleton as default };

package/es/components/FluidNumberInput/FluidNumberInput.js

@@ -9,8 +9,8 @@ import { usePrefix } from "../../internal/usePrefix.js";
 import { FormContext } from "../FluidForm/FormContext.js";
 import { NumberFormatOptionsPropType } from "../NumberInput/NumberFormatPropTypes.js";
 import { NumberInput } from "../NumberInput/NumberInput.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/FluidNumberInput/FluidNumberInput.tsx
@@ -32,14 +32,47 @@ const FluidNumberInput = React.forwardRef(({ className, ...other }, ref) => {
 	});
 });
 FluidNumberInput.propTypes = {
+	/**
+	* `true` to allow empty string.
+	*/
 	allowEmpty: PropTypes.bool,
+	/**
+	* Specify an optional className to be applied to the wrapper node
+	*/
 	className: PropTypes.string,
+	/**
+	* Optional starting value for uncontrolled state
+	*/
 	defaultValue: PropTypes.oneOfType([PropTypes.number, PropTypes.string]),
+	/**
+	* Specify if the wheel functionality for the input should be disabled, or not
+	*/
 	disableWheel: PropTypes.bool,
+	/**
+	* Specify if the control should be disabled, or not
+	*/
 	disabled: PropTypes.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: NumberFormatOptionsPropType,
+	/**
+	* Provide a description for up/down icons that can be read by screen readers
+	*/
 	iconDescription: PropTypes.string,
+	/**
+	* Specify a custom `id` for the input
+	*/
 	id: PropTypes.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: PropTypes.oneOf([
 		"none",
 		"text",
@@ -50,22 +83,84 @@ FluidNumberInput.propTypes = {
 		"decimal",
 		"search"
 	]),
+	/**
+	* Specify if the currently value is invalid.
+	*/
 	invalid: PropTypes.bool,
+	/**
+	* Message which is displayed if the value is invalid.
+	*/
 	invalidText: PropTypes.node,
+	/**
+	* Generic `label` that will be used as the textual representation of what
+	* this field is for
+	*/
 	label: PropTypes.node,
+	/**
+	* **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: PropTypes.string,
+	/**
+	* The maximum value.
+	*/
 	max: PropTypes.number,
+	/**
+	* The minimum value.
+	*/
 	min: PropTypes.number,
+	/**
+	* 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: PropTypes.func,
+	/**
+	* Provide an optional function to be called when the up/down button is clicked
+	*/
 	onClick: PropTypes.func,
+	/**
+	* Provide an optional function to be called when a key is pressed in the number input
+	*/
 	onKeyUp: PropTypes.func,
+	/**
+	* When type="text", provide an optional pattern to restrict user input. Has
+	* no effect when type="number".
+	*/
 	pattern: PropTypes.string,
+	/**
+	* Specify how much the values should increase/decrease upon clicking on up/down button
+	*/
 	step: PropTypes.number,
+	/**
+	* Translates component strings using your i18n tool.
+	*/
 	translateWithId: PropTypes.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: PropTypes.oneOf(["number", "text"]),
+	/**
+	* Specify the value of the input
+	*/
 	value: PropTypes.oneOfType([PropTypes.number, PropTypes.string]),
+	/**
+	* 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,
+	/**
+	* Whether or not the component is readonly
+	*/
 	readOnly: PropTypes.bool
 };
 //#endregion

package/es/components/FluidSearch/FluidSearch.Skeleton.js

@@ -7,8 +7,8 @@
 
 import { usePrefix } from "../../internal/usePrefix.js";
 import { FormContext } from "../FluidForm/FormContext.js";
-import "react";
 import classNames from "classnames";
+import "react";
 import PropTypes from "prop-types";
 import { jsx, jsxs } from "react/jsx-runtime";
 //#region src/components/FluidSearch/FluidSearch.Skeleton.tsx
@@ -29,6 +29,10 @@ const FluidSearchSkeleton = ({ className, ...other }) => {
 		})
 	});
 };
-FluidSearchSkeleton.propTypes = { className: PropTypes.string };
+FluidSearchSkeleton.propTypes = { 
+/**
+* Specify an optional className to be applied to the outer FluidForm wrapper
+*/
+className: PropTypes.string };
 //#endregion
 export { FluidSearchSkeleton as default };

package/es/components/FluidSearch/FluidSearch.js

@@ -8,8 +8,8 @@
 import { usePrefix } from "../../internal/usePrefix.js";
 import { FormContext } from "../FluidForm/FormContext.js";
 import Search_default from "../Search/index.js";
-import { forwardRef } from "react";
 import classNames from "classnames";
+import { forwardRef } from "react";
 import PropTypes from "prop-types";
 import { jsx } from "react/jsx-runtime";
 //#region src/components/FluidSearch/FluidSearch.tsx
@@ -31,19 +31,64 @@ const FluidSearch = forwardRef(({ className, ...other }, ref) => {
 	});
 });
 FluidSearch.propTypes = {
+	/**
+	* Specify an optional value for the `autocomplete` property on the underlying
+	* `<input>`, defaults to "off"
+	*/
 	autoComplete: PropTypes.string,
+	/**
+	* Specify an optional className to be applied to the container node
+	*/
 	className: PropTypes.string,
+	/**
+	* Specify a label to be read by screen readers on the "close" button
+	*/
 	closeButtonLabelText: PropTypes.string,
+	/**
+	* Optionally provide the default value of the `<input>`
+	*/
 	defaultValue: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
+	/**
+	* Specify whether the `<input>` should be disabled
+	*/
 	disabled: PropTypes.bool,
+	/**
+	* Specify a custom `id` for the input
+	*/
 	id: PropTypes.string,
+	/**
+	* Provide the label text for the Search icon
+	*/
 	labelText: PropTypes.node.isRequired,
+	/**
+	* Optional callback called when the search value changes.
+	*/
 	onChange: PropTypes.func,
+	/**
+	* Optional callback called when the search value is cleared.
+	*/
 	onClear: PropTypes.func,
+	/**
+	* Provide a handler that is invoked on the key down event for the input
+	*/
 	onKeyDown: PropTypes.func,
+	/**
+	* Provide an optional placeholder text for the Search.
+	* Note: if the label and placeholder differ,
+	* VoiceOver on Mac will read both
+	*/
 	placeholder: PropTypes.string,
+	/**
+	* Specify the role for the underlying `<input>`, defaults to `searchbox`
+	*/
 	role: PropTypes.string,
+	/**
+	* Optional prop to specify the type of the `<input>`
+	*/
 	type: PropTypes.string,
+	/**
+	* Specify the value of the `<input>`
+	*/
 	value: PropTypes.oneOfType([PropTypes.string, PropTypes.number])
 };
 //#endregion

package/es/components/FluidSelect/FluidSelect.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/FluidSelect/FluidSelect.Skeleton.tsx
@@ -28,6 +28,10 @@ const FluidSelectSkeleton = ({ className, ...rest }) => {
 		})
 	});
 };
-FluidSelectSkeleton.propTypes = { className: PropTypes.string };
+FluidSelectSkeleton.propTypes = { 
+/**
+* Specify an optional className to add.
+*/
+className: PropTypes.string };
 //#endregion
 export { FluidSelectSkeleton as default };

package/es/components/FluidSelect/FluidSelect.js

@@ -8,8 +8,8 @@
 import { usePrefix } from "../../internal/usePrefix.js";
 import { FormContext } from "../FluidForm/FormContext.js";
 import Select_default from "../Select/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/FluidSelect/FluidSelect.tsx
@@ -32,17 +32,55 @@ const FluidSelect = React.forwardRef(({ className, children, ...other }, ref) =>
 	});
 });
 FluidSelect.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,
+	/**
+	* Optionally provide the default value of the `<select>`
+	*/
 	defaultValue: PropTypes.any,
+	/**
+	* Specify whether the control is disabled
+	*/
 	disabled: PropTypes.bool,
+	/**
+	* Specify a custom `id` for the `<select>`
+	*/
 	id: PropTypes.string.isRequired,
+	/**
+	* Specify if the currently value is invalid.
+	*/
 	invalid: PropTypes.bool,
+	/**
+	* Message which is displayed if the value is invalid.
+	*/
 	invalidText: PropTypes.node,
+	/**
+	* Provide label text to be read by screen readers when interacting with the
+	* control
+	*/
 	labelText: PropTypes.node,
+	/**
+	* Provide an optional `onChange` hook that is called each time the value of
+	* the underlying `<input>` changes
+	*/
 	onChange: PropTypes.func,
+	/**
+	* 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,
+	/**
+	* Whether or not the component is readonly
+	*/
 	readOnly: PropTypes.bool
 };
 //#endregion

package/es/components/FluidTextArea/FluidTextArea.Skeleton.js

@@ -7,8 +7,8 @@
 
 import { usePrefix } from "../../internal/usePrefix.js";
 import { FormContext } from "../FluidForm/FormContext.js";
-import "react";
 import classNames from "classnames";
+import "react";
 import PropTypes from "prop-types";
 import { jsx, jsxs } from "react/jsx-runtime";
 //#region src/components/FluidTextArea/FluidTextArea.Skeleton.tsx
@@ -29,6 +29,10 @@ const FluidTextAreaSkeleton = ({ className, ...other }) => {
 		})
 	});
 };
-FluidTextAreaSkeleton.propTypes = { className: PropTypes.string };
+FluidTextAreaSkeleton.propTypes = { 
+/**
+* Specify an optional className to be applied to the outer FluidForm wrapper
+*/
+className: PropTypes.string };
 //#endregion
 export { FluidTextAreaSkeleton as default };

package/es/components/FluidTextArea/FluidTextArea.js

@@ -9,8 +9,8 @@ import { usePrefix } from "../../internal/usePrefix.js";
 import { deprecate } from "../../prop-types/deprecate.js";
 import { FormContext } from "../FluidForm/FormContext.js";
 import TextArea_default from "../TextArea/index.js";
-import "react";
 import classNames from "classnames";
+import "react";
 import PropTypes from "prop-types";
 import { jsx } from "react/jsx-runtime";
 //#region src/components/FluidTextArea/FluidTextArea.tsx
@@ -31,26 +31,93 @@ const FluidTextArea = ({ className, ...other }) => {
 	});
 };
 FluidTextArea.propTypes = {
+	/**
+	* Provide a custom className that is applied to the wrapper node
+	*/
 	className: PropTypes.string,
+	/**
+	* Specify the `cols` attribute for the underlying `<textarea>` node
+	*/
 	cols: PropTypes.number,
+	/**
+	* Optionally provide the default value of the `<textarea>`
+	*/
 	defaultValue: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
+	/**
+	* Specify whether the control is disabled
+	*/
 	disabled: PropTypes.bool,
+	/**
+	* Specify whether to display the character counter
+	*/
 	enableCounter: PropTypes.bool,
+	/**
+	* Provide text that is used alongside the control label for additional help
+	*/
 	helperText: PropTypes.node,
+	/**
+	* Specify whether you want the underlying label to be visually hidden
+	*/
 	hideLabel: PropTypes.bool,
+	/**
+	* Provide a unique identifier for the control
+	*/
 	id: PropTypes.string,
+	/**
+	* Specify whether the control is currently invalid
+	*/
 	invalid: PropTypes.bool,
+	/**
+	* Provide the text that is displayed when the control is in an invalid state
+	*/
 	invalidText: PropTypes.node,
+	/**
+	* Provide the text that will be read by a screen reader when visiting this
+	* control
+	*/
 	labelText: PropTypes.node.isRequired,
+	/**
+	* `true` to use the light version. For use on $ui-01 backgrounds only.
+	* Don't use this to make tile background color same as container background color.
+	*/
 	light: deprecate(PropTypes.bool, "The `light` prop for `FluidTextArea` has been deprecated in favor of the new `Layer` component. It will be removed in the next major release."),
+	/**
+	* Max character count allowed for the textarea. This is needed in order for enableCounter to display
+	*/
 	maxCount: PropTypes.number,
+	/**
+	* Optionally provide an `onChange` handler that is called whenever `<textarea>`
+	* is updated
+	*/
 	onChange: PropTypes.func,
+	/**
+	* Optionally provide an `onClick` handler that is called whenever the
+	* `<textarea>` is clicked
+	*/
 	onClick: PropTypes.func,
+	/**
+	* Specify the placeholder attribute for the `<textarea>`
+	*/
 	placeholder: PropTypes.string,
+	/**
+	* Specify the rows attribute for the `<textarea>`
+	*/
 	rows: PropTypes.number,
+	/**
+	* Provide the current value of the `<textarea>`
+	*/
 	value: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
+	/**
+	* 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,
+	/**
+	* Whether or not the component is readonly
+	*/
 	readOnly: PropTypes.bool
 };
 //#endregion