@carbon/react 1.110.0 → 1.111.0-rc.0

package/lib/components/UIShell/SideNavDivider.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");
@@ -27,6 +27,10 @@ const SideNavDivider = ({ className }) => {
 		children: /* @__PURE__ */ (0, react_jsx_runtime.jsx)("hr", {})
 	});
 };
-SideNavDivider.propTypes = { className: prop_types.default.string };
+SideNavDivider.propTypes = { 
+/**
+* Provide an optional class to be applied to the containing node
+*/
+className: prop_types.default.string };
 //#endregion
 exports.default = SideNavDivider;

package/lib/components/UIShell/SideNavFooter.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,20 @@ function SideNavFooter({ assistiveText = "Toggle opening or closing the side nav
 }
 SideNavFooter.displayName = "SideNavFooter";
 SideNavFooter.propTypes = {
+	/**
+	* Provide text to be read to screen readers and shown as a tooltip when
+	* interacting with the toggle button in the footer
+	*/
 	assistiveText: prop_types.default.string,
 	className: prop_types.default.string,
+	/**
+	* Specify whether the side navigation is expanded or collapsed
+	*/
 	expanded: prop_types.default.bool.isRequired,
+	/**
+	* Provide a function that is called when the toggle button is interacted
+	* with. Useful for controlling the expansion state of the side navigation.
+	*/
 	onToggle: prop_types.default.func.isRequired
 };
 //#endregion

package/lib/components/UIShell/SideNavHeader.js

@@ -8,10 +8,10 @@
 const require_runtime = require("../../_virtual/_rolldown/runtime.js");
 const require_usePrefix = require("../../internal/usePrefix.js");
 const require_SideNavIcon = require("./SideNavIcon.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");
@@ -30,9 +30,22 @@ const SideNavHeader = ({ children, className: customClassName, renderIcon: IconE
 };
 SideNavHeader.displayName = "SideNavHeader";
 SideNavHeader.propTypes = {
+	/**
+	* The child nodes to be rendered
+	*/
 	children: prop_types.default.node,
+	/**
+	* Provide an optional class to be applied to the containing node
+	*/
 	className: prop_types.default.string,
+	/**
+	* Property to indicate if the side nav container is open (or not). Use to
+	* keep local state and styling in step with the SideNav expansion state.
+	*/
 	isSideNavExpanded: prop_types.default.bool,
+	/**
+	* A component used to render an icon.
+	*/
 	renderIcon: prop_types.default.oneOfType([prop_types.default.func, prop_types.default.object]).isRequired
 };
 //#endregion

package/lib/components/UIShell/SideNavIcon.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");
@@ -33,8 +33,18 @@ const SideNavIcon = ({ children, className: customClassName, small = false }) =>
 	});
 };
 SideNavIcon.propTypes = {
+	/**
+	* Provide a single icon as the child to `SideNavIcon` to render in the
+	* container
+	*/
 	children: prop_types.default.node.isRequired,
+	/**
+	* Provide an optional class to be applied to the containing node
+	*/
 	className: prop_types.default.string,
+	/**
+	* Specify whether the icon should be placed in a smaller bounding box
+	*/
 	small: prop_types.default.bool
 };
 //#endregion

package/lib/components/UIShell/SideNavItem.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");
@@ -33,8 +33,18 @@ const SideNavItem = ({ className: customClassName, children, large = false }) =>
 	});
 };
 SideNavItem.propTypes = {
+	/**
+	* Provide a single icon as the child to `SideNavItem` to render in the
+	* container
+	*/
 	children: prop_types.default.node.isRequired,
+	/**
+	* Provide an optional class to be applied to the containing node
+	*/
 	className: prop_types.default.string,
+	/**
+	* Specify if this is a large variation of the SideNavItem
+	*/
 	large: prop_types.default.bool
 };
 //#endregion

package/lib/components/UIShell/SideNavItems.js

