@carbon/react 1.110.0 → 1.111.0-rc.0

package/lib/components/DataTable/TableSelectRow.js

@@ -11,10 +11,10 @@ const require_useId = require("../../internal/useId.js");
 const require_deprecate = require("../../prop-types/deprecate.js");
 const require_index = require("../InlineCheckbox/index.js");
 const require_index$1 = require("../RadioButton/index.js");
-let react = require("react");
-react = require_runtime.__toESM(react);
 let classnames = require("classnames");
 classnames = require_runtime.__toESM(classnames);
+let react = require("react");
+react = require_runtime.__toESM(react);
 let prop_types = require("prop-types");
 prop_types = require_runtime.__toESM(prop_types);
 let react_jsx_runtime = require("react/jsx-runtime");
@@ -61,15 +61,46 @@ const TableSelectRow = ({ ariaLabel: deprecatedAriaLabel, ["aria-label"]: ariaLa
 	});
 };
 TableSelectRow.propTypes = {
+	/**
+	* Specify the aria label for the underlying input control
+	*/
 	["aria-label"]: prop_types.default.string,
+	/**
+	* Deprecated, please use `aria-label` instead.
+	* Specify the aria label for the underlying input control
+	*/
 	ariaLabel: require_deprecate.deprecate(prop_types.default.string, "This prop syntax has been deprecated. Please use the new `aria-label`."),
+	/**
+	* Specify whether this row is selected, or not
+	*/
 	checked: prop_types.default.bool,
+	/**
+	* The CSS class names of the cell that wraps the underlying input control
+	*/
 	className: prop_types.default.string,
+	/**
+	* Specify whether the control is disabled
+	*/
 	disabled: prop_types.default.bool,
+	/**
+	* Provide an `id` for the underlying input control
+	*/
 	id: prop_types.default.string.isRequired,
+	/**
+	* Provide a `name` for the underlying input control
+	*/
 	name: prop_types.default.string.isRequired,
+	/**
+	* Provide an optional hook that is called each time the input is updated
+	*/
 	onChange: prop_types.default.func,
+	/**
+	* Provide a handler to listen to when a user initiates a selection request
+	*/
 	onSelect: prop_types.default.func.isRequired,
+	/**
+	* Specify whether the control should be a radio button or inline checkbox
+	*/
 	radio: prop_types.default.bool
 };
 //#endregion

package/lib/components/DataTable/TableSlugRow.js

@@ -8,10 +8,10 @@
 const require_runtime = require("../../_virtual/_rolldown/runtime.js");
 const require_usePrefix = require("../../internal/usePrefix.js");
 const require_deprecateComponent = require("../../prop-types/deprecateComponent.js");
-let react = require("react");
-react = require_runtime.__toESM(react);
 let classnames = require("classnames");
 classnames = require_runtime.__toESM(classnames);
+let react = require("react");
+react = require_runtime.__toESM(react);
 let prop_types = require("prop-types");
 prop_types = require_runtime.__toESM(prop_types);
 let react_jsx_runtime = require("react/jsx-runtime");
@@ -38,7 +38,13 @@ const TableSlugRow = ({ className, slug }) => {
 };
 TableSlugRow.displayName = "TableSlugRow";
 TableSlugRow.propTypes = {
+	/**
+	* The CSS class names of the cell that wraps the underlying input control
+	*/
 	className: prop_types.default.string,
+	/**
+	* Provide a `Slug` component to be rendered inside the `TableSlugRow` component
+	*/
 	slug: prop_types.default.node
 };
 //#endregion

package/lib/components/DataTable/TableToolbar.js

@@ -8,10 +8,10 @@
 const require_runtime = require("../../_virtual/_rolldown/runtime.js");
 const require_usePrefix = require("../../internal/usePrefix.js");
 const require_deprecate = require("../../prop-types/deprecate.js");
-let react = require("react");
-react = require_runtime.__toESM(react);
 let classnames = require("classnames");
 classnames = require_runtime.__toESM(classnames);
