@carbon/ibm-products 2.89.0 → 2.90.0

package/lib/components/Tearsheet/usePresenceContext.js

@@ -5,10 +5,9 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-const require_runtime = require('../../_virtual/_rolldown/runtime.js');
-const require_usePresence = require('./usePresence.js');
+require("../../_virtual/_rolldown/runtime.js");
+const require_usePresence = require("./usePresence.js");
 let react = require("react");
-
 //#region src/components/Tearsheet/usePresenceContext.ts
 /**
 * Copyright IBM Corp. 2025
@@ -42,6 +41,5 @@ const usePresenceContext = (open, initialPresenceId) => {
 		isExiting
 	])];
 };
-
 //#endregion
-exports.usePresenceContext = usePresenceContext;
+exports.usePresenceContext = usePresenceContext;

package/lib/components/Toolbar/Toolbar.js

@@ -5,15 +5,14 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-const require_runtime = require('../../_virtual/_rolldown/runtime.js');
-const require_index = require('../../node_modules/classnames/index.js');
-const require_settings = require('../../settings.js');
-const require_devtools = require('../../global/js/utils/devtools.js');
-const require_getFocusableElements = require('../../global/js/utils/getFocusableElements.js');
+const require_runtime = require("../../_virtual/_rolldown/runtime.js");
+const require_index = require("../../node_modules/classnames/index.js");
+const require_settings = require("../../settings.js");
+const require_devtools = require("../../global/js/utils/devtools.js");
+const require_getFocusableElements = require("../../global/js/utils/getFocusableElements.js");
 let react = require("react");
 react = require_runtime.__toESM(react);
 let prop_types = require("prop-types");
-
 //#region src/components/Toolbar/Toolbar.tsx
 /**
 * Copyright IBM Corp. 2021, 2025
@@ -73,12 +72,14 @@ const Toolbar = (0, react.forwardRef)(({ children, className, vertical, ...rest
 const componentName = "Toolbar";
 Toolbar.displayName = componentName;
 Toolbar.propTypes = {
+	/** Provide the content of the `Toolbar` */
 	children: prop_types.node.isRequired,
+	/** Provide an optional class to be applied to the containing node */
 	className: prop_types.string,
+	/** Determines whether the `Toolbar` is rendered vertically */
 	vertical: prop_types.bool
 };
-
 //#endregion
 exports.Toolbar = Toolbar;
 exports.ToolbarContext = ToolbarContext;
-exports.blockClass = blockClass;
+exports.blockClass = blockClass;

package/lib/components/Toolbar/ToolbarButton.js

@@ -5,14 +5,13 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-const require_runtime = require('../../_virtual/_rolldown/runtime.js');
-const require_index = require('../../node_modules/classnames/index.js');
-const require_Toolbar = require('./Toolbar.js');
+const require_runtime = require("../../_virtual/_rolldown/runtime.js");
+const require_index = require("../../node_modules/classnames/index.js");
+const require_Toolbar = require("./Toolbar.js");
 let react = require("react");
 react = require_runtime.__toESM(react);
 let prop_types = require("prop-types");
 let _carbon_react = require("@carbon/react");
-
 //#region src/components/Toolbar/ToolbarButton.tsx
 /**
 * Copyright IBM Corp. 2021, 2024
@@ -36,15 +35,24 @@ const ToolbarButton = (0, react.forwardRef)(({ caret = false, children, classNam
 	}, /* @__PURE__ */ react.default.createElement(react.default.Fragment, null, Icon ? /* @__PURE__ */ react.default.createElement(Icon, null) : null, children, caret && /* @__PURE__ */ react.default.createElement("span", { className: `${blockClass}__caret` })));
 });
 ToolbarButton.displayName = "ToolbarButton";
