@carbon/ibm-products 2.89.0 → 2.90.0

package/lib/components/Nav/NavList.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('../../node_modules/@carbon/icons-react/lib/index.js');
-const require_NavItem = require('./NavItem.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("../../node_modules/@carbon/icons-react/lib/index.js");
+const require_NavItem = require("./NavItem.js");
 let react = require("react");
 react = require_runtime.__toESM(react);
 let prop_types = require("prop-types");
-
 //#region src/components/Nav/NavList.jsx
 /**
 * Copyright IBM Corp. 2024, 2024
@@ -93,28 +92,38 @@ let NavList = react.default.forwardRef(({ activeHref = defaults.activeHref, chil
 	}, newChildren));
 });
 NavList.propTypes = {
+	/** @type {string} Hypertext reference for active page. */
 	activeHref: prop_types.string,
+	/** @type {Node} Child elements. */
 	children: prop_types.node,
+	/** @type {string} Extra classes to add. */
 	className: prop_types.string,
+	/** @type {string} Icon of a list. */
 	icon: prop_types.string,
+	/** @type {string} ID of a list. */
 	id: prop_types.string,
+	/** @type {boolean} State of a list. */
 	isExpandedOnPageLoad: prop_types.bool,
+	/** @type {boolean} Title of nav. */
 	navigationItemTitle: prop_types.string,
+	/** @type {Function} Click handler for an item. */
 	onItemClick: prop_types.func,
+	/** @type {Function} Click handler for a list. */
 	onListClick: prop_types.func,
+	/** @type {number} `tabindex` of an item. */
 	tabIndex: prop_types.number,
+	/** @type {string} Label of the list. */
 	title: prop_types.string
 };
 NavList.displayName = componentName;
 NavList = require_settings.pkg.checkComponentEnabled(NavList, componentName);
 var NavList_default = NavList;
-
 //#endregion
