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

package/lib/components/FluidTextArea/FluidTextArea.js

@@ -35,26 +35,93 @@ const FluidTextArea = ({ className, ...other }) => {
 	});
 };
 FluidTextArea.propTypes = {
+	/**
+	* Provide a custom className that is applied to the wrapper node
+	*/
 	className: prop_types.default.string,
+	/**
+	* Specify the `cols` attribute for the underlying `<textarea>` node
+	*/
 	cols: prop_types.default.number,
+	/**
+	* Optionally provide the default value of the `<textarea>`
+	*/
 	defaultValue: prop_types.default.oneOfType([prop_types.default.string, prop_types.default.number]),
+	/**
+	* Specify whether the control is disabled
+	*/
 	disabled: prop_types.default.bool,
+	/**
+	* Specify whether to display the character counter
+	*/
 	enableCounter: prop_types.default.bool,
+	/**
+	* 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,
+	/**
+	* Provide a unique identifier for the control
+	*/
 	id: prop_types.default.string,
+	/**
+	* Specify whether the control is currently invalid
+	*/
 	invalid: prop_types.default.bool,
+	/**
+	* Provide the text that is displayed when the control is in an invalid state
+	*/
 	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,
+	/**
+	* `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: require_deprecate.deprecate(prop_types.default.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: prop_types.default.number,
+	/**
+	* Optionally provide an `onChange` handler that is called whenever `<textarea>`
+	* is updated
+	*/
 	onChange: prop_types.default.func,
+	/**
+	* Optionally provide an `onClick` handler that is called whenever the
+	* `<textarea>` is clicked
+	*/
 	onClick: prop_types.default.func,
+	/**
+	* Specify the placeholder attribute for the `<textarea>`
+	*/
 	placeholder: prop_types.default.string,
+	/**
+	* Specify the rows attribute for the `<textarea>`
+	*/
 	rows: prop_types.default.number,
+	/**
+	* Provide the current value of the `<textarea>`
+	*/
 	value: prop_types.default.oneOfType([prop_types.default.string, prop_types.default.number]),
+	/**
+	* 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,
+	/**
+	* Whether or not the component is readonly
+	*/
 	readOnly: prop_types.default.bool
 };
 //#endregion

package/lib/components/FluidTextInput/FluidPasswordInput.js

@@ -34,23 +34,81 @@ const FluidPasswordInput = ({ className, ...other }) => {
 	});
 };
 FluidPasswordInput.propTypes = {
+	/**
+	* Specify an optional className to be applied to the outer FluidForm wrapper
+	*/
 	className: prop_types.default.string,
+	/**
+	* Optionally provide the default value of the `<input>`
+	*/
 	defaultValue: prop_types.default.oneOfType([prop_types.default.string, prop_types.default.number]),
+	/**
+	* Specify whether the `<input>` should be disabled
+	*/
 	disabled: prop_types.default.bool,
+	/**
+	* "Hide password" tooltip text on password visibility toggle
+	*/
 	hidePasswordLabel: prop_types.default.string,
+	/**
+	* Specify a custom `id` for the `<input>`
+	*/
 	id: prop_types.default.string.isRequired,
+	/**
+	* Specify whether the control is currently invalid
+	*/
 	invalid: prop_types.default.bool,
+	/**
+	* Provide the text that is displayed when the control is in an invalid state
+	*/
 	invalidText: prop_types.default.node,
+	/**
+	* Specify whether the control is a password input
+	*/
 	isPassword: prop_types.default.bool,
+	/**
+	* Provide the text that will be read by a screen reader when visiting this
+	* control
+	*/
 	labelText: prop_types.default.node.isRequired,
+	/**
+	* Optionally provide an `onChange` handler that is called whenever `<input>`
+	* is updated
+	*/
 	onChange: prop_types.default.func,
+	/**
+	* Optionally provide an `onClick` handler that is called whenever the
+	* `<input>` is clicked
+	*/
 	onClick: prop_types.default.func,
+	/**
+	* Callback function that is called whenever the toggle password visibility
+	* button is clicked
+	*/
 	onTogglePasswordVisibility: prop_types.default.func,
+	/**
+	* Specify the placeholder attribute for the `<input>`
+	*/
 	placeholder: prop_types.default.string,
+	/**
+	* "Show password" tooltip text on password visibility toggle
+	*/
 	showPasswordLabel: prop_types.default.string,
+	/**
+	* Specify the value of the `<input>`
+	*/
 	value: prop_types.default.oneOfType([prop_types.default.string, prop_types.default.number]),
+	/**
+	* 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,
+	/**
+	* Whether or not the component is readonly
+	*/
 	readOnly: prop_types.default.bool
 };
 //#endregion