-const deprecatedProps = { iconDescription: prop_types.string };
+const deprecatedProps = { 
+/**
+* **Deprecated**
+* Specifies the label for the icon button
+*  */
+iconDescription: prop_types.string };
 ToolbarButton.propTypes = {
+	/** Determines whether the caret is rendered */
 	caret: prop_types.bool,
+	/** Provide the content of the `ToolbarButton` */
 	children: prop_types.node,
+	/** Provide an optional class to be applied to the containing node */
 	className: prop_types.string,
+	/** Specifies the label for the icon button */
 	label: prop_types.string.isRequired,
+	/** Specifies the icon to be used by the ToolbarButton component */
 	renderIcon: prop_types.func.isRequired,
 	...deprecatedProps
 };
-
 //#endregion
-exports.ToolbarButton = ToolbarButton;
+exports.ToolbarButton = ToolbarButton;

package/lib/components/Toolbar/ToolbarGroup.js

@@ -5,13 +5,12 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-const require_runtime = require('../../_virtual/_rolldown/runtime.js');
-const require_index = require('../../node_modules/classnames/index.js');
-const require_Toolbar = require('./Toolbar.js');
+const require_runtime = require("../../_virtual/_rolldown/runtime.js");
+const require_index = require("../../node_modules/classnames/index.js");
+const require_Toolbar = require("./Toolbar.js");
 let react = require("react");
 react = require_runtime.__toESM(react);
 let prop_types = require("prop-types");
-
 //#region src/components/Toolbar/ToolbarGroup.tsx
 /**
 * Copyright IBM Corp. 2021, 2024
@@ -30,9 +29,10 @@ const ToolbarGroup = (0, react.forwardRef)(({ className, children, ...rest }, re
 });
 ToolbarGroup.displayName = "ToolbarGroup";
 ToolbarGroup.propTypes = {
+	/** Provide the content of the `ToolbarGroup` */
 	children: prop_types.node.isRequired,
+	/** Provide an optional class to be applied to the containing node */
 	className: prop_types.string
 };
-
 //#endregion
-exports.ToolbarGroup = ToolbarGroup;
+exports.ToolbarGroup = ToolbarGroup;

package/lib/components/TooltipTrigger/TooltipTrigger.js

@@ -5,14 +5,13 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-const require_runtime = require('../../_virtual/_rolldown/runtime.js');
-const require_index = require('../../node_modules/classnames/index.js');
-const require_settings = require('../../settings.js');
+const require_runtime = require("../../_virtual/_rolldown/runtime.js");
+const require_index = require("../../node_modules/classnames/index.js");
+const require_settings = require("../../settings.js");
 let react = require("react");
 react = require_runtime.__toESM(react);
 let prop_types = require("prop-types");
 prop_types = require_runtime.__toESM(prop_types);
-
 //#region src/components/TooltipTrigger/TooltipTrigger.tsx
 /**
 * Copyright IBM Corp. 2023, 2023
@@ -37,9 +36,14 @@ const TooltipTrigger = react.default.forwardRef(({ children, className, ...rest
 });
 TooltipTrigger.displayName = componentName;
 TooltipTrigger.propTypes = {
+	/**
+	* Child content of tooltip trigger
+	*/
 	children: prop_types.default.node,
+	/**
+	* Provide an optional class to be applied to the containing node.
+	*/
 	className: prop_types.default.string
 };
-
 //#endregion
-exports.TooltipTrigger = TooltipTrigger;
+exports.TooltipTrigger = TooltipTrigger;

package/lib/components/TruncatedList/TruncatedList.js

@@ -5,17 +5,16 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-const require_runtime = require('../../_virtual/_rolldown/runtime.js');
-const require_index = require('../../node_modules/classnames/index.js');
-const require_settings = require('../../settings.js');
-const require_useIsomorphicEffect = require('../../global/js/hooks/useIsomorphicEffect.js');
-const require_devtools = require('../../global/js/utils/devtools.js');
+const require_runtime = require("../../_virtual/_rolldown/runtime.js");
+const require_index = require("../../node_modules/classnames/index.js");
+const require_settings = require("../../settings.js");
+const require_useIsomorphicEffect = require("../../global/js/hooks/useIsomorphicEffect.js");
+const require_devtools = require("../../global/js/utils/devtools.js");
 let react = require("react");
 react = require_runtime.__toESM(react);
 let prop_types = require("prop-types");
 prop_types = require_runtime.__toESM(prop_types);
 let _carbon_react = require("@carbon/react");
