@carbon/ibm-products 2.89.0 → 2.90.0

package/es/components/FilterPanel/FilterPanelCheckbox/FilterPanelCheckbox.js

@@ -13,7 +13,6 @@ import { FilterPanelLabel } from "../FilterPanelLabel/FilterPanelLabel.js";
 import React from "react";
 import PropTypes from "prop-types";
 import { Checkbox } from "@carbon/react";
-
 //#region src/components/FilterPanel/FilterPanelCheckbox/FilterPanelCheckbox.jsx
 /**
 * Copyright IBM Corp. 2024, 2024
@@ -54,12 +53,26 @@ FilterPanelCheckbox.deprecated = {
 FilterPanelCheckbox = pkg.checkComponentEnabled(FilterPanelCheckbox, componentName);
 FilterPanelCheckbox.displayName = componentName;
 FilterPanelCheckbox.propTypes = {
+	/**
+	* Optional class to be applied to the containing node.
+	*/
 	className: PropTypes.string,
+	/**
+	* Number to be displayed with the checkbox.
+	*/
 	count: PropTypes.oneOfType([PropTypes.number, PropTypes.string]),
+	/**
+	* Unique identifier.
+	*/
 	id: PropTypes.string.isRequired,
+	/**
+	* Label to be displayed with the checkbox.
+	*/
 	labelText: PropTypes.node.isRequired,
+	/**
+	* Optional title attribute for the label.
+	*/
 	title: PropTypes.string
 };
-
 //#endregion
-export { FilterPanelCheckbox };
+export { FilterPanelCheckbox };

package/es/components/FilterPanel/FilterPanelCheckboxWithOverflow/FilterPanelCheckboxWithOverflow.js

@@ -13,7 +13,6 @@ import { FilterPanelCheckbox } from "../FilterPanelCheckbox/FilterPanelCheckbox.
 import React, { useEffect, useRef, useState } from "react";
 import PropTypes from "prop-types";
 import { OverflowMenu } from "@carbon/react";
-
 //#region src/components/FilterPanel/FilterPanelCheckboxWithOverflow/FilterPanelCheckboxWithOverflow.jsx
 /**
 * Copyright IBM Corp. 2024, 2024
@@ -50,6 +49,15 @@ let FilterPanelCheckboxWithOverflow = React.forwardRef(({ children, className, c
 		className: (0, import_classnames.default)(blockClass, className, { [`${blockClass}--open`]: menuIsOpen }),
 		onBlur: ({ relatedTarget }) => setHideButton(relatedTarget),
 		onFocus: () => setShowMenuButton(true),
+		/**
+		* Desired behavior: onMouseEnter shows the menu, even when the user mouse-presses and -releases the checkbox/label.
+		* Issue: onMouseDown > checkbox/label triggers an onBlur event and hides the menu button.
+		*   Releasing the mouse button then shows the button again.
+		*   This behavior "flickers" the menu button.
+		* Solution: onMouseDown > preventDefault prevents onBlur from being called.
+		*   The menu button remains visible at all times.
+		*   This applies only when using the mouse; it is not an issue using the keyboard.
+		*/
 		onMouseDown: (event) => event.preventDefault(),
 		onMouseEnter: () => setShowMenuButton(true),
 		onMouseLeave: () => setHideButton(document.activeElement),
