@carbon/ibm-products 2.89.0 → 2.90.0

package/es/components/MultiAddSelect/MultiAddSelect.js

@@ -9,7 +9,6 @@ import { getDevtoolsProps } from "../../global/js/utils/devtools.js";
 import { AddSelect } from "../AddSelect/AddSelect.js";
 import React, { forwardRef } from "react";
 import PropTypes from "prop-types";
-
 //#region src/components/MultiAddSelect/MultiAddSelect.tsx
 const componentName = "MultiAddSelect";
 /**
@@ -22,21 +21,62 @@ const MultiAddSelect = forwardRef((props, ref) => /* @__PURE__ */ React.createEl
 	...getDevtoolsProps(componentName)
 }));
 MultiAddSelect.propTypes = {
+	/**
+	* optional class name
+	*/
 	className: PropTypes.string,
+	/**
+	* placeholder for column input filter
+	*/
 	columnInputPlaceholder: PropTypes.string,
+	/**
+	* text description that appears under the title
+	*/
 	description: PropTypes.string,
+	/**
+	* options to display in the global filter box. values are generated
+	* from the id which should correlate with a specific property in an
+	* item entry
+	*/
+	/**@ts-ignore */
 	globalFilters: PropTypes.arrayOf(PropTypes.shape({
 		id: PropTypes.string,
 		label: PropTypes.string
 	})),
 	globalFiltersIconDescription: PropTypes.string,
+	/**
+	* placeholder text for the global filter dropdown
+	*/
 	globalFiltersPlaceholderText: PropTypes.string,
+	/**
+	* text for the global filter primary button
+	*/
 	globalFiltersPrimaryButtonText: PropTypes.string,
+	/**
+	* text for the global filter secondary button
+	*/
 	globalFiltersSecondaryButtonText: PropTypes.string,
+	/**
+	* label for global search input
+	*/
 	globalSearchLabel: PropTypes.string,
+	/**
+	* placeholder for global search input
+	*/
 	globalSearchPlaceholder: PropTypes.string,
+	/**
+	* the theme for the empty state illustration
+	*/
 	illustrationTheme: PropTypes.oneOf(["light", "dark"]),
+	/**
+	* title that displays in the sidebar / influencer
+	*/
 	influencerTitle: PropTypes.string,
+	/**
+	* object that contains the item data. for more information reference the
+	* "Structuring items" section in the docs tab
+	*/
+	/**@ts-ignore */
 	items: PropTypes.shape({
 		modifiers: PropTypes.shape({
 			label: PropTypes.string,
@@ -60,21 +100,59 @@ MultiAddSelect.propTypes = {
 			value: PropTypes.string.isRequired
 		}))
 	}),
+	/**
+	* label that display above the list of items
+	*/
 	itemsLabel: PropTypes.string,
+	/**
+	* text to display when no results are found from the global search
+	*/
 	noResultsDescription: PropTypes.string,
+	/**
+	* title to display when no results are found from the global search
+	*/
 	noResultsTitle: PropTypes.string,
+	/**
+	* text body that displays in the sidebar when nothing is selected
+	*/
 	noSelectionDescription: PropTypes.string,
+	/**
+	* title that displays in the sidebar when nothing is selected
+	*/
 	noSelectionTitle: PropTypes.string,
+	/**
+	* Determines if the component should be rendered within a Tearsheet component
+	*/
 	noTearsheet: PropTypes.bool,
+	/**
+	* function to call when the close button clicked
+	*/
 	onClose: PropTypes.func,
+	/**
+	* text for close button
+	*/
 	onCloseButtonText: PropTypes.string,
+	/**
+	* function to call when the submit button is clicked. returns a selection
+	*/
 	onSubmit: PropTypes.func,
+	/**
+	* text for the submit button
+	*/
 	onSubmitButtonText: PropTypes.string,
+	/**
+	* specifies if the component is open or not
+	*/
 	open: PropTypes.bool,
+	/**
+	* text that displays when displaying filtered items
+	*/
 	searchResultsTitle: PropTypes.string,
+	/**
+	* header text
+	*/
 	title: PropTypes.string
 };
 MultiAddSelect.displayName = componentName;