@@ -8,10 +8,10 @@
 const require_runtime = require("../../_virtual/_rolldown/runtime.js");
 const require_usePrefix = require("../../internal/usePrefix.js");
 const require_SideNavContext = require("./SideNavContext.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");
@@ -36,8 +36,19 @@ const SideNavItems = ({ className: customClassName, children, isSideNavExpanded
 };
 SideNavItems.displayName = "SideNavItems";
 SideNavItems.propTypes = {
+	/**
+	* Provide a single icon as the child to `SideNavIcon` to render in the
+	* container
+	*/
 	children: prop_types.default.node.isRequired,
+	/**
+	* Provide an optional class to be applied to the containing node
+	*/
 	className: prop_types.default.string,
+	/**
+	* Property to indicate if the side nav container is open (or not). Use to
+	* keep local state and styling in step with the SideNav expansion state.
+	*/
 	isSideNavExpanded: prop_types.default.bool
 };
 //#endregion

package/lib/components/UIShell/SideNavLink.js

@@ -12,10 +12,10 @@ const require_SideNavContext = require("./SideNavContext.js");
 const require_SideNavIcon = require("./SideNavIcon.js");
 const require_SideNavItem = require("./SideNavItem.js");
 const require_SideNavLinkText = require("./SideNavLinkText.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");
@@ -53,12 +53,34 @@ const SideNavLink = (0, react.forwardRef)((props, ref) => {
 SideNavLink.displayName = "SideNavLink";
 SideNavLink.propTypes = {
 	...require_Link.LinkPropTypes,
+	/**
+	* Specify the text content for the link
+	*/
 	children: prop_types.default.node.isRequired,
+	/**
+	* Provide an optional class to be applied to the containing node
+	*/
 	className: prop_types.default.string,
+	/**
+	* Specify whether the link is the current page
+	*/
 	isActive: prop_types.default.bool,
+	/**
+	* Property to indicate if the side nav container is open (or not). Use to
+	* keep local state and styling in step with the SideNav expansion state.
+	*/
 	isSideNavExpanded: prop_types.default.bool,
+	/**
+	* Specify if this is a large variation of the SideNavLink
+	*/
 	large: prop_types.default.bool,
+	/**
+	* 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 tabIndex of the button. If undefined, it will be applied default validation
+	*/
 	tabIndex: prop_types.default.number
 };
 //#endregion

package/lib/components/UIShell/SideNavLinkText.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");
@@ -30,7 +30,13 @@ function SideNavLinkText({ className: customClassName, children, ...rest }) {
 	});
 }
 SideNavLinkText.propTypes = {
+	/**
+	* Provide the content for the link text
+	*/
 	children: prop_types.default.node.isRequired,
+	/**
+	* Provide an optional class to be applied to the containing node
+	*/
 	className: prop_types.default.string
 };
 //#endregion

package/lib/components/UIShell/SideNavMenu.js

@@ -11,10 +11,10 @@ const require_keys = require("../../internal/keyboard/keys.js");
 const require_match = require("../../internal/keyboard/match.js");
 const require_SideNavContext = require("./SideNavContext.js");
 const require_SideNavIcon = require("./SideNavIcon.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");
@@ -87,14 +87,45 @@ const SideNavMenu = (0, react.forwardRef)(({ className: customClassName, childre
 });
 SideNavMenu.displayName = "SideNavMenu";
 SideNavMenu.propTypes = {
+	/**
+	* Provide <SideNavMenuItem>'s inside of the `SideNavMenu`
+	*/
 	children: prop_types.default.node,
+	/**
+	* Provide an optional class to be applied to the containing node
+	*/
 	className: prop_types.default.string,
+	/**
+	* Specify whether the menu should default to expanded. By default, it will
+	* be closed.
+	*/
 	defaultExpanded: prop_types.default.bool,
+	/**
+	* Specify whether the `SideNavMenu` is "active". `SideNavMenu` should be
+	* considered active if one of its menu items are a link for the current
+	* page.
+	*/
 	isActive: prop_types.default.bool,
+	/**
+	* Property to indicate if the side nav container is open (or not). Use to
+	* keep local state and styling in step with the SideNav expansion state.
+	*/
 	isSideNavExpanded: prop_types.default.bool,
+	/**
+	* Specify if this is a large variation of the SideNavMenu
+	*/
 	large: prop_types.default.bool,
+	/**
+	* 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 tabIndex of the button. If undefined, it will be applied default validation
+	*/
 	tabIndex: prop_types.default.number,
+	/**
+	* Provide the text for the overall menu name
+	*/
 	title: prop_types.default.string.isRequired
 };
 /**

package/lib/components/UIShell/SideNavMenuItem.js

@@ -9,10 +9,10 @@ const require_runtime = require("../../_virtual/_rolldown/runtime.js");
 const require_usePrefix = require("../../internal/usePrefix.js");
 const require_Link = require("./Link.js");
 const require_SideNavLinkText = require("./SideNavLinkText.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,10 +43,27 @@ const SideNavMenuItem = (0, react.forwardRef)((props, ref) => {
 });
 SideNavMenuItem.displayName = "SideNavMenuItem";
 SideNavMenuItem.propTypes = {
+	/**
+	* Optional component to render instead of default Link
+	*/
 	as: prop_types.default.elementType,
+	/**
+	* Specify the children to be rendered inside of the `SideNavMenuItem`
+	*/
 	children: prop_types.default.node,
+	/**
+	* Provide an optional class to be applied to the containing node
+	*/
 	className: prop_types.default.string,
+	/**
+	* Optionally provide an href for the underlying li`
+	*/
 	href: prop_types.default.string,
+	/**
+	* Optionally specify whether the link is "active". An active link is one that
+	* has an href that is the same as the current page. Can also pass in
+	* `aria-current="page"`, as well.
+	*/
 	isActive: prop_types.default.bool
 };
 //#endregion

package/lib/components/UIShell/SideNavSwitcher.js

@@ -8,10 +8,10 @@
 const require_runtime = require("../../_virtual/_rolldown/runtime.js");
 const require_usePrefix = require("../../internal/usePrefix.js");
 const require_useId = require("../../internal/useId.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");
@@ -63,9 +63,25 @@ const SideNavSwitcher = (0, react.forwardRef)((props, ref) => {
 });
 SideNavSwitcher.displayName = "SideNavSwitcher";
 SideNavSwitcher.propTypes = {
+	/**
+	* Provide an optional class to be applied to the containing node
+	*/
 	className: prop_types.default.string,
+	/**
+	* Provide the label for the switcher. This will be the first visible option
+	* when someone views this control
+	*/
 	labelText: prop_types.default.string.isRequired,
+	/**
+	* Provide a callback function that is called whenever the switcher value is
+	* updated
+	*/
 	onChange: prop_types.default.func,
+	/**
+	* Provide an array of options to be rendered in the switcher as an
+	* `<option>`. The text value will be what is displayed to the user and is set
+	* as the `value` prop for each `<option>`.
+	*/
 	options: prop_types.default.arrayOf(prop_types.default.string).isRequired
 };
 //#endregion

package/lib/components/UIShell/SkipToContent.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");
@@ -32,9 +32,20 @@ function SkipToContent({ children = "Skip to main content", className: customCla
 	});
 }
 SkipToContent.propTypes = {
+	/**
+	* A ReactNode to display in the SkipToContent `a` tag.
+	* `'Skip to main content'` by default.
+	*/
 	children: prop_types.default.string,
 	className: prop_types.default.string,
+	/**
+	* Provide the `href` to the id of the element on your package that is the
+	* main content. `#main-content` by default.
+	*/
 	href: prop_types.default.string,
+	/**
+	* Optionally override the default tabindex of 0
+	*/
 	tabIndex: prop_types.default.string
 };
 //#endregion