@@ -82,12 +90,33 @@ FilterPanelCheckboxWithOverflow.deprecated = {
 FilterPanelCheckboxWithOverflow = pkg.checkComponentEnabled(FilterPanelCheckboxWithOverflow, componentName);
 FilterPanelCheckboxWithOverflow.displayName = componentName;
 FilterPanelCheckboxWithOverflow.propTypes = {
+	/**
+	* Children containing `OverflowMenuItems`.
+	*/
 	children: PropTypes.node.isRequired,
+	/**
+	* Optional class to be applied to the containing node.
+	*/
 	className: PropTypes.string,
+	/**
+	* Number to be displayed with the checkbox.
+	*/
 	count: PropTypes.oneOfType([PropTypes.number, PropTypes.string]),
+	/**
+	* Unique identifier.
+	*/
 	id: PropTypes.string.isRequired,
+	/**
+	* Label to be displayed with the checkbox.
+	*/
 	labelText: PropTypes.node.isRequired,
+	/**
+	* Checkbox event handler.
+	*/
 	onChange: PropTypes.func,
+	/**
+	* Props specific to the internal `OverflowMenu` component.
+	*/
 	overflowMenuProps: PropTypes.shape({
 		["aria-label"]: PropTypes.string,
 		flipped: PropTypes.bool,
@@ -96,8 +125,10 @@ FilterPanelCheckboxWithOverflow.propTypes = {
 		open: PropTypes.bool,
 		selectorPrimaryFocus: PropTypes.string
 	}),
+	/**
+	* Optional title attribute for the label.
+	*/
 	title: PropTypes.string
 };
-
 //#endregion
-export { FilterPanelCheckboxWithOverflow };
+export { FilterPanelCheckboxWithOverflow };

package/es/components/FilterPanel/FilterPanelGroup/FilterPanelGroup.js

@@ -12,7 +12,6 @@ import { getDevtoolsProps } from "../../../global/js/utils/devtools.js";
 import { FilterPanelLabel } from "../FilterPanelLabel/FilterPanelLabel.js";
 import React from "react";
 import PropTypes from "prop-types";
-
 //#region src/components/FilterPanel/FilterPanelGroup/FilterPanelGroup.jsx
 /**
 * Copyright IBM Corp. 2024, 2024
@@ -46,12 +45,26 @@ FilterPanelGroup.deprecated = {
 FilterPanelGroup = pkg.checkComponentEnabled(FilterPanelGroup, componentName);
 FilterPanelGroup.displayName = componentName;
 FilterPanelGroup.propTypes = {
+	/**
+	* Provide the contents of the FilterPanelGroup.
+	*/
 	children: PropTypes.node.isRequired,
+	/**
+	* Optional class to be applied to the containing node.
+	*/
 	className: PropTypes.string,
+	/**
+	* Number to be displayed with the label.
+	*/
 	count: PropTypes.oneOfType([PropTypes.number, PropTypes.string]),
+	/**
+	* The label for the component.
+	*/
 	labelText: PropTypes.node.isRequired,
+	/**
+	* Optional title attribute for the label.
+	*/
 	title: PropTypes.string
 };
-
 //#endregion
-export { FilterPanelGroup };
+export { FilterPanelGroup };

package/es/components/FilterPanel/FilterPanelLabel/FilterPanelLabel.js

@@ -11,7 +11,6 @@ import { pkg } from "../../../settings.js";
 import { getDevtoolsProps } from "../../../global/js/utils/devtools.js";
 import React from "react";
 import PropTypes from "prop-types";
-
 //#region src/components/FilterPanel/FilterPanelLabel/FilterPanelLabel.jsx
 /**
 * Copyright IBM Corp. 2024, 2024
@@ -39,11 +38,22 @@ let FilterPanelLabel = React.forwardRef(({ className, count, labelText, title, .
 FilterPanelLabel = pkg.checkComponentEnabled(FilterPanelLabel, componentName);
 FilterPanelLabel.displayName = componentName;
 FilterPanelLabel.propTypes = {
+	/**
+	* Optional class to be applied to the containing node.
+	*/
 	className: PropTypes.string,
+	/**
+	* Number to be displayed with the label.
+	*/
 	count: PropTypes.oneOfType([PropTypes.number, PropTypes.string]),
+	/**
+	* The label for the component.
+	*/
 	labelText: PropTypes.node.isRequired,
+	/**
+	* Optional title attribute for the label.
+	*/
 	title: PropTypes.string
 };
-
 //#endregion
-export { FilterPanelLabel };
+export { FilterPanelLabel };

package/es/components/FilterPanel/FilterPanelSearch/FilterPanelSearch.js

@@ -12,7 +12,6 @@ import { getDevtoolsProps } from "../../../global/js/utils/devtools.js";
 import React, { useEffect, useState } from "react";
 import PropTypes from "prop-types";
 import { Search } from "@carbon/react";
-
 //#region src/components/FilterPanel/FilterPanelSearch/FilterPanelSearch.jsx
 /**
 * Copyright IBM Corp. 2024, 2024
@@ -63,10 +62,20 @@ FilterPanelSearch.deprecated = {
 FilterPanelSearch = pkg.checkComponentEnabled(FilterPanelSearch, componentName);
 FilterPanelSearch.displayName = componentName;
 FilterPanelSearch.propTypes = {
+	/**
+	* Provide the contents of the FilterPanelSearch.
+	*/
 	children: PropTypes.node,