-
 //#endregion
-export { MultiAddSelect };
+export { MultiAddSelect };

package/es/components/Nav/Nav.js

@@ -13,7 +13,6 @@ import NavItem_default, { blockClass as blockClass$1 } from "./NavItem.js";
 import NavList_default, { blockClass as blockClass$2 } from "./NavList.js";
 import React, { useEffect, useRef, useState } from "react";
 import PropTypes from "prop-types";
-
 //#region src/components/Nav/Nav.jsx
 /**
 * Copyright IBM Corp. 2024, 2024
@@ -107,14 +106,28 @@ Nav.deprecated = {
 	details: `This component is deprecated`
 };
 Nav.propTypes = {
+	/**
+	* Hypertext reference for active page.
+	*/
 	activeHref: PropTypes.string,
+	/**
+	* Child elements.
+	*/
 	children: PropTypes.node,
+	/**
+	* Extra classes to add.
+	*/
 	className: PropTypes.string,
+	/**
+	* Heading.
+	*/
 	heading: PropTypes.string,
+	/**
+	* Aria-label on the rendered `nav` element.
+	*/
 	label: PropTypes.string.isRequired
 };
 Nav = pkg.checkComponentEnabled(Nav, componentName);
 Nav.displayName = componentName;
-
 //#endregion
-export { Nav };
+export { Nav };

package/es/components/Nav/NavItem.js

@@ -13,7 +13,6 @@ import { Launch } from "../../node_modules/@carbon/icons-react/es/generated/buck
 import NavItemLink from "./NavItemLink.js";
 import React, { useEffect, useRef, useState } from "react";
 import PropTypes from "prop-types";
-
 //#region src/components/Nav/NavItem.jsx
 /**
 * Copyright IBM Corp. 2024, 2024
@@ -73,21 +72,56 @@ let NavItem = ({ activeHref = defaults.activeHref, children = defaults.children,
 };
 NavItem.displayName = componentName;
 NavItem.propTypes = {
+	/**
+	* Hypertext reference for active page.
+	*/
 	activeHref: PropTypes.string,
+	/**
+	* Provide the contents of the Nav.
+	*/
 	children: PropTypes.node.isRequired,
+	/**
+	* Provide an optional class to be applied to the containing node.
+	*/
 	className: PropTypes.string,
+	/**
+	* Currently selected item.
+	*/
 	current: PropTypes.string,
+	/**
+	* Whether the item is disabled.
+	*/
 	disabled: PropTypes.bool,
+	/**
+	* The base element to use to build the link. Defaults to `a`, can also accept alternative tag names or custom components like `Link` from `react-router`.
+	*/
 	element: PropTypes.elementType,
+	/**
+	* The href of the nav item.
+	*/
 	href: PropTypes.string,
+	/**
+	* Identifier.
+	*/
 	id: PropTypes.string,
+	/**
+	* Label of an item.
+	*/
 	label: PropTypes.string,
+	/**
+	* Whether the item is a link.
+	*/
 	link: PropTypes.bool,
+	/**
+	* Click handler of an item.
+	*/
 	onClick: PropTypes.func,
+	/**
+	* `tabindex` of an item.
+	*/
 	tabIndex: PropTypes.number
 };
 NavItem = pkg.checkComponentEnabled(NavItem, componentName);
 var NavItem_default = NavItem;
-
 //#endregion
-export { NavItem, blockClass, NavItem_default as default };
+export { NavItem, blockClass, NavItem_default as default };

package/es/components/Nav/NavItemLink.js

@@ -7,7 +7,6 @@
 
 import React from "react";
 import PropTypes from "prop-types";
-
 //#region src/components/Nav/NavItemLink.jsx
 /**
 * Copyright IBM Corp. 2024
@@ -23,7 +22,8 @@ const NavItemLink = React.forwardRef(function NavItemLink(props, ref) {
 	});
 });
 NavItemLink.displayName = "NavItemLink";
-NavItemLink.propTypes = { element: PropTypes.elementType };
-
+NavItemLink.propTypes = { 
+/** @type {elementType} The base element to use to build the link. Defaults to `a`, can also accept alternative tag names or custom components like `Link` from `react-router`. */
+element: PropTypes.elementType };
 //#endregion