package/lib/components/FluidTextInput/FluidTextInput.Skeleton.js

@@ -33,6 +33,10 @@ const FluidTextInputSkeleton = ({ className, ...other }) => {
 		})
 	});
 };
-FluidTextInputSkeleton.propTypes = { className: prop_types.default.string };
+FluidTextInputSkeleton.propTypes = { 
+/**
+* Specify an optional className to be applied to the outer FluidForm wrapper
+*/
+className: prop_types.default.string };
 //#endregion
 exports.default = FluidTextInputSkeleton;

package/lib/components/FluidTextInput/FluidTextInput.js

@@ -40,22 +40,76 @@ const FluidTextInput = react.default.forwardRef(({ className, isPassword, ...oth
 	});
 });
 FluidTextInput.propTypes = {
+	/**
+	* Specify an optional className to be applied to the outer FluidForm wrapper
+	*/
 	className: prop_types.default.string,
+	/**
+	* Optionally provide the default value of the `<input>`
+	*/
 	defaultValue: prop_types.default.oneOfType([prop_types.default.string, prop_types.default.number]),
+	/**
+	* Specify whether the `<input>` should be disabled
+	*/
 	disabled: prop_types.default.bool,
+	/**
+	* Specify a custom `id` for the `<input>`
+	*/
 	id: prop_types.default.string.isRequired,
+	/**
+	* Specify whether the control is currently invalid
+	*/
 	invalid: prop_types.default.bool,
+	/**
+	* Provide the text that is displayed when the control is in an invalid state
+	*/
 	invalidText: prop_types.default.node,
+	/**
+	* Specify whether the control is a password input
+	*/
 	isPassword: prop_types.default.bool,
+	/**
+	* Max character count allowed for the textInput. This is needed in order for enableCounter to display
+	*/
 	maxCount: prop_types.default.number,
+	/**
+	* Specify whether to display the character counter
+	*/
 	enableCounter: prop_types.default.bool,
+	/**
+	* Provide the text that will be read by a screen reader when visiting this
+	* control
+	*/
 	labelText: prop_types.default.node.isRequired,
+	/**
+	* Optionally provide an `onChange` handler that is called whenever `<input>`
+	* is updated
+	*/
 	onChange: prop_types.default.func,
+	/**
+	* Optionally provide an `onClick` handler that is called whenever the
+	* `<input>` is clicked
+	*/
 	onClick: prop_types.default.func,
+	/**
+	* Specify the placeholder attribute for the `<input>`
+	*/
 	placeholder: prop_types.default.string,
+	/**
+	* Specify the value of the `<input>`
+	*/
 	value: prop_types.default.oneOfType([prop_types.default.string, prop_types.default.number]),
+	/**
+	* 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,
+	/**
+	* Whether or not the component is readonly
+	*/
 	readOnly: prop_types.default.bool
 };
 //#endregion

package/lib/components/FluidTimePicker/FluidTimePicker.Skeleton.js

@@ -36,7 +36,13 @@ const FluidTimePickerSkeleton = ({ className, isOnlyTwo, ...rest }) => {
 	});
 };
 FluidTimePickerSkeleton.propTypes = {
+	/**
+	* Specify an optional className to add.
+	*/
 	className: prop_types.default.string,
+	/**
+	* Specify if there are only two TimePicker elements
+	*/
 	isOnlyTwo: prop_types.default.bool
 };
 //#endregion

package/lib/components/FluidTimePicker/FluidTimePicker.js