+	/**
+	* Optional class to be applied to the containing node.
+	*/
 	className: PropTypes.string,
-	searchProps: PropTypes.shape({ labelText: PropTypes.string.isRequired }).isRequired
+	/**
+	* Props specific to the internal `Search` component.
+	*/
+	searchProps: PropTypes.shape({ 
+	/** The label text for the Search icon. */
+labelText: PropTypes.string.isRequired }).isRequired
 };
-
 //#endregion
-export { FilterPanelSearch };
+export { FilterPanelSearch };

package/es/components/FilterSummary/FilterSummary.js

@@ -19,7 +19,6 @@ import React, { useRef, useState } from "react";
 import PropTypes from "prop-types";
 import { Button, IconButton } from "@carbon/react";
 import { ChevronDown } from "@carbon/react/icons";
-
 //#region src/components/FilterSummary/FilterSummary.tsx
 /**
 * Copyright IBM Corp. 2022, 2024
@@ -104,10 +103,10 @@ FilterSummary.propTypes = {
 	clearButtonInline: PropTypes.bool,
 	clearFilters: PropTypes.func.isRequired,
 	clearFiltersText: PropTypes.string,
+	/**@ts-ignore */
 	filters: PropTypes.arrayOf(PropTypes.object).isRequired,
 	overflowType: PropTypes.oneOf(["default", "tag"]),
 	renderLabel: PropTypes.func
 };
-
 //#endregion
-export { FilterSummary as default };
+export { FilterSummary as default };

package/es/components/FullPageError/FullPageError.js

@@ -15,7 +15,6 @@ import { ErrorGenericSVG } from "./assets/ErrorGenericSVG.js";
 import React from "react";
 import PropTypes from "prop-types";
 import { Column, Grid } from "@carbon/react";
-
 //#region src/components/FullPageError/FullPageError.tsx
 /**
 * Copyright IBM Corp. 2024, 2024
@@ -56,17 +55,35 @@ const FullPageError = React.forwardRef(({ children, className, description, labe
 });
 FullPageError.displayName = componentName;
 FullPageError.propTypes = {
+	/**
+	* Provide the contents of the FullPageError.
+	*/
 	children: PropTypes.node,
+	/**
+	* Provide an optional class to be applied to the containing node.
+	*/
 	className: PropTypes.string,
+	/**
+	* String that will provide the description for the error code. <br/>
+	* This is optional for 403 and 404 kinds, and passing this would override their default descriptions.
+	*/
 	description: PropTypes.string.isRequired,
+	/**
+	* The kind of error page to be displayed, default is custom
+	*/
 	kind: PropTypes.oneOf([
 		"custom",
 		"403",
 		"404"
 	]),
+	/**
+	* String that will describe the error that occurred
+	*/
 	label: PropTypes.string.isRequired,
+	/**
+	* This will be for the main title of the FullPageError component
+	*/
 	title: PropTypes.string.isRequired
 };
-
 //#endregion
-export { FullPageError };
+export { FullPageError };

package/es/components/FullPageError/assets/Error403SVG.js

@@ -7,7 +7,6 @@
 
 import React from "react";
 import { string } from "prop-types";
-
 //#region src/components/FullPageError/assets/Error403SVG.jsx
 /**
 * Copyright IBM Corp. 2024, 2024
@@ -706,6 +705,5 @@ const Error403SVG = ({ className }) => {
 	}))));
 };
 Error403SVG.propTypes = { className: string };
-
 //#endregion
-export { Error403SVG };
+export { Error403SVG };

package/es/components/FullPageError/assets/Error404SVG.js

@@ -7,7 +7,6 @@
 
 import React from "react";
 import { string } from "prop-types";
-
 //#region src/components/FullPageError/assets/Error404SVG.jsx
 /**
 * Copyright IBM Corp. 2024, 2024
@@ -615,6 +614,5 @@ const Error404SVG = ({ className }) => {
 	}))));
 };
 Error404SVG.propTypes = { className: string };
-
 //#endregion
-export { Error404SVG };
+export { Error404SVG };

package/es/components/FullPageError/assets/ErrorGenericSVG.js

@@ -7,7 +7,6 @@
 
 import React from "react";
 import { string } from "prop-types";
-
 //#region src/components/FullPageError/assets/ErrorGenericSVG.jsx
 /**
 * Copyright IBM Corp. 2024, 2024
@@ -706,6 +705,5 @@ const ErrorGenericSVG = ({ className }) => {
 	}))));
 };
 ErrorGenericSVG.propTypes = { className: string };
-
 //#endregion
-export { ErrorGenericSVG };
+export { ErrorGenericSVG };

package/es/components/GetStartedCard/GetStartedCard.js

@@ -9,7 +9,6 @@ import { getDevtoolsProps } from "../../global/js/utils/devtools.js";
 import { Card } from "../Card/Card.js";
 import React from "react";
 import PropTypes from "prop-types";
-
 //#region src/components/GetStartedCard/GetStartedCard.tsx
 /**
 * Copyright IBM Corp. 2024, 2024
@@ -31,22 +30,57 @@ const GetStartedCard = React.forwardRef((props, ref) => {
 });
 GetStartedCard.displayName = componentName;
 GetStartedCard.propTypes = {
+	/**
+	* Provide an optional class to be applied to the containing node.
+	*/
 	className: PropTypes.string,