-Object.defineProperty(exports, 'NavList', {
-  enumerable: true,
-  get: function () {
-    return NavList;
-  }
+Object.defineProperty(exports, "NavList", {
+	enumerable: true,
+	get: function() {
+		return NavList;
+	}
 });
 exports.blockClass = blockClass;
-exports.default = NavList_default;
+exports.default = NavList_default;

package/lib/components/NonLinearReading/NonLinearReading.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_devtools = require('../../global/js/utils/devtools.js');
-const require_uuidv4 = require('../../global/js/utils/uuidv4.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_uuidv4 = require("../../global/js/utils/uuidv4.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_icons = require("@carbon/react/icons");
-
 //#region src/components/NonLinearReading/NonLinearReading.tsx
 /**
 * Copyright IBM Corp. 2023, 2023
@@ -56,11 +55,22 @@ const NonLinearReading = react.default.forwardRef(({ children, className, defini
 });
 NonLinearReading.displayName = componentName;
 NonLinearReading.propTypes = {
+	/**
+	* The keyword of the component appears as a pill.
+	*/
 	children: prop_types.default.node.isRequired,
+	/**
+	* Provide an optional class to be applied to the containing node.
+	*/
 	className: prop_types.default.string,
+	/**
+	* The content that appears when the keyword is toggled open.
+	*/
 	definition: prop_types.default.node.isRequired,
+	/**
+	* Determines the theme of the component.
+	*/
 	theme: prop_types.default.oneOf(["light", "dark"])
 };
-
 //#endregion
-exports.NonLinearReading = NonLinearReading;
+exports.NonLinearReading = NonLinearReading;

package/lib/components/NotificationsPanel/NotificationsPanel.js

@@ -5,18 +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_useClickOutside = require('../../global/js/hooks/useClickOutside.js');
-const require_usePresence = require('../../global/js/hooks/usePresence.js');
-const require_usePrefersReducedMotion = require('../../global/js/hooks/usePrefersReducedMotion.js');
-const require_devtools = require('../../global/js/utils/devtools.js');
-const require_props_helper = require('../../global/js/utils/props-helper.js');
-const require_useId = require('../../global/js/utils/useId.js');
-const require_NotificationsEmptyState = require('../EmptyStates/NotificationsEmptyState/NotificationsEmptyState.js');
-const require_getSupportedLocale = require('../../global/js/utils/getSupportedLocale.js');
-const require_utils = require('./utils.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_useClickOutside = require("../../global/js/hooks/useClickOutside.js");
+const require_usePresence = require("../../global/js/hooks/usePresence.js");
+const require_usePrefersReducedMotion = require("../../global/js/hooks/usePrefersReducedMotion.js");
+const require_devtools = require("../../global/js/utils/devtools.js");
+const require_props_helper = require("../../global/js/utils/props-helper.js");
+const require_useId = require("../../global/js/utils/useId.js");
+const require_NotificationsEmptyState = require("../EmptyStates/NotificationsEmptyState/NotificationsEmptyState.js");
+const require_getSupportedLocale = require("../../global/js/utils/getSupportedLocale.js");
+const require_utils = require("./utils.js");
 let react = require("react");
 react = require_runtime.__toESM(react);
 let prop_types = require("prop-types");
@@ -24,7 +24,6 @@ prop_types = require_runtime.__toESM(prop_types);
 let _carbon_react = require("@carbon/react");
 let _carbon_react_icons = require("@carbon/react/icons");
 let _carbon_utilities = require("@carbon/utilities");
-
 //#region src/components/NotificationsPanel/NotificationsPanel.tsx
 /**
 * Copyright IBM Corp. 2020, 2022
@@ -320,7 +319,14 @@ const NotificationsPanel = react.default.forwardRef(({ className, data, dateTime
 });
 NotificationsPanel.displayName = componentName;
 NotificationsPanel.propTypes = {
+	/**
+	* Provide an optional class to be applied to the containing node.
+	*/
 	className: prop_types.default.string,
+	/**
+	* Array of data for Notifications component to render
+	*/
+	/**@ts-ignore*/
 	data: prop_types.default.arrayOf(prop_types.default.shape({
 		id: prop_types.default.oneOfType([prop_types.default.string, prop_types.default.number]),
 		type: prop_types.default.oneOf([
@@ -339,43 +345,152 @@ NotificationsPanel.propTypes = {
 		unread: prop_types.default.bool,
 		onNotificationClick: prop_types.default.func
 	})).isRequired,
+	/**
+	* The language for each notification's time stamp.
+	*/
 	dateTimeLocale: prop_types.default.string,
+	/**
+	* The date/time format for each notification's time stamp.
+	*
+	* E.g. `long` as "6 minutes ago", `short` as "6m ago".
+	*/
 	dateTimeStyle: prop_types.default.string,
+	/**
+	* Sets the `days ago` label text
+	*/
 	daysAgoText: prop_types.default.func,
+	/**
+	* Label for Dismiss all button
+	*/
 	dismissAllLabel: prop_types.default.string,
+	/**
+	* Label for Dismiss single notification icon button
+	*/
 	dismissSingleNotificationIconDescription: prop_types.default.string,
+	/**
+	* Optional: Determines if the `Do not disturb` toggle is on or off when the component is rendered
+	*/
 	doNotDisturbDefaultToggled: prop_types.default.bool,
+	/**
+	* Optional: Label for Do not disturb toggle
+	*/
 	doNotDisturbLabel: prop_types.default.string,
+	/**
+	* Sets the empty state label text when there are no notifications
+	*/
 	emptyStateLabel: prop_types.default.string,
+	/**
+	* Sets the `hour ago` label text
+	*/
 	hourAgoText: prop_types.default.func,
+	/**
+	* Sets the `hours ago` label text
+	*/
 	hoursAgoText: prop_types.default.func,
+	/**
+	* Determines the theme of the empty state's illustration.
+	*/
 	illustrationTheme: prop_types.default.oneOf(["light", "dark"]),
+	/**
+	* Sets the `minute ago` label text
+	*/
 	minuteAgoText: prop_types.default.func,
+	/**
+	* Sets the `minutes ago` label text
+	*/
 	minutesAgoText: prop_types.default.func,
+	/**
+	* Sets the `month ago` label text
+	*/
 	monthAgoText: prop_types.default.func,
+	/**
+	* Sets the `months ago` label text
+	*/
 	monthsAgoText: prop_types.default.func,
+	/**
+	* Sets the `now` label text
+	*/
 	nowText: prop_types.default.string,
+	/**
+	* Optional function called after clicking outside of the panel.
+	*/
 	onClickOutside: prop_types.default.func,
+	/**
+	* Optional function called after clicking the "Dismiss all" button.
+	*/
 	onDismissAllNotifications: prop_types.default.func,
+	/**
+	* Optional function called after clicking a notification's "X" button.
+	*/
 	onDismissSingleNotification: prop_types.default.func,
+	/**
+	* Optional function called after toggling "Do not disturb".
+	*/
 	onDoNotDisturbChange: prop_types.default.func,
+	/**
+	* Optional function called after clicking settings / gear icon button.
+	*/
 	onSettingsClick: prop_types.default.func,
+	/**
+	* Optional function called after clicking the "View all" button.
+	*/
 	onViewAllClick: prop_types.default.func,
+	/**
+	* Determines whether the notifications panel should render or not
+	*/
 	open: prop_types.default.bool.isRequired,
+	/**
+	* Sets the previous label text
+	*/
 	previousLabel: prop_types.default.string,
+	/**
+	* Sets the `read less` label text
+	*/
 	readLessLabel: prop_types.default.string,
+	/**
+	* Sets the `read more` label text
+	*/
 	readMoreLabel: prop_types.default.string,
+	/**
+	* Sets the `seconds ago` label text
+	*/
 	secondsAgoText: prop_types.default.func,
+	/**
+	* Sets the settings icon description text
+	*/
 	settingsIconDescription: prop_types.default.string,
+	/**
+	* Sets the title for the Notifications panel
+	*/
 	title: prop_types.default.string,
+	/**
+	* Sets the today label text
+	*/
 	todayLabel: prop_types.default.string,
+	/**
+	* Sets the today label text
+	*/
 	triggerButtonRef: prop_types.default.any,
+	/**
+	* Sets the View all button text
+	*/
 	viewAllLabel: prop_types.default.func,
+	/**
+	* Sets the `year ago` label text
+	*/
 	yearAgoText: prop_types.default.func,
+	/**
+	* Sets the `years ago` label text
+	*/
 	yearsAgoText: prop_types.default.func,
+	/**
+	* Sets the `Yesterday at` label text
+	*/
 	yesterdayAtText: prop_types.default.func,
+	/**
+	* Sets the yesterday label text
+	*/
 	yesterdayLabel: prop_types.default.string
 };
-
 //#endregion
-exports.NotificationsPanel = NotificationsPanel;
+exports.NotificationsPanel = NotificationsPanel;

package/lib/components/NotificationsPanel/utils.js

@@ -5,7 +5,6 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-
 //#region src/components/NotificationsPanel/utils.js
 /**
 * Copyright IBM Corp. 2020, 2021
@@ -34,6 +33,5 @@ const getBrowserLocales = () => {
 		return locale.trim();
 	});
 };
-
 //#endregion
-exports.timeAgo = timeAgo;
+exports.timeAgo = timeAgo;

package/lib/components/OptionsTile/OptionsTile.js

@@ -5,13 +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_useControllableState = require('../../global/js/hooks/useControllableState.js');
-const require_usePrefersReducedMotion = require('../../global/js/hooks/usePrefersReducedMotion.js');
-const require_devtools = require('../../global/js/utils/devtools.js');
-const require_uuidv4 = require('../../global/js/utils/uuidv4.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_useControllableState = require("../../global/js/hooks/useControllableState.js");
+const require_usePrefersReducedMotion = require("../../global/js/hooks/usePrefersReducedMotion.js");
+const require_devtools = require("../../global/js/utils/devtools.js");
+const require_uuidv4 = require("../../global/js/utils/uuidv4.js");
 let react = require("react");
 react = require_runtime.__toESM(react);
 let prop_types = require("prop-types");
@@ -21,7 +21,6 @@ let _carbon_react_icons = require("@carbon/react/icons");
 let _carbon_motion = require("@carbon/motion");
 _carbon_motion = require_runtime.__toESM(_carbon_motion);
 let _carbon_utilities_react = require("@carbon/utilities-react");
-
 //#region src/components/OptionsTile/OptionsTile.tsx
 /**
 * Copyright IBM Corp. 2021, 2024
@@ -180,23 +179,73 @@ const OptionsTile = react.default.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: prop_types.default.node,
+	/**
+	* Provide an optional class to be applied to the containing node.
+	*/
 	className: prop_types.default.string,
+	/**
+	* Whether the toggle is enabled or disabled. If nothing is passed,
+	* no toggle will be rendered.
+	*/
 	enabled: prop_types.default.bool,
+	/**
+	* Whether the OptionsTile is in invalid validation state.
+	*/
 	invalid: prop_types.default.bool,
+	/**
+	* Provide a text explaining why the OptionsTile is in invalid state.
+	*/
 	invalidText: prop_types.default.string,
+	/**
+	* Whether the OptionsTile is in locked validation state.
+	*/
 	locked: prop_types.default.bool,
+	/**
+	* Provide a text explaining why the OptionsTile is in locked state.
+	*/
 	lockedText: prop_types.default.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: prop_types.default.func,
+	/**
+	* Provide a function which will be called each time the user
+	* interacts with the toggle.
+	*/
 	onToggle: prop_types.default.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: prop_types.default.bool,
+	/**
+	* Define the size of the OptionsTile.
+	*/
 	size: prop_types.default.oneOf(["lg", "xl"]),
+	/**
+	* Optionally provide a text summarizing the current state of the content.
+	*/
 	summary: prop_types.default.string,
+	/**
+	* Provide the title for this OptionsTile. Must not contain any interactive elements.
+	*/
 	title: prop_types.default.oneOfType([prop_types.default.string, prop_types.default.node]).isRequired,
+	/**
+	* Optionally provide an id which should be used for the title.
+	*/
 	titleId: prop_types.default.string,
+	/**
+	* Whether the OptionsTile is in warning validation state.
+	*/
 	warn: prop_types.default.bool,
+	/**
+	* Provide a text explaining why the OptionsTile is in warning state.
+	*/
 	warnText: prop_types.default.string
 };
-
 //#endregion
-exports.OptionsTile = OptionsTile;
+exports.OptionsTile = OptionsTile;