@@ -69,14 +69,42 @@ const FluidTimePicker = react.default.forwardRef(({ className, children, disable
 	});
 });
 FluidTimePicker.propTypes = {
+	/**
+	* The child node(s)
+	*/
 	children: prop_types.default.node,
+	/**
+	* Specify an optional className to be applied to the outer FluidTimePicker wrapper
+	*/
 	className: prop_types.default.string,
+	/**
+	* Specify whether the `<input>` should be disabled
+	*/
 	disabled: prop_types.default.bool,
+	/**
+	* Specify whether or not the control is invalid
+	*/
 	invalid: prop_types.default.bool,
+	/**
+	* Provide the text that is displayed when the control is in error state
+	*/
 	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 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,
+	/**
+	* Whether or not the component is readonly
+	*/
 	readOnly: prop_types.default.bool
 };
 //#endregion

package/lib/components/FluidTimePickerSelect/FluidTimePickerSelect.js

@@ -28,13 +28,39 @@ const FluidTimePickerSelect = react.default.forwardRef(({ children, className, .
 	});
 });
 FluidTimePickerSelect.propTypes = {
+	/**
+	* Provide the contents of your Select
+	*/
 	children: prop_types.default.node,
+	/**
+	* Specify an optional className to be applied to the node containing the label and the select box
+	*/
 	className: prop_types.default.string,
+	/**
+	* Optionally provide the default value of the `<select>`
+	*/
 	defaultValue: prop_types.default.any,
+	/**
+	* Specify whether the control is disabled
+	*/
 	disabled: prop_types.default.bool,
+	/**
+	* Specify a custom `id` for the `<select>`
+	*/
 	id: prop_types.default.string.isRequired,
+	/**
+	* Provide label text to be read by screen readers when interacting with the
+	* control
+	*/
 	labelText: prop_types.default.node,
+	/**
+	* Provide an optional `onChange` hook that is called each time the value of
+	* the underlying `<input>` changes
+	*/
 	onChange: prop_types.default.func,
+	/**
+	* Whether the component is read-only.
+	*/
 	readOnly: prop_types.default.bool
 };
 //#endregion

package/lib/components/Form/Form.js

@@ -29,7 +29,13 @@ function Form({ className, children, ...other }) {
 	});
 }
 Form.propTypes = {
+	/**
+	* Provide children to be rendered inside of the <form> element
+	*/
 	children: prop_types.default.node,
+	/**
+	* Provide a custom className to be applied on the containing <form> node
+	*/
 	className: prop_types.default.string
 };
 //#endregion

package/lib/components/FormGroup/FormGroup.js

@@ -45,13 +45,38 @@ const FormGroup = ({ disabled = false, legendId, legendText, invalid = false, ch
 	});
 };
 FormGroup.propTypes = {
+	/**
+	* Provide the children form elements to be rendered inside of the <fieldset>
+	*/
 	children: prop_types.default.node,
+	/**
+	* Provide a custom className to be applied to the containing <fieldset> node
+	*/
 	className: prop_types.default.string,
+	/**
+	* Specify whether the FormGroup should be disabled
+	*/
 	disabled: prop_types.default.bool,
+	/**
+	* Specify whether the <FormGroup> is invalid
+	*/
 	invalid: prop_types.default.bool,
+	/**
+	* Provide id for the fieldset <legend> which corresponds to the fieldset
+	* `aria-labelledby`
+	*/
 	legendId: prop_types.default.node,
+	/**
+	* Provide the text to be rendered inside of the fieldset <legend>
+	*/
 	legendText: prop_types.default.node.isRequired,
+	/**
+	* Specify whether the message should be displayed in the <FormGroup>
+	*/
 	message: prop_types.default.bool,
+	/**
+	* Provide the text for the message in the <FormGroup>
+	*/
 	messageText: prop_types.default.string
 };
 //#endregion

package/lib/components/FormItem/FormItem.js

@@ -29,7 +29,13 @@ function FormItem({ className, children, ...rest }) {
 	});
 }
 FormItem.propTypes = {
+	/**
+	* Provide content to be rendered in the form item
+	*/
 	children: prop_types.default.node,
+	/**
+	* Provide a custom className to be applied to the containing node
+	*/
 	className: prop_types.default.string
 };
 //#endregion

package/lib/components/FormLabel/FormLabel.js