+	/**
+	* Optional if the card should be disabled
+	*/
 	disabled: PropTypes.bool,
+	/**
+	* Provides the action icon that's displayed at the footer of the card
+	*/
+	/**@ts-ignore */
 	footerActionIcon: PropTypes.oneOfType([PropTypes.func, PropTypes.object]),
+	/**
+	* Optional label for the top of the card
+	*/
 	label: PropTypes.oneOfType([PropTypes.string, PropTypes.node]),
+	/**
+	* Optional media content like an image to be placed in the card
+	*/
 	media: PropTypes.node,
+	/**
+	* Icons that are displayed on the card showing the time and skill needed
+	*/
+	/**@ts-ignore */
 	metadata: PropTypes.arrayOf(PropTypes.shape({
 		id: PropTypes.string,
 		icon: PropTypes.oneOfType([PropTypes.func, PropTypes.object]),
 		iconDescription: PropTypes.string
 	})),
+	/**
+	* Provides the callback for a clickable card
+	*/
 	onClick: PropTypes.func.isRequired,
+	/**
+	* Provides the icon that's displayed at the top of the card
+	*/
+	/**@ts-ignore */
 	pictogram: PropTypes.oneOfType([PropTypes.func, PropTypes.object]),
+	/**
+	* Provides number for card for tasks in a sequential order
+	*/
 	sequence: PropTypes.number,
+	/**
+	* Provides the status that's displayed at the top of the card
+	*/
 	status: PropTypes.oneOf(["complete", "incomplete"]),
+	/**
+	* Title that's displayed at the top of the card
+	*/
 	title: PropTypes.oneOfType([PropTypes.string, PropTypes.node])
 };
-
 //#endregion
-export { GetStartedCard };
+export { GetStartedCard };

package/es/components/Guidebanner/Guidebanner.js

@@ -17,7 +17,6 @@ import React, { useRef, useState } from "react";
 import PropTypes from "prop-types";
 import { Button, IconButton } from "@carbon/react";
 import { CaretLeft, CaretRight, Close, Idea } from "@carbon/react/icons";