+let react = require("react");
+react = require_runtime.__toESM(react);
 let prop_types = require("prop-types");
 prop_types = require_runtime.__toESM(prop_types);
 let react_jsx_runtime = require("react/jsx-runtime");
@@ -43,9 +43,24 @@ const TableToolbar = ({ ["aria-label"]: ariaLabel = "data table toolbar", ariaLa
 	});
 };
 TableToolbar.propTypes = {
+	/**
+	* 'aria-label' of the TableToolbar component.
+	* 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 node.
+	* 'aria-label' of the TableToolbar component.
+	*/
 	ariaLabel: require_deprecate.deprecate(prop_types.default.string, "This prop syntax has been deprecated. Please use the new `aria-label`."),
+	/**
+	* Pass in the children that will be rendered inside the TableToolbar
+	*/
 	children: prop_types.default.node,
+	/**
+	* `lg` Change the row height of table
+	*/
 	size: prop_types.default.oneOf([
 		"xs",
 		"sm",

package/lib/components/DataTable/TableToolbarMenu.js

@@ -9,10 +9,10 @@ const require_runtime = require("../../_virtual/_rolldown/runtime.js");
 const require_usePrefix = require("../../internal/usePrefix.js");
 const require_TableToolbar = require("./TableToolbar.js");
 const require_index = require("../OverflowMenu/index.js");
-let react = require("react");
-react = require_runtime.__toESM(react);
 let classnames = require("classnames");
 classnames = require_runtime.__toESM(classnames);
+let react = require("react");
+react = require_runtime.__toESM(react);
 let prop_types = require("prop-types");
 prop_types = require_runtime.__toESM(prop_types);
 let react_jsx_runtime = require("react/jsx-runtime");
@@ -42,10 +42,25 @@ const TableToolbarMenu = ({ className, renderIcon = _carbon_icons_react.Settings
 };
 TableToolbarMenu.propTypes = {
 	children: prop_types.default.node.isRequired,
+	/**
+	* Provide an optional class name for the toolbar menu
+	*/
 	className: prop_types.default.string,
+	/**
+	* The description of the menu icon.
+	*/
 	iconDescription: prop_types.default.string,
+	/**
+	* Provide an optional class name for the toolbar menu
+	*/
 	menuOptionsClass: prop_types.default.string,
+	/**
+	* A component used to render an icon.
+	*/
 	renderIcon: prop_types.default.oneOfType([prop_types.default.func, prop_types.default.object]),
+	/**
+	* Specify the size of the ToolbarMenu.
+	*/
 	size: prop_types.default.oneOf([
 		"xs",
 		"sm",

package/lib/components/DataTable/TableToolbarSearch.js

@@ -6,15 +6,15 @@
  */
 
 const require_runtime = require("../../_virtual/_rolldown/runtime.js");
-const require_noopFn = require("../../internal/noopFn.js");
 const require_usePrefix = require("../../internal/usePrefix.js");
 const require_useId = require("../../internal/useId.js");
+const require_noopFn = require("../../internal/noopFn.js");
 const require_index = require("../Search/index.js");
 const require_TableToolbar = require("./TableToolbar.js");
-let react = require("react");
-react = require_runtime.__toESM(react);
 let classnames = require("classnames");
 classnames = require_runtime.__toESM(classnames);
+let react = require("react");
+react = require_runtime.__toESM(react);
 let prop_types = require("prop-types");
 prop_types = require_runtime.__toESM(prop_types);
 let react_jsx_runtime = require("react/jsx-runtime");
@@ -91,28 +91,86 @@ const TableToolbarSearch = ({ className, searchContainerClass, onChange: onChang
 };
 TableToolbarSearch.propTypes = {
 	children: prop_types.default.node,
+	/**
+	* Provide an optional class name for the search container
+	*/
 	className: prop_types.default.string,
+	/**
+	* Specifies if the search should initially render in an expanded state
+	*/
 	defaultExpanded: prop_types.default.bool,
+	/**
+	* Provide an optional default value for the Search component
+	*/
 	defaultValue: prop_types.default.string,
+	/**
+	* Specifies if the search should be disabled
+	*/
 	disabled: prop_types.default.bool,
+	/**
+	* Specifies if the search should expand
+	*/
 	expanded: prop_types.default.bool,
+	/**
+	* Provide an optional id for the search container
+	*/
 	id: prop_types.default.string,
+	/**
+	* Provide an optional label text for the Search component icon
+	*/
 	labelText: prop_types.default.string,
+	/**
+	* Provide an optional function to be called when the search input loses focus, this will be
+	* passed the event as the first parameter and a function to handle the expanding of the search
+	* input as the second
+	*/
 	onBlur: prop_types.default.func,
+	/**
+	* Provide an optional hook that is called each time the input is updated
+	*/
 	onChange: prop_types.default.func,
+	/**
+	* Optional callback called when the search value is cleared.
+	*/
 	onClear: prop_types.default.func,
+	/**
+	* Provide an optional hook that is called each time the input is expanded
+	*/
 	onExpand: prop_types.default.func,
+	/**
+	* Provide an optional function to be called when the search input gains focus, this will be
+	* passed the event as the first parameter and a function to handle the expanding of the search
+	* input as the second.
+	*/
 	onFocus: prop_types.default.func,
+	/**
+	* Whether the search should be allowed to expand
+	*/
 	persistent: prop_types.default.bool,
+	/**
+	* Provide an optional placeholder text for the Search component
+	*/
 	placeholder: prop_types.default.string,
+	/**
+	* Provide an optional className for the overall container of the Search
+	*/
 	searchContainerClass: prop_types.default.string,
+	/**
+	* Specify the size of the Search
+	*/
 	size: prop_types.default.oneOf([
 		"xs",
 		"sm",
 		"md",
 		"lg"
 	]),
+	/**
+	* Optional prop to specify the tabIndex of the <Search> (in expanded state) or the container (in collapsed state)
+	*/
 	tabIndex: prop_types.default.oneOfType([prop_types.default.number, prop_types.default.string]),
+	/**
+	* Translates component strings using your i18n tool.
+	*/
 	translateWithId: prop_types.default.func
 };
 //#endregion

package/lib/components/DataTableSkeleton/DataTableSkeleton.js

@@ -7,10 +7,10 @@
 
 const require_runtime = require("../../_virtual/_rolldown/runtime.js");
 const require_usePrefix = require("../../internal/usePrefix.js");
-let react = require("react");
-react = require_runtime.__toESM(react);
 let classnames = require("classnames");
 classnames = require_runtime.__toESM(classnames);
+let react = require("react");
+react = require_runtime.__toESM(react);
 let prop_types = require("prop-types");
 prop_types = require_runtime.__toESM(prop_types);
 let react_jsx_runtime = require("react/jsx-runtime");
@@ -60,12 +60,33 @@ const DataTableSkeleton = ({ headers, rowCount = 5, columnCount = 5, zebra = fal
 	});
 };
 DataTableSkeleton.propTypes = {
+	/**
+	* Specify an optional className to add.
+	*/
 	className: prop_types.default.string,
+	/**
+	* Specify the number of columns that you want to render in the skeleton state
+	*/
 	columnCount: prop_types.default.number,
+	/**
+	* Optionally specify the displayed headers
+	*/
 	headers: prop_types.default.arrayOf(prop_types.default.shape({ header: prop_types.default.node.isRequired }).isRequired),
+	/**
+	* Specify the number of rows that you want to render in the skeleton state
+	*/
 	rowCount: prop_types.default.number,
+	/**
+	* Specify if the table header should be rendered as part of the skeleton.
+	*/
 	showHeader: prop_types.default.bool,
+	/**
+	* Specify if the table toolbar should be rendered as part of the skeleton.
+	*/
 	showToolbar: prop_types.default.bool,
+	/**
+	* Changes the row height of table.
+	*/
 	size: prop_types.default.oneOf([
 		"xs",
 		"sm",
@@ -73,6 +94,9 @@ DataTableSkeleton.propTypes = {
 		"lg",
 		"xl"
 	]),
+	/**
+	* Optionally specify whether you want the DataTable to be zebra striped
+	*/
 	zebra: prop_types.default.bool
 };
 //#endregion

package/lib/components/DatePicker/DatePicker.Skeleton.js

@@ -7,10 +7,10 @@
 
 const require_runtime = require("../../_virtual/_rolldown/runtime.js");
 const require_usePrefix = require("../../internal/usePrefix.js");
-let react = require("react");
-react = require_runtime.__toESM(react);
 let classnames = require("classnames");
 classnames = require_runtime.__toESM(classnames);
+let react = require("react");
+react = require_runtime.__toESM(react);
 let prop_types = require("prop-types");
 prop_types = require_runtime.__toESM(prop_types);
 let react_jsx_runtime = require("react/jsx-runtime");
@@ -48,9 +48,21 @@ const DatePickerSkeleton = ({ range, id, hideLabel, className, ...rest }) => {
 	});
 };
 DatePickerSkeleton.propTypes = {
+	/**
+	* Specify an optional className to add.
+	*/
 	className: prop_types.default.string,
+	/**
+	* Specify whether to hide the label.
+	*/
 	hideLabel: prop_types.default.bool,
+	/**
+	* Specify the id to add.
+	*/
 	id: prop_types.default.string,
+	/**
+	* Specify whether to render the range skeleton variant.
+	*/
 	range: prop_types.default.bool
 };
 //#endregion

package/lib/components/DatePicker/DatePicker.js

@@ -18,10 +18,10 @@ const require_utils$1 = require("./utils.js");
 const require_rangePlugin = require("./plugins/rangePlugin.js");
 const require_useSavedCallback = require("../../internal/useSavedCallback.js");
 const require_DatePickerLocales = require("./DatePickerLocales.js");
-let react = require("react");
-react = require_runtime.__toESM(react);
 let classnames = require("classnames");
 classnames = require_runtime.__toESM(classnames);
+let react = require("react");
+react = require_runtime.__toESM(react);
 let prop_types = require("prop-types");
 prop_types = require_runtime.__toESM(prop_types);
 let react_jsx_runtime = require("react/jsx-runtime");
@@ -452,31 +452,110 @@ const DatePicker = (0, react.forwardRef)((props, ref) => {
 	});
 });
 DatePicker.propTypes = {
+	/**
+	* Flatpickr prop passthrough enables direct date input, and when set to
+	* false, we must clear dates manually by resetting the value prop to an empty
+	* value (such as `""`, `null`, or `undefined`) or an array of all empty
+	* values, making it a controlled input.
+	*/
 	allowInput: prop_types.default.bool,
+	/**
+	* The DOM element the Flatpicker should be inserted into. `<body>` by default.
+	*/
 	appendTo: prop_types.default.object,
+	/**
+	* The child nodes.
+	*/
 	children: prop_types.default.node,
+	/**
+	* The CSS class names.
+	*/
 	className: prop_types.default.string,
+	/**
+	* flatpickr prop passthrough. Controls whether the calendar dropdown closes upon selection.
+	*/
 	closeOnSelect: prop_types.default.bool,
+	/**
+	* The date format.
+	*/
 	dateFormat: prop_types.default.string,
+	/**
+	* The type of the date picker:
+	*
+	* * `simple` - Without calendar dropdown.
+	* * `single` - With calendar dropdown and single date.
+	* * `range` - With calendar dropdown and a date range.
+	*/
 	datePickerType: prop_types.default.oneOf([
 		"simple",
 		"single",
 		"range"
 	]),
+	/**
+	* The flatpickr `disable` option that allows a user to disable certain dates.
+	*/
 	disable: prop_types.default.array,
+	/**
+	* The flatpickr `enable` option that allows a user to enable certain dates.
+	*/
 	enable: prop_types.default.array,
+	/**
+	* The flatpickr `inline` option.
+	*/
 	inline: prop_types.default.bool,
+	/**
+	* Specify whether or not the control is invalid (Fluid only)
+	*/
 	invalid: prop_types.default.bool,
+	/**
+	* `true` to use the light version.
+	*/
 	light: require_deprecate.deprecate(prop_types.default.bool, "The `light` prop for `DatePicker` has been deprecated in favor of the new `Layer` component. It will be removed in the next major release."),
+	/**
+	*  The language locale used to format the days of the week, months, and numbers. The full list of supported locales can be found here https://github.com/flatpickr/flatpickr/tree/master/src/l10n
+	*/
 	locale: prop_types.default.oneOfType([prop_types.default.object, prop_types.default.oneOf(require_DatePickerLocales.SUPPORTED_LOCALES)]),
+	/**
+	* The maximum date that a user can pick to.
+	*/
 	maxDate: prop_types.default.oneOfType([prop_types.default.string, prop_types.default.number]),
+	/**
+	* The minimum date that a user can start picking from.
+	*/
 	minDate: prop_types.default.oneOfType([prop_types.default.string, prop_types.default.number]),
+	/**
+	* The `change` event handler.
+	* `(dates: Date[], dStr: string, fp: Instance, data?: any):void;`
+	*/
 	onChange: prop_types.default.func,
+	/**
+	* The `close` event handler.
+	* `(dates: Date[], dStr: string, fp: Instance, data?: any):void;`
+	*/
 	onClose: prop_types.default.func,
+	/**
+	* The `open` event handler.
+	* `(dates: Date[], dStr: string, fp: Instance, data?: any):void;`
+	*/
 	onOpen: prop_types.default.func,
+	/**
+	* flatpickr prop passthrough. Controls how dates are parsed.
+	*/
 	parseDate: prop_types.default.func,
+	/**
+	* whether the DatePicker is to be readOnly
+	* if boolean applies to all inputs
+	* if array applies to each input in order
+	*/
 	readOnly: prop_types.default.oneOfType([prop_types.default.bool, prop_types.default.array]),
+	/**
+	* `true` to use the short version.
+	*/
 	short: prop_types.default.bool,
+	/**
+	* The value of the date value provided to flatpickr, could
+	* be a date, a date number, a date string, an array of dates.
+	*/
 	value: prop_types.default.oneOfType([
 		prop_types.default.string,
 		prop_types.default.arrayOf(prop_types.default.oneOfType([
@@ -487,8 +566,17 @@ DatePicker.propTypes = {
 		prop_types.default.object,
 		prop_types.default.number
 	]),
+	/**
+	* Specify whether the control is currently in warning state (Fluid only)
+	*/
 	warn: prop_types.default.bool,
+	/**
+	* Accessible aria-label for the "next month" arrow icon.
+	*/
 	nextMonthAriaLabel: prop_types.default.string,
+	/**
+	* Accessible aria-label for the "previous month" arrow icon.
+	*/
 	prevMonthAriaLabel: prop_types.default.string
 };
 //#endregion

package/lib/components/DatePickerInput/DatePickerInput.js

@@ -6,19 +6,19 @@
  */
 
 const require_runtime = require("../../_virtual/_rolldown/runtime.js");
-const require_warning = require("../../internal/warning.js");
 const require_usePrefix = require("../../internal/usePrefix.js");
 const require_Text = require("../Text/Text.js");
 const require_useId = require("../../internal/useId.js");
+const require_warning = require("../../internal/warning.js");
 const require_deprecate = require("../../prop-types/deprecate.js");
 const require_utils = require("../../internal/utils.js");
 const require_useNormalizedInputProps = require("../../internal/useNormalizedInputProps.js");
 const require_index = require("../AILabel/index.js");
 const require_FormContext = require("../FluidForm/FormContext.js");
-let react = require("react");
-react = require_runtime.__toESM(react);
 let classnames = require("classnames");
 classnames = require_runtime.__toESM(classnames);
+let react = require("react");
+react = require_runtime.__toESM(react);
 let prop_types = require("prop-types");
 prop_types = require_runtime.__toESM(prop_types);
 let react_jsx_runtime = require("react/jsx-runtime");
@@ -140,32 +140,92 @@ const DatePickerInput = (0, react.forwardRef)((props, ref) => {
 	});
 });
 DatePickerInput.propTypes = {
+	/**
+	* The type of the date picker:
+	*
+	* * `simple` - Without calendar dropdown.
+	* * `single` - With calendar dropdown and single date.
+	* * `range` - With calendar dropdown and a date range.
+	*/
 	datePickerType: prop_types.default.oneOf([
 		"simple",
 		"single",
 		"range"
 	]),
+	/**
+	* **Experimental**: Provide a decorator component to be rendered inside the `RadioButton` component
+	*/
 	decorator: prop_types.default.node,
+	/**
+	* Specify whether or not the input should be disabled
+	*/
 	disabled: prop_types.default.bool,
+	/**
+	* Provide text that is used alongside the control label for additional help
+	*/
 	helperText: prop_types.default.node,
+	/**
+	* Specify if the label should be hidden
+	*/
 	hideLabel: prop_types.default.bool,
+	/**
+	* Specify an id that uniquely identifies the `<input>`
+	*/
 	id: prop_types.default.string.isRequired,
+	/**
+	* Specify whether or not the input should be invalid
+	*/
 	invalid: prop_types.default.bool,
+	/**
+	* Specify the text to be rendered when the input is invalid
+	*/
 	invalidText: prop_types.default.node,
+	/**
+	* Provide the text that will be read by a screen reader when visiting this
+	* control
+	*/
 	labelText: prop_types.default.node.isRequired,
+	/**
+	* Specify an `onChange` handler that is called whenever a change in the
+	* input field has occurred
+	*/
 	onChange: prop_types.default.func,
+	/**
+	* Provide a function to be called when the input field is clicked
+	*/
 	onClick: prop_types.default.func,
+	/**
+	* Provide a regular expression pattern string that the input value must match
+	*/
 	pattern: prop_types.default.string,
+	/**
+	* Specify the placeholder text
+	*/
 	placeholder: prop_types.default.string,
+	/**
+	* whether the DatePicker is to be readOnly
+	*/
 	readOnly: prop_types.default.bool,
+	/**
+	* Specify the size of the Date Picker Input. Currently supports either `sm`, `md`, or `lg` as an option.
+	*/
 	size: prop_types.default.oneOf([
 		"sm",
 		"md",
 		"lg"
 	]),
 	slug: require_deprecate.deprecate(prop_types.default.node, "The `slug` prop has been deprecated and will be removed in the next major version. Use the decorator prop instead."),
+	/**
+	* Specify the type of the `<input>`
+	*/
 	type: 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
 };
 function DatePickerIcon({ datePickerType, invalid, warn, disabled, readOnly }) {
@@ -188,14 +248,33 @@ function DatePickerIcon({ datePickerType, invalid, warn, disabled, readOnly }) {
 	});
 }
 DatePickerIcon.propTypes = {
+	/**
+	* The type of the date picker:
+	*
+	* * `simple` - Without calendar dropdown.
+	* * `single` - With calendar dropdown and single date.
+	* * `range` - With calendar dropdown and a date range.
+	*/
 	datePickerType: prop_types.default.oneOf([
 		"simple",
 		"single",
 		"range"
 	]),
+	/**
+	* Specify whether or not the input should be invalid
+	*/
 	invalid: prop_types.default.bool,
+	/**
+	* Specify whether the control is currently in warning state
+	*/
 	warn: prop_types.default.bool,
+	/**
+	* Specify whether or not the input should be disabled
+	*/
 	disabled: prop_types.default.bool,
+	/**
+	* Specify whether the input is readonly
+	*/
 	readOnly: prop_types.default.bool
 };
 //#endregion