@@ -33,8 +33,17 @@ function FormLabel({ className: customClassName, children, id, ...rest }) {
 	});
 }
 FormLabel.propTypes = {
+	/**
+	* Specify the content of the form label
+	*/
 	children: prop_types.default.node,
+	/**
+	* Provide a custom className to be applied to the containing <label> node
+	*/
 	className: prop_types.default.string,
+	/**
+	* Provide a unique id for the given <FormLabel>
+	*/
 	id: prop_types.default.string
 };
 //#endregion

package/lib/components/Grid/CSSGrid.js

@@ -62,17 +62,44 @@ const CSSGrid = react.default.forwardRef(({ align, as, children, className: cust
 	});
 });
 CSSGrid.propTypes = {
+	/**
+	* Provide a custom element to render instead of the default <div>
+	*/
 	as: prop_types.default.oneOfType([prop_types.default.string, prop_types.default.elementType]),
+	/**
+	* Specify grid alignment. Default is center
+	*/
 	align: prop_types.default.oneOf([
 		"start",
 		"center",
 		"end"
 	]),
+	/**
+	* Pass in content that will be rendered within the `Grid`
+	*/
 	children: prop_types.default.node,
+	/**
+	* Specify a custom className to be applied to the `Grid`
+	*/
 	className: prop_types.default.string,
+	/**
+	* Collapse the gutter to 1px. Useful for fluid layouts.
+	* Rows have 1px of margin between them to match gutter.
+	*/
 	condensed: prop_types.default.bool,
+	/**
+	* Remove the default max width that the grid has set
+	*/
 	fullWidth: prop_types.default.bool,
+	/**
+	* Container hangs 16px into the gutter. Useful for
+	* typographic alignment with and without containers.
+	*/
 	narrow: prop_types.default.bool,
+	/**
+	* Add a row gap to the grid that matches the current gutter size.
+	* This is useful when you want consistent vertical spacing between rows.
+	*/
 	withRowGap: prop_types.default.bool
 };
 const Subgrid = react.default.forwardRef(({ as, className: customClassName, children, mode, withRowGap, ...rest }, ref) => {
@@ -92,14 +119,30 @@ const Subgrid = react.default.forwardRef(({ as, className: customClassName, chil
 	});
 });
 Subgrid.propTypes = {
+	/**
+	* Provide a custom element to render instead of the default <div>
+	*/
 	as: prop_types.default.oneOfType([prop_types.default.string, prop_types.default.elementType]),
+	/**
+	* Pass in content that will be rendered within the `Subgrid`
+	*/
 	children: prop_types.default.node,
+	/**
+	* Specify a custom className to be applied to the `Subgrid`
+	*/
 	className: prop_types.default.string,
+	/**
+	* Specify the gutter mode for the subgrid
+	*/
 	mode: prop_types.default.oneOf([
 		"wide",
 		"narrow",
 		"condensed"
 	]),
+	/**
+	* Add a row gap to the grid that matches the current gutter size.
+	* This is useful when you want consistent vertical spacing between rows.
+	*/
 	withRowGap: prop_types.default.bool
 };
 const CSSGridComponent = CSSGrid;

package/lib/components/Grid/Column.js

@@ -78,14 +78,57 @@ const spanPropType = (0, _carbon_feature_flags.enabled)("enable-css-grid") ? pro
 	})
 ]);
 Column.propTypes = {
+	/**
+	* Provide a custom element to render instead of the default <div>
+	*/
 	as: prop_types.default.oneOfType([prop_types.default.string, prop_types.default.elementType]),
+	/**
+	* Pass in content that will be rendered within the `Column`
+	*/
 	children: prop_types.default.node,
+	/**
+	* Specify a custom className to be applied to the `Column`
+	*/
 	className: prop_types.default.string,
+	/**
+	* Specify column span for the `lg` breakpoint (Default breakpoint up to 1312px)
+	* This breakpoint supports 16 columns by default.
+	*
+	* @see https://carbondesignsystem.com/elements/2x-grid/overview/#breakpoints
+	*/
 	lg: spanPropType,
+	/**
+	* Specify column span for the `max` breakpoint. This breakpoint supports 16
+	* columns by default.
+	*
+	* @see https://carbondesignsystem.com/elements/2x-grid/overview/#breakpoints
+	*/
 	max: spanPropType,
+	/**
+	* Specify column span for the `md` breakpoint (Default breakpoint up to 1056px)
+	* This breakpoint supports 8 columns by default.
+	*
+	* @see https://carbondesignsystem.com/elements/2x-grid/overview/#breakpoints
+	*/
 	md: spanPropType,
+	/**
+	* Specify column span for the `sm` breakpoint (Default breakpoint up to 672px)
+	* This breakpoint supports 4 columns by default.
+	*
+	* @see https://carbondesignsystem.com/elements/2x-grid/overview/#breakpoints
+	*/
 	sm: spanPropType,
+	/**
+	* Specify constant column span, start, or end values that will not change
+	* based on breakpoint
+	*/
 	span: prop_types.default.oneOfType([prop_types.default.number, percentSpanType]),
+	/**
+	* Specify column span for the `xlg` breakpoint (Default breakpoint up to
+	* 1584px) This breakpoint supports 16 columns by default.
+	*
+	* @see https://carbondesignsystem.com/elements/2x-grid/overview/#breakpoints
+	*/
 	xlg: spanPropType
 };
 const CSSGridColumn = react.default.forwardRef(({ as: BaseComponent = "div", children, className: containerClassName, sm, md, lg, xlg, max, span, ...rest }, ref) => {
@@ -104,13 +147,50 @@ const CSSGridColumn = react.default.forwardRef(({ as: BaseComponent = "div", chi
 	});
 });
 CSSGridColumn.propTypes = {
+	/**
+	* Provide a custom element to render instead of the default <div>
+	*/
 	as: prop_types.default.oneOfType([prop_types.default.string, prop_types.default.elementType]),
+	/**
+	* Pass in content that will be rendered within the `Column`
+	*/
 	children: prop_types.default.node,
+	/**
+	* Specify a custom className to be applied to the `Column`
+	*/
 	className: prop_types.default.string,
+	/**
+	* Specify column span for the `lg` breakpoint (Default breakpoint up to 1312px)
+	* This breakpoint supports 16 columns by default.
+	*
+	* @see https://carbondesignsystem.com/elements/2x-grid/overview/#breakpoints
+	*/
 	lg: spanPropType,
+	/**
+	* Specify column span for the `max` breakpoint. This breakpoint supports 16
+	* columns by default.
+	*
+	* @see https://carbondesignsystem.com/elements/2x-grid/overview/#breakpoints
+	*/
 	max: spanPropType,
+	/**
+	* Specify column span for the `md` breakpoint (Default breakpoint up to 1056px)
+	* This breakpoint supports 8 columns by default.
+	*
+	* @see https://carbondesignsystem.com/elements/2x-grid/overview/#breakpoints
+	*/
 	md: spanPropType,
+	/**
+	* Specify column span for the `sm` breakpoint (Default breakpoint up to 672px)
+	* This breakpoint supports 4 columns by default.
+	*
+	* @see https://carbondesignsystem.com/elements/2x-grid/overview/#breakpoints
+	*/
 	sm: spanPropType,
+	/**
+	* Specify constant column span, start,  or end values that will not change
+	* based on breakpoint
+	*/
 	span: prop_types.default.oneOfType([
 		prop_types.default.number,
 		percentSpanType,
@@ -120,6 +200,12 @@ CSSGridColumn.propTypes = {
 			end: prop_types.default.number
 		})
 	]),
+	/**
+	* Specify column span for the `xlg` breakpoint (Default breakpoint up to
+	* 1584px) This breakpoint supports 16 columns by default.
+	*
+	* @see https://carbondesignsystem.com/elements/2x-grid/overview/#breakpoints
+	*/
 	xlg: spanPropType
 };
 const breakpointNames = [

package/lib/components/Grid/ColumnHang.js

@@ -34,8 +34,17 @@ function ColumnHang({ as: BaseComponent = "div", className: customClassName, chi
 	});
 }
 ColumnHang.propTypes = {
+	/**
+	* Provide a custom element to render instead of the default <div>
+	*/
 	as: prop_types.default.oneOfType([prop_types.default.string, prop_types.default.elementType]),
+	/**
+	* Pass in content that will be rendered within the `Grid`
+	*/
 	children: prop_types.default.node,
+	/**
+	* Specify a custom className to be applied to the `Grid`
+	*/
 	className: prop_types.default.string
 };
 const ColumnHangComponent = ColumnHang;