-
 //#region src/components/TruncatedList/TruncatedList.tsx
 /**
 * Copyright IBM Corp. 2024, 2025
@@ -92,16 +91,46 @@ const TruncatedList = react.default.forwardRef(({ children, className, as: List
 });
 TruncatedList.displayName = componentName;
 TruncatedList.propTypes = {
+	/**
+	* The type of list element to render.
+	* This could be a `ul`, `ol`, or a custom React component.
+	*/
 	as: prop_types.default.oneOfType([prop_types.default.elementType, prop_types.default.string]),
+	/**
+	* Optional class name for expand/collapse button.
+	*/
 	buttonClassName: prop_types.default.string,
+	/**
+	* The contents of the TruncatedList.
+	*/
 	children: prop_types.default.node.isRequired,
+	/**
+	* Provide an optional class to be applied to the containing node.
+	*/
 	className: prop_types.default.string,
+	/**
+	* Number of items to render and display when the list is truncated and collapsed.
+	* Scrolling is not enabled when collapsed. The smallest number is 1.
+	*/
 	collapsedItemsLimit: prop_types.default.number,
+	/**
+	* Maximum number of items to show when the list is expanded. All
+	* items are rendered when the list is expanded. Scrolling is enabled
+	* if there are more items to display than this number.
+	*/
 	expandedItemsLimit: prop_types.default.number,
+	/**
+	* Optional callback reports the collapsed state of the list.
+	*/
 	onClick: prop_types.default.func,
+	/**
+	* Text label for when the list is expanded.
+	*/
 	viewLessLabel: prop_types.default.string,
+	/**
+	* Callback function for building the label when the list is collapsed.
+	*/
 	viewMoreLabel: prop_types.default.func
 };
-
 //#endregion
-exports.TruncatedList = TruncatedList;
+exports.TruncatedList = TruncatedList;