-export { NavItemLink as default };
+export { NavItemLink as default };

package/es/components/Nav/NavList.js

@@ -12,7 +12,6 @@ import { ChevronDown } from "../../node_modules/@carbon/icons-react/es/generated
 import NavItem_default, { blockClass as blockClass$1 } from "./NavItem.js";
 import React, { useEffect, useImperativeHandle, useState } from "react";
 import { bool, func, node, number, string } from "prop-types";
-
 //#region src/components/Nav/NavList.jsx
 /**
 * Copyright IBM Corp. 2024, 2024
@@ -91,21 +90,31 @@ let NavList = React.forwardRef(({ activeHref = defaults.activeHref, children = d
 	}, newChildren));
 });
 NavList.propTypes = {
+	/** @type {string} Hypertext reference for active page. */
 	activeHref: string,
+	/** @type {Node} Child elements. */
 	children: node,
+	/** @type {string} Extra classes to add. */
 	className: string,
+	/** @type {string} Icon of a list. */
 	icon: string,
+	/** @type {string} ID of a list. */
 	id: string,
+	/** @type {boolean} State of a list. */
 	isExpandedOnPageLoad: bool,
+	/** @type {boolean} Title of nav. */
 	navigationItemTitle: string,
+	/** @type {Function} Click handler for an item. */
 	onItemClick: func,
+	/** @type {Function} Click handler for a list. */
 	onListClick: func,
+	/** @type {number} `tabindex` of an item. */
 	tabIndex: number,
+	/** @type {string} Label of the list. */
 	title: string
 };
 NavList.displayName = componentName;
 NavList = pkg.checkComponentEnabled(NavList, componentName);
 var NavList_default = NavList;
-
 //#endregion
-export { NavList, blockClass, NavList_default as default };
+export { NavList, blockClass, NavList_default as default };

package/es/components/NonLinearReading/NonLinearReading.js

@@ -13,7 +13,6 @@ import uuidv4 from "../../global/js/utils/uuidv4.js";
 import React, { useRef, useState } from "react";
 import PropTypes from "prop-types";
 import { ChevronDown } from "@carbon/react/icons";
-
 //#region src/components/NonLinearReading/NonLinearReading.tsx
 /**
 * Copyright IBM Corp. 2023, 2023
@@ -54,11 +53,22 @@ const NonLinearReading = React.forwardRef(({ children, className, definition, th
 });
 NonLinearReading.displayName = componentName;
 NonLinearReading.propTypes = {
+	/**
+	* The keyword of the component appears as a pill.
+	*/
 	children: PropTypes.node.isRequired,
+	/**
+	* Provide an optional class to be applied to the containing node.
+	*/
 	className: PropTypes.string,
+	/**
+	* The content that appears when the keyword is toggled open.
+	*/
 	definition: PropTypes.node.isRequired,
+	/**
+	* Determines the theme of the component.
+	*/
 	theme: PropTypes.oneOf(["light", "dark"])
 };
-
 //#endregion
-export { NonLinearReading };
+export { NonLinearReading };

package/es/components/NotificationsPanel/NotificationsPanel.js

@@ -22,7 +22,6 @@ import PropTypes from "prop-types";
 import { Button, Heading, IconButton, Link, Section, Toggle, usePrefix } from "@carbon/react";
 import { CheckmarkFilled, ChevronDown, Close, ErrorFilled, InformationSquareFilled, Settings, WarningAltFilled } from "@carbon/react/icons";
 import { dateTimeFormat } from "@carbon/utilities";
-
 //#region src/components/NotificationsPanel/NotificationsPanel.tsx
 /**
 * Copyright IBM Corp. 2020, 2022
@@ -318,7 +317,14 @@ const NotificationsPanel = React.forwardRef(({ className, data, dateTimeLocale,
 });
 NotificationsPanel.displayName = componentName;
 NotificationsPanel.propTypes = {
+	/**
+	* Provide an optional class to be applied to the containing node.
+	*/
 	className: PropTypes.string,