package/lib/components/UIShell/Switcher.js

@@ -12,10 +12,10 @@ const require_useMergedRefs = require("../../internal/useMergedRefs.js");
 const require_AriaPropTypes = require("../../prop-types/AriaPropTypes.js");
 const require_SwitcherItem = require("./SwitcherItem.js");
 const require_SwitcherDivider = require("./SwitcherDivider.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");
@@ -73,9 +73,21 @@ const Switcher = (0, react.forwardRef)((props, forwardRef) => {
 });
 Switcher.displayName = "Switcher";
 Switcher.propTypes = {
+	/**
+	* Required props for accessibility label on the underlying menu
+	*/
 	...require_AriaPropTypes.AriaLabelPropType,
+	/**
+	* expects to receive <SwitcherItem />
+	*/
 	children: prop_types.default.node.isRequired,
+	/**
+	* Optionally provide a custom class to apply to the underlying `<ul>` node
+	*/
 	className: prop_types.default.string,
+	/**
+	* Specify whether the panel is expanded
+	*/
 	expanded: prop_types.default.bool
 };
 //#endregion

package/lib/components/UIShell/SwitcherDivider.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");
@@ -28,6 +28,10 @@ const SwitcherDivider = ({ className: customClassName, ...other }) => {
 		className: classNames
 	}) });
 };