package/lib/components/TruncatedText/TruncatedText.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"TruncatedText.d.ts","sourceRoot":"","sources":["../../../src/components/TruncatedText/TruncatedText.tsx"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAA+B,MAAM,OAAO,CAAC;AAEpD,OAAO,EAAW,gBAAgB,EAAE,MAAM,eAAe,CAAC;AAK1D,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,KAAK,CAAC,EAAE,gBAAgB,CAAC;IACzB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,IAAI,CAAC,EAAE,SAAS,GAAG,QAAQ,CAAC;IAC5B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAKD,eAAO,MAAM,aAAa,2FAyFzB,CAAC"}
+{"version":3,"file":"TruncatedText.d.ts","sourceRoot":"","sources":["../../../src/components/TruncatedText/TruncatedText.tsx"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAA+B,MAAM,OAAO,CAAC;AAEpD,OAAO,EAAW,gBAAgB,EAAE,MAAM,eAAe,CAAC;AAK1D,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,KAAK,CAAC,EAAE,gBAAgB,CAAC;IACzB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,IAAI,CAAC,EAAE,SAAS,GAAG,QAAQ,CAAC;IAC5B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAKD,eAAO,MAAM,aAAa,2FAgGzB,CAAC"}

package/lib/components/TruncatedText/TruncatedText.js

@@ -5,15 +5,14 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-const require_runtime = require('../../_virtual/_rolldown/runtime.js');
-const require_index = require('../../node_modules/classnames/index.js');
-const require_settings = require('../../settings.js');
-const require_devtools = require('../../global/js/utils/devtools.js');
-const require_useTruncatedText = require('./useTruncatedText.js');
+const require_runtime = require("../../_virtual/_rolldown/runtime.js");
+const require_index = require("../../node_modules/classnames/index.js");
+const require_settings = require("../../settings.js");
+const require_devtools = require("../../global/js/utils/devtools.js");
+const require_useTruncatedText = require("./useTruncatedText.js");
 let react = require("react");
 react = require_runtime.__toESM(react);
 let _carbon_react = require("@carbon/react");
-
 //#region src/components/TruncatedText/TruncatedText.tsx
 /**
 * Copyright IBM Corp. 2025
@@ -42,17 +41,20 @@ const TruncatedText = (0, react.forwardRef)((props, ref) => {
 		if (key === "Enter" || key === " ") handleExpand();
 	};
 	const valueBody = /* @__PURE__ */ react.default.createElement("span", {
-		...type === "tooltip" ? { role: "button" } : {},
 		ref: contentRef,
 		className: textContentClasses,
 		id,
 		style: textContentStyles
 	}, value);
-	const tooltipVariant = /* @__PURE__ */ react.default.createElement(_carbon_react.Tooltip, {
+	const tooltipVariant = truncated ? /* @__PURE__ */ react.default.createElement(_carbon_react.Tooltip, {
 		align,
 		autoAlign,
 		label: value
-	}, valueBody);
+	}, /* @__PURE__ */ react.default.createElement("button", {
+		type: "button",
+		className: `${blockClass}__tooltip-trigger`,
+		"aria-label": value
+	}, valueBody)) : valueBody;
 	const expandVariant = /* @__PURE__ */ react.default.createElement(react.default.Fragment, null, valueBody, /* @__PURE__ */ react.default.createElement("span", {
 		"aria-controls": id,
 		"aria-expanded": expanded,
@@ -71,6 +73,5 @@ const TruncatedText = (0, react.forwardRef)((props, ref) => {
 	}, truncated ? truncatedBody : valueBody);
 });
 TruncatedText.displayName = componentName;
-
 //#endregion
-exports.TruncatedText = TruncatedText;
+exports.TruncatedText = TruncatedText;

package/lib/components/TruncatedText/useTruncatedText.js

@@ -5,10 +5,9 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-const require_runtime = require('../../_virtual/_rolldown/runtime.js');
-const require_checkForOverflow = require('../../global/js/utils/checkForOverflow.js');
+require("../../_virtual/_rolldown/runtime.js");
+const require_checkForOverflow = require("../../global/js/utils/checkForOverflow.js");
 let react = require("react");
-
 //#region src/components/TruncatedText/useTruncatedText.ts
 /**
 * Copyright IBM Corp. 2025
@@ -41,6 +40,5 @@ function useTruncatedText({ lines, value, expanded }) {
 		truncated
 	};
 }
-
 //#endregion
-exports.default = useTruncatedText;
+exports.default = useTruncatedText;

package/lib/components/UserAvatar/UserAvatar.js

@@ -5,19 +5,18 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-const require_runtime = require('../../_virtual/_rolldown/runtime.js');
-const require_index = require('../../node_modules/classnames/index.js');
-const require_settings = require('../../settings.js');
-const require_devtools = require('../../global/js/utils/devtools.js');
-require('../../global/js/utils/props-helper.js');
-const require_TooltipTrigger = require('../TooltipTrigger/TooltipTrigger.js');
+const require_runtime = require("../../_virtual/_rolldown/runtime.js");
+const require_index = require("../../node_modules/classnames/index.js");
+const require_settings = require("../../settings.js");
+const require_devtools = require("../../global/js/utils/devtools.js");
+require("../../global/js/utils/props-helper.js");
+const require_TooltipTrigger = require("../TooltipTrigger/TooltipTrigger.js");
 let react = require("react");
 react = require_runtime.__toESM(react);
 let prop_types = require("prop-types");
 prop_types = require_runtime.__toESM(prop_types);
 let _carbon_react = require("@carbon/react");
 let _carbon_react_icons = require("@carbon/react/icons");
-
 //#region src/components/UserAvatar/UserAvatar.tsx
 /**
 * Copyright IBM Corp. 2024, 2025
@@ -73,6 +72,10 @@ const UserAvatar = react.default.forwardRef((props, ref) => {
 });
 UserAvatar.displayName = componentName;
 UserAvatar.propTypes = {
+	/**
+	* Provide the background color need to be set for UserAvatar. Background color will be set based on lighter or darker theme.
+	* For example: if you select order-5-purple, it will take $purple-60 for lighter theme and $purple-50 for darker theme.
+	*/
 	backgroundColor: prop_types.default.oneOf([
 		"order-1-cyan",
 		"order-2-gray",
@@ -87,21 +90,45 @@ UserAvatar.propTypes = {
 		"order-11-purple",
 		"order-12-teal"
 	]),
+	/**
+	* Provide an optional class to be applied to the containing node.
+	*/
 	className: prop_types.default.string,
+	/**
+	* When passing the image prop, supply a full path to the image to be displayed.
+	*/
+	/**@ts-ignore */
 	image: prop_types.default.string,
+	/**
+	* When passing the image prop use the imageDescription prop to describe the image for screen reader.
+	*/
+	/**@ts-ignore */
 	imageDescription: prop_types.default.string,
+	/**
+	* When passing the name prop, either send the initials to be used or the user's full name. The first two capital letters of the user's name will be used as the name.
+	*/
 	name: prop_types.default.string,
+	/**
+	* Provide a custom icon to use if you need to use an icon other than the default one
+	*/
+	/**@ts-ignore */
 	renderIcon: prop_types.default.oneOfType([
 		prop_types.default.func,
 		prop_types.default.object,
 		prop_types.default.string
 	]),
+	/**
+	* Set the size of the avatar circle
+	*/
 	size: prop_types.default.oneOf([
 		"xl",
 		"lg",
 		"md",
 		"sm"
 	]),
+	/**
+	* Specify how the trigger should align with the tooltip
+	*/
 	tooltipAlignment: prop_types.default.oneOf([
 		"top",
 		"top-left",
@@ -112,8 +139,10 @@ UserAvatar.propTypes = {
 		"left",
 		"right"
 	]),
+	/**
+	* Pass in the display name to have it shown on hover
+	*/
 	tooltipText: prop_types.default.string
 };
-
 //#endregion
-exports.UserAvatar = UserAvatar;
+exports.UserAvatar = UserAvatar;

package/lib/components/UserProfileImage/UserProfileImage.js

@@ -5,19 +5,18 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-const require_runtime = require('../../_virtual/_rolldown/runtime.js');
-const require_index = require('../../node_modules/classnames/index.js');
-const require_settings = require('../../settings.js');
-const require_devtools = require('../../global/js/utils/devtools.js');
-require('../../global/js/utils/props-helper.js');
-const require_TooltipTrigger = require('../TooltipTrigger/TooltipTrigger.js');
+const require_runtime = require("../../_virtual/_rolldown/runtime.js");
+const require_index = require("../../node_modules/classnames/index.js");
+const require_settings = require("../../settings.js");
+const require_devtools = require("../../global/js/utils/devtools.js");
+require("../../global/js/utils/props-helper.js");
+const require_TooltipTrigger = require("../TooltipTrigger/TooltipTrigger.js");
 let react = require("react");
 react = require_runtime.__toESM(react);
 let prop_types = require("prop-types");
 prop_types = require_runtime.__toESM(prop_types);
 let _carbon_react = require("@carbon/react");
 let _carbon_react_icons = require("@carbon/react/icons");
-
 //#region src/components/UserProfileImage/UserProfileImage.tsx
 var import_classnames = /* @__PURE__ */ require_runtime.__toESM(require_index.default);
 const blockClass = `${require_settings.pkg.prefix}--user-profile-image`;
@@ -116,6 +115,10 @@ UserProfileImage.deprecated = {
 };
 UserProfileImage.displayName = componentName;
 UserProfileImage.propTypes = {
+	/**
+	* The background color passed should match one of the background colors in the library documentation:
+	* https://pages.github.ibm.com/carbon/ibm-products/patterns/user-profile-images/
+	*/
 	backgroundColor: prop_types.default.oneOf([
 		"light-cyan",
 		"dark-cyan",
@@ -130,18 +133,47 @@ UserProfileImage.propTypes = {
 		"light-teal",
 		"dark-teal"
 	]),
+	/**
+	* Provide an optional class to be applied to the containing node.
+	*/
 	className: prop_types.default.string,
+	/**
+	* Provide a custom icon to use if you need to use an icon other than the included ones
+	*/
 	icon: prop_types.default.func,
+	/**
+	* When passing the image prop, supply a full path to the image to be displayed.
+	*/
+	/**@ts-ignore */
 	image: prop_types.default.string,
+	/**
+	* When passing the image prop use the imageDescription prop to describe the image for screen reader.
+	*/
+	/**@ts-ignore */
 	imageDescription: prop_types.default.string,
+	/**
+	* When passing the initials prop, either send the initials to be used or the user's display name. The first two capital letters of the display name will be used as the initials.
+	*/
 	initials: prop_types.default.string,
+	/**
+	* When passing the kind prop, use either "user" or "group". The values match up to the Carbon Library icons.
+	*/
 	kind: prop_types.default.oneOf(["user", "group"]),
+	/**
+	* Set the size of the avatar circle
+	*/
 	size: prop_types.default.oneOf([
 		"xl",
 		"lg",
 		"md"
 	]).isRequired,
+	/**
+	* Set theme in which the component will be rendered
+	*/
 	theme: prop_types.default.oneOf(["light", "dark"]).isRequired,
+	/**
+	* Specify how the trigger should align with the tooltip
+	*/
 	tooltipAlignment: prop_types.default.oneOf([
 		"top",
 		"top-left",
@@ -152,8 +184,10 @@ UserProfileImage.propTypes = {
 		"left",
 		"right"
 	]),
+	/**
+	* Pass in the display name to have it shown on hover
+	*/
 	tooltipText: prop_types.default.string
 };
-
 //#endregion
-exports.UserProfileImage = UserProfileImage;
+exports.UserProfileImage = UserProfileImage;

package/lib/components/WebTerminal/WebTerminal.js

@@ -5,19 +5,18 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-const require_runtime = require('../../_virtual/_rolldown/runtime.js');
-const require_index = require('../../node_modules/classnames/index.js');
-const require_settings = require('../../settings.js');
-const require_usePrefersReducedMotion = require('../../global/js/hooks/usePrefersReducedMotion.js');
-const require_devtools = require('../../global/js/utils/devtools.js');
-const require_index$1 = require('./hooks/index.js');
+const require_runtime = require("../../_virtual/_rolldown/runtime.js");
+const require_index = require("../../node_modules/classnames/index.js");
+const require_settings = require("../../settings.js");
+const require_usePrefersReducedMotion = require("../../global/js/hooks/usePrefersReducedMotion.js");
+const require_devtools = require("../../global/js/utils/devtools.js");
+const require_index$1 = require("./hooks/index.js");
 let react = require("react");
 react = require_runtime.__toESM(react);
 let prop_types = require("prop-types");
 prop_types = require_runtime.__toESM(prop_types);
 let _carbon_react = require("@carbon/react");
 let _carbon_react_icons = require("@carbon/react/icons");
-
 //#region src/components/WebTerminal/WebTerminal.tsx
 /**
 * Copyright IBM Corp. 2020, 2022
@@ -118,19 +117,44 @@ const WebTerminal = react.default.forwardRef(({ actions = defaults.actions, chil
 });
 WebTerminal.displayName = componentName;
 WebTerminal.propTypes = {
+	/**
+	* An array of actions to be displayed in the web terminal header bar
+	*/
+	/**@ts-ignore */
 	actions: prop_types.default.arrayOf(prop_types.default.shape({
 		renderIcon: prop_types.default.func.isRequired,
 		onClick: prop_types.default.func.isRequired,
 		iconDescription: prop_types.default.string.isRequired
 	})),
+	/**
+	* Provide your own terminal component as children to show up in the web terminal
+	*/
 	children: prop_types.default.oneOfType([prop_types.default.arrayOf(prop_types.default.node), prop_types.default.node]).isRequired,
+	/**
+	* Custom classname for additional styling of the web terminal
+	*/
 	className: prop_types.default.string,
+	/**
+	* Icon description for the close button
+	*/
 	closeIconDescription: prop_types.default.string.isRequired,
+	/**
+	* Array of objects for each documentation link. Each documentation link uses the prop types of OverflowMenuItems. See more: https://react.carbondesignsystem.com/?path=/docs/components-overflowmenu--default
+	*/
+	/**@ts-ignore */
 	documentationLinks: prop_types.default.arrayOf(prop_types.default.shape({ ..._carbon_react.OverflowMenuItem.propTypes })),
+	/**
+	* Description for the documentation link overflow menu tooltip
+	*/
 	documentationLinksIconDescription: prop_types.default.string,
+	/**
+	* Optionally pass if the web terminal should be open by default
+	*/
 	isInitiallyOpen: prop_types.default.bool,
+	/**
+	* Specifies aria label for Web terminal
+	*/
 	webTerminalAriaLabel: prop_types.default.string
 };
-
 //#endregion
-exports.WebTerminal = WebTerminal;
+exports.WebTerminal = WebTerminal;

package/lib/components/WebTerminal/WebTerminalContentWrapper.js

@@ -5,15 +5,14 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-const require_runtime = require('../../_virtual/_rolldown/runtime.js');
-const require_index = require('../../node_modules/classnames/index.js');
-const require_settings = require('../../settings.js');
-const require_index$1 = require('./hooks/index.js');
+const require_runtime = require("../../_virtual/_rolldown/runtime.js");
+const require_index = require("../../node_modules/classnames/index.js");
+const require_settings = require("../../settings.js");
+const require_index$1 = require("./hooks/index.js");
 let react = require("react");
 react = require_runtime.__toESM(react);
 let prop_types = require("prop-types");
 prop_types = require_runtime.__toESM(prop_types);
-
 //#region src/components/WebTerminal/WebTerminalContentWrapper.tsx
 /**
 * Copyright IBM Corp. 2022, 2022
@@ -33,7 +32,10 @@ const WebTerminalContentWrapper = react.default.forwardRef(({ children, ...rest
 	}, children);
 });
 WebTerminalContentWrapper.displayName = componentName;
-WebTerminalContentWrapper.propTypes = { children: prop_types.default.oneOfType([prop_types.default.arrayOf(prop_types.default.node), prop_types.default.node]).isRequired };
-
+WebTerminalContentWrapper.propTypes = { 
+/**
+* Pass in content as children.
+*/
+children: prop_types.default.oneOfType([prop_types.default.arrayOf(prop_types.default.node), prop_types.default.node]).isRequired };
 //#endregion
-exports.WebTerminalContentWrapper = WebTerminalContentWrapper;
+exports.WebTerminalContentWrapper = WebTerminalContentWrapper;

package/lib/components/WebTerminal/hooks/index.js

@@ -5,12 +5,11 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-const require_runtime = require('../../../_virtual/_rolldown/runtime.js');
+const require_runtime = require("../../../_virtual/_rolldown/runtime.js");
 let react = require("react");
 react = require_runtime.__toESM(react);
 let prop_types = require("prop-types");
 prop_types = require_runtime.__toESM(prop_types);
-
 //#region src/components/WebTerminal/hooks/index.tsx
 const WebTerminalContext = (0, react.createContext)({});
 const WebTerminalProvider = ({ children }) => {
@@ -25,11 +24,14 @@ const WebTerminalProvider = ({ children }) => {
 		toggleWebTerminal
 	} }, children);
 };
-WebTerminalProvider.propTypes = { children: prop_types.default.oneOfType([prop_types.default.arrayOf(prop_types.default.node), prop_types.default.node]).isRequired };
+WebTerminalProvider.propTypes = { 
+/**
+* Provide your own terminal component as children to show up in the web terminal
+*/
+children: prop_types.default.oneOfType([prop_types.default.arrayOf(prop_types.default.node), prop_types.default.node]).isRequired };
 const useWebTerminal = () => {
 	return (0, react.useContext)(WebTerminalContext);
 };
-
 //#endregion
 exports.WebTerminalProvider = WebTerminalProvider;
-exports.useWebTerminal = useWebTerminal;
+exports.useWebTerminal = useWebTerminal;