+	/**
+	* Array of data for Notifications component to render
+	*/
+	/**@ts-ignore*/
 	data: PropTypes.arrayOf(PropTypes.shape({
 		id: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
 		type: PropTypes.oneOf([
@@ -337,43 +343,152 @@ NotificationsPanel.propTypes = {
 		unread: PropTypes.bool,
 		onNotificationClick: PropTypes.func
 	})).isRequired,
+	/**
+	* The language for each notification's time stamp.
+	*/
 	dateTimeLocale: PropTypes.string,
+	/**
+	* The date/time format for each notification's time stamp.
+	*
+	* E.g. `long` as "6 minutes ago", `short` as "6m ago".
+	*/
 	dateTimeStyle: PropTypes.string,
+	/**
+	* Sets the `days ago` label text
+	*/
 	daysAgoText: PropTypes.func,
+	/**
+	* Label for Dismiss all button
+	*/
 	dismissAllLabel: PropTypes.string,
+	/**
+	* Label for Dismiss single notification icon button
+	*/
 	dismissSingleNotificationIconDescription: PropTypes.string,
+	/**
+	* Optional: Determines if the `Do not disturb` toggle is on or off when the component is rendered
+	*/
 	doNotDisturbDefaultToggled: PropTypes.bool,
+	/**
+	* Optional: Label for Do not disturb toggle
+	*/
 	doNotDisturbLabel: PropTypes.string,
+	/**
+	* Sets the empty state label text when there are no notifications
+	*/
 	emptyStateLabel: PropTypes.string,
+	/**
+	* Sets the `hour ago` label text
+	*/
 	hourAgoText: PropTypes.func,
+	/**
+	* Sets the `hours ago` label text
+	*/
 	hoursAgoText: PropTypes.func,
+	/**
+	* Determines the theme of the empty state's illustration.
+	*/
 	illustrationTheme: PropTypes.oneOf(["light", "dark"]),
+	/**
+	* Sets the `minute ago` label text
+	*/
 	minuteAgoText: PropTypes.func,
+	/**
+	* Sets the `minutes ago` label text
+	*/
 	minutesAgoText: PropTypes.func,
+	/**
+	* Sets the `month ago` label text
+	*/
 	monthAgoText: PropTypes.func,
+	/**
+	* Sets the `months ago` label text
+	*/
 	monthsAgoText: PropTypes.func,
+	/**
+	* Sets the `now` label text
+	*/
 	nowText: PropTypes.string,
+	/**
+	* Optional function called after clicking outside of the panel.
+	*/
 	onClickOutside: PropTypes.func,
+	/**
+	* Optional function called after clicking the "Dismiss all" button.
+	*/
 	onDismissAllNotifications: PropTypes.func,
+	/**
+	* Optional function called after clicking a notification's "X" button.
+	*/
 	onDismissSingleNotification: PropTypes.func,
+	/**
+	* Optional function called after toggling "Do not disturb".
+	*/
 	onDoNotDisturbChange: PropTypes.func,
+	/**
+	* Optional function called after clicking settings / gear icon button.
+	*/
 	onSettingsClick: PropTypes.func,
+	/**
+	* Optional function called after clicking the "View all" button.
+	*/
 	onViewAllClick: PropTypes.func,
+	/**
+	* Determines whether the notifications panel should render or not
+	*/
 	open: PropTypes.bool.isRequired,
+	/**
+	* Sets the previous label text
+	*/
 	previousLabel: PropTypes.string,
+	/**
+	* Sets the `read less` label text
+	*/
 	readLessLabel: PropTypes.string,
+	/**
+	* Sets the `read more` label text
+	*/
 	readMoreLabel: PropTypes.string,
+	/**
+	* Sets the `seconds ago` label text
+	*/
 	secondsAgoText: PropTypes.func,
+	/**
+	* Sets the settings icon description text
+	*/
 	settingsIconDescription: PropTypes.string,
+	/**
+	* Sets the title for the Notifications panel
+	*/
 	title: PropTypes.string,
+	/**
+	* Sets the today label text
+	*/
 	todayLabel: PropTypes.string,
+	/**
+	* Sets the today label text
+	*/
 	triggerButtonRef: PropTypes.any,
+	/**
+	* Sets the View all button text
+	*/
 	viewAllLabel: PropTypes.func,
+	/**
+	* Sets the `year ago` label text
+	*/
 	yearAgoText: PropTypes.func,
+	/**
+	* Sets the `years ago` label text
+	*/
 	yearsAgoText: PropTypes.func,
+	/**
+	* Sets the `Yesterday at` label text
+	*/
 	yesterdayAtText: PropTypes.func,
+	/**
+	* Sets the yesterday label text
+	*/
 	yesterdayLabel: PropTypes.string
 };
-
 //#endregion
-export { NotificationsPanel };
+export { NotificationsPanel };

package/es/components/NotificationsPanel/utils.js

@@ -33,6 +33,5 @@ const getBrowserLocales = () => {
 		return locale.trim();
 	});
 };