-SwitcherDivider.propTypes = { className: prop_types.default.string };
+SwitcherDivider.propTypes = { 
+/**
+* Optionally provide a custom class to apply to the underlying `<hr>` node
+*/
+className: prop_types.default.string };
 //#endregion
 exports.default = SwitcherDivider;

package/lib/components/UIShell/SwitcherItem.js

@@ -11,10 +11,10 @@ const require_keys = require("../../internal/keyboard/keys.js");
 const require_match = require("../../internal/keyboard/match.js");
 const require_AriaPropTypes = require("../../prop-types/AriaPropTypes.js");
 const require_Link = require("./Link.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");
@@ -72,15 +72,45 @@ const SwitcherItem = (0, react.forwardRef)((props, forwardRef) => {
 SwitcherItem.displayName = "SwitcherItem";
 SwitcherItem.propTypes = {
 	...require_AriaPropTypes.AriaLabelPropType,
+	/**
+	* Specify the text content for the link
+	*/
 	children: prop_types.default.node.isRequired,
+	/**
+	* Optionally provide a custom class to apply to the underlying `<li>` node
+	*/
 	className: prop_types.default.string,
+	/**
+	* event handlers
+	*/
 	handleSwitcherItemFocus: prop_types.default.func,
+	/**
+	* Optionally provide an href for the underlying li`
+	*/
 	href: prop_types.default.string,
+	/**
+	* Specify the index of the SwitcherItem
+	*/
 	index: prop_types.default.number,
+	/**
+	* event handlers
+	*/
 	onClick: prop_types.default.func,
+	/**
+	* event handlers
+	*/
 	onKeyDown: prop_types.default.func,
+	/**
+	* Specify the tab index of the Link
+	*/
 	tabIndex: prop_types.default.number,
+	/**
+	* Specify where to open the link.
+	*/
 	target: prop_types.default.string,
+	/**
+	* The rel property for the link.
+	*/
 	rel: prop_types.default.string
 };
 //#endregion

package/lib/components/UnorderedList/UnorderedList.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");
@@ -32,9 +32,21 @@ function UnorderedList({ className, nested = false, isExpressive = false, ...oth
 	});
 }
 UnorderedList.propTypes = {
+	/**
+	* Specify a collection of ListItem's to be rendered in the UnorderedList
+	*/
 	children: prop_types.default.node,
+	/**
+	* Specify an optional className to be applied to the underlying `<ul>` node
+	*/
 	className: prop_types.default.string,
+	/**
+	* Specify whether this ordered list expressive or not
+	*/
 	isExpressive: prop_types.default.bool,
+	/**
+	* Specify whether the list is nested, or not
+	*/
 	nested: prop_types.default.bool
 };
 //#endregion

package/lib/feature-flags.js

@@ -5,7 +5,6 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-require("./_virtual/_rolldown/runtime.js");
 //#region src/feature-flags.js
 /**
 * Copyright IBM Corp. 2016, 2026