-
 //#region src/components/Guidebanner/Guidebanner.tsx
 /**
 * Copyright IBM Corp. 2023, 2025
@@ -83,8 +82,8 @@ const Guidebanner = React.forwardRef((props, ref) => {
 		onClick: handleClickToggle,
 		ref: toggleRef,
 		"aria-controls": !open ? carouselContentId : void 0,
-		"aria-expanded": !open
-	}, open ? expandButtonLabel : collapseButtonLabel), showNavigation && /* @__PURE__ */ React.createElement(React.Fragment, null, /* @__PURE__ */ React.createElement("span", { className: (0, import_classnames.default)(`${blockClass}__back-button`, [scrollPosition === 0 ? `${blockClass}__back-button--disabled` : null]) }, /* @__PURE__ */ React.createElement(IconButton, {
+		"aria-expanded": open
+	}, open ? collapseButtonLabel : expandButtonLabel), showNavigation && /* @__PURE__ */ React.createElement(React.Fragment, null, /* @__PURE__ */ React.createElement("span", { className: (0, import_classnames.default)(`${blockClass}__back-button`, [scrollPosition === 0 ? `${blockClass}__back-button--disabled` : null]) }, /* @__PURE__ */ React.createElement(IconButton, {
 		align: "top",
 		disabled: scrollPosition === 0,
 		kind: "ghost",
@@ -112,20 +111,65 @@ const Guidebanner = React.forwardRef((props, ref) => {
 });
 Guidebanner.displayName = componentName;
 Guidebanner.propTypes = {
+	/**
+	* Provide the contents of the Guidebanner.
+	* One or more GuidebannerElement components are required.
+	*/
 	children: PropTypes.node,
+	/**
+	* Provide an optional class to be applied to the containing node.
+	*/
 	className: PropTypes.string,
+	/**
+	* Tooltip text and aria label for the Close button icon.
+	*/
 	closeIconDescription: PropTypes.string,
+	/**
+	* Text label for the Collapse button.
+	*/
 	collapseButtonLabel: PropTypes.string,
+	/**
+	* When true, the Guidebanner will initialize in a collapsed state,
+	* showing the title and the Expand button.
+	*
+	* When expanded, it will show the GuidebannerElement child components and the Collapse button.
+	*/
 	collapsible: PropTypes.bool,
+	/**
+	* Text label for the Expand button.
+	*/
 	expandButtonLabel: PropTypes.string,
+	/**
+	* Tooltip text and aria label for the Next button icon.
+	*/
 	nextIconDescription: PropTypes.string,
+	/**
+	* A handler for managing the controlled state of open prop. If not passed the open prop will not be honored and an uncontrolled state will be used.
+	*/
 	onChange: PropTypes.func,
+	/**
+	* If defined, a Close button will render in the top-right corner and a
+	* callback function will be triggered when button is clicked.
+	*/
 	onClose: PropTypes.func,
+	/**
+	* Specify whether the Guidebanner is currently open.
+	*/
 	open: PropTypes.bool,
+	/**
+	* Tooltip text and aria label for the Back button icon.
+	*/
 	previousIconDescription: PropTypes.string,
+	/**
+	* Title text.
+	*/
 	title: PropTypes.string.isRequired,
+	/**
+	* If true, insert 1 rem of "space" on the left of the component.
+	* This will allow the component's content to line up with other
+	* content on the page under special circumstances.
+	*/
 	withLeftGutter: PropTypes.bool
 };
-
 //#endregion
-export { Guidebanner };
+export { Guidebanner };

package/es/components/Guidebanner/GuidebannerElement.js

@@ -11,7 +11,6 @@ import { pkg } from "../../settings.js";
 import { getDevtoolsProps } from "../../global/js/utils/devtools.js";
 import React from "react";
 import PropTypes from "prop-types";
-
 //#region src/components/Guidebanner/GuidebannerElement.tsx
 /**
 * Copyright IBM Corp. 2023, 2024
@@ -36,11 +35,23 @@ const GuidebannerElement = React.forwardRef(({ button, className, description, t
 });
 GuidebannerElement.displayName = componentName;
 GuidebannerElement.propTypes = {
+	/**
+	* An optional button can be rendered below the description.
+	* This can be a link, button, Coachmark button, etc.
+	*/
 	button: PropTypes.node,
+	/**
+	* Provide an optional class to be applied to the containing node.
+	*/
 	className: PropTypes.string,
+	/**
+	* The description of the element.
+	*/
 	description: PropTypes.oneOfType([PropTypes.string, PropTypes.node]).isRequired,
+	/**
+	* The title of the element.
+	*/
 	title: PropTypes.string
 };
-
 //#endregion
-export { GuidebannerElement };
+export { GuidebannerElement };

package/es/components/Guidebanner/GuidebannerElementButton.js

@@ -13,7 +13,6 @@ import React from "react";
 import PropTypes from "prop-types";
 import { Button } from "@carbon/react";
 import { Crossroads } from "@carbon/react/icons";
-
 //#region src/components/Guidebanner/GuidebannerElementButton.tsx
 /**
 * Copyright IBM Corp. 2023, 2024
@@ -51,10 +50,19 @@ const GuidebannerElementButton = React.forwardRef(({ children, className, iconDe
 });
 GuidebannerElementButton.displayName = componentName;
 GuidebannerElementButton.propTypes = {
+	/**
+	* Provide the contents of the GuidebannerElementButton.
+	*/
 	children: PropTypes.node.isRequired,
+	/**
+	* Provide an optional class to be applied to the containing node.
+	*/
 	className: PropTypes.string,
+	/**
+	* If type is "primary", then return a tertiary button with the "crossroads" icon,
+	* else return a ghost button.
+	*/
 	type: PropTypes.string
 };
-
 //#endregion
-export { GuidebannerElementButton };
+export { GuidebannerElementButton };

package/es/components/Guidebanner/GuidebannerElementLink.js

@@ -12,7 +12,6 @@ import { getDevtoolsProps } from "../../global/js/utils/devtools.js";
 import React from "react";
 import PropTypes from "prop-types";
 import { Link } from "@carbon/react";
-
 //#region src/components/Guidebanner/GuidebannerElementLink.tsx
 /**
 * Copyright IBM Corp. 2023, 2024
@@ -39,9 +38,14 @@ const GuidebannerElementLink = React.forwardRef(({ children, className, ...rest
 });
 GuidebannerElementLink.displayName = componentName;
 GuidebannerElementLink.propTypes = {
+	/**
+	* Provide the contents of the GuidebannerElementLink.
+	*/
 	children: PropTypes.node.isRequired,
+	/**
+	* Provide an optional class to be applied to the containing node.
+	*/
 	className: PropTypes.string
 };
-
 //#endregion
-export { GuidebannerElementLink };
+export { GuidebannerElementLink };

package/es/components/HTTPErrors/HTTPError403/HTTPError403.js

@@ -13,7 +13,6 @@ import { HTTPErrorSvg403 } from "../assets/HTTPErrorSvg403.js";
 import { HTTPErrorContent } from "../HTTPErrorContent.js";
 import React from "react";
 import { arrayOf, shape, string } from "prop-types";
-
 //#region src/components/HTTPErrors/HTTPError403/HTTPError403.tsx
 /**
 * Copyright IBM Corp. 2021, 2021
@@ -52,15 +51,36 @@ HTTPError403.deprecated = {
 };
 HTTPError403.displayName = componentName;
 HTTPError403.propTypes = {
+	/**
+	* Provide an optional class to be applied to the containing node
+	*/
 	className: string,
+	/**
+	* String that will provide the description for the HTTP error code
+	*/
 	description: string.isRequired,
+	/**
+	* String that will describe the error that occurred
+	*/
 	errorCodeLabel: string.isRequired,
+	/**
+	* Links that will display for extra context when receiving particular errors
+	*/
+	/**@ts-ignore*/
 	links: arrayOf(shape({
+		/**
+		* The text to display for the link
+		*/
 		text: string.isRequired,
+		/**
+		* The link's destination
+		*/
 		href: string.isRequired
 	})),
+	/**
+	* This will be for the main title of the HTTP error component
+	*/
 	title: string.isRequired
 };
-
 //#endregion
-export { HTTPError403 };
+export { HTTPError403 };

package/es/components/HTTPErrors/HTTPError404/HTTPError404.js

@@ -13,7 +13,6 @@ import { HTTPErrorContent } from "../HTTPErrorContent.js";
 import { HTTPErrorSvg404 } from "../assets/HTTPErrorSvg404.js";
 import React from "react";
 import { arrayOf, shape, string } from "prop-types";
-
 //#region src/components/HTTPErrors/HTTPError404/HTTPError404.tsx
 /**
 * Copyright IBM Corp. 2021, 2021
@@ -52,15 +51,36 @@ HTTPError404.deprecated = {
 };
 HTTPError404.displayName = componentName;
 HTTPError404.propTypes = {
+	/**
+	* Provide an optional class to be applied to the containing node
+	*/
 	className: string,
+	/**
+	* String that will provide the description for the HTTP error code
+	*/
 	description: string.isRequired,
+	/**
+	* String that will describe the error that occurred
+	*/
 	errorCodeLabel: string.isRequired,
+	/**
+	* Links that will display for extra context when receiving particular errors
+	*/
+	/**@ts-ignore */
 	links: arrayOf(shape({
+		/**
+		* The text to display for the link
+		*/
 		text: string.isRequired,
+		/**
+		* The link's destination
+		*/
 		href: string.isRequired
 	})),
+	/**
+	* This will be for the main title of the HTTP error component
+	*/
 	title: string.isRequired
 };
-
 //#endregion
-export { HTTPError404 };
+export { HTTPError404 };