-
 //#endregion
-export { timeAgo };
+export { timeAgo };

package/es/components/OptionsTile/OptionsTile.js

@@ -18,7 +18,6 @@ import { Heading, Layer, Section, Toggle } from "@carbon/react";
 import { ChevronDown, Locked, WarningAltFilled, WarningFilled } from "@carbon/react/icons";
 import * as carbonMotion from "@carbon/motion";
 import { useNoInteractiveChildren } from "@carbon/utilities-react";
-
 //#region src/components/OptionsTile/OptionsTile.tsx
 /**
 * Copyright IBM Corp. 2021, 2024
@@ -177,23 +176,73 @@ const OptionsTile = React.forwardRef((props, ref) => {
 });
 OptionsTile.displayName = componentName;
 OptionsTile.propTypes = {
+	/**
+	* Provide content to render as expandable OptionsTile. If no children
+	* are present, the OptionsTile will render as its variant.
+	*/
 	children: PropTypes.node,
+	/**
+	* Provide an optional class to be applied to the containing node.
+	*/
 	className: PropTypes.string,
+	/**
+	* Whether the toggle is enabled or disabled. If nothing is passed,
+	* no toggle will be rendered.
+	*/
 	enabled: PropTypes.bool,
+	/**
+	* Whether the OptionsTile is in invalid validation state.
+	*/
 	invalid: PropTypes.bool,
+	/**
+	* Provide a text explaining why the OptionsTile is in invalid state.
+	*/
 	invalidText: PropTypes.string,
+	/**
+	* Whether the OptionsTile is in locked validation state.
+	*/
 	locked: PropTypes.bool,
+	/**
+	* Provide a text explaining why the OptionsTile is in locked state.
+	*/
 	lockedText: 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,
+	/**
+	* Provide a function which will be called each time the user
+	* interacts with the toggle.
+	*/
 	onToggle: PropTypes.func,
+	/**
+	* For controlled usage of the tile open state. This prop only works when an onChange prop is also passed, otherwise an uncontrolled state is used.
+	*/
 	open: PropTypes.bool,
+	/**
+	* Define the size of the OptionsTile.
+	*/
 	size: PropTypes.oneOf(["lg", "xl"]),
+	/**
+	* Optionally provide a text summarizing the current state of the content.
+	*/
 	summary: PropTypes.string,
+	/**
+	* Provide the title for this OptionsTile. Must not contain any interactive elements.
+	*/
 	title: PropTypes.oneOfType([PropTypes.string, PropTypes.node]).isRequired,
+	/**
+	* Optionally provide an id which should be used for the title.
+	*/
 	titleId: PropTypes.string,
+	/**
+	* Whether the OptionsTile is in warning validation state.
+	*/
 	warn: PropTypes.bool,
+	/**
+	* Provide a text explaining why the OptionsTile is in warning state.
+	*/
 	warnText: PropTypes.string
 };
-
 //#endregion
-export { OptionsTile };
+export { OptionsTile };