@carbon/ibm-products 2.43.2-canary.11 → 2.43.2-canary.111

package/lib/components/FullPageError/FullPageError.d.ts

@@ -1,6 +1,40 @@
+/**
+ * Copyright IBM Corp. 2024, 2024
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import React, { ReactNode } from 'react';
+interface FullPageErrorProps {
+    /**
+     * Provide the contents of the FullPageError.
+     */
+    children?: ReactNode;
+    /**
+     * Provide an optional class to be applied to the containing node.
+     */
+    className?: 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: string;
+    /**
+     * The kind of error page to be displayed, default is custom
+     */
+    kind?: 'custom' | '403' | '404';
+    /**
+     * String that will describe the error that occurred
+     */
+    label: string;
+    /**
+     * This will be for the main title of the FullPageError component
+     */
+    title: string;
+}
 /**
  * Display a full-page error when the requested page is unavailable to the user.
  * This is typically caused by issues with the requested URL or access permissions.
  */
-export let FullPageError: React.ForwardRefExoticComponent<React.RefAttributes<any>>;
-import React from 'react';
+export declare let FullPageError: React.ForwardRefExoticComponent<FullPageErrorProps & React.RefAttributes<HTMLDivElement>>;
+export {};

package/lib/components/FullPageError/FullPageError.js

@@ -30,9 +30,6 @@ var _excluded = ["children", "className", "description", "label", "kind", "title
 // The block part of our conventional BEM class names (blockClass__E--M).
 var blockClass = "".concat(settings.pkg.prefix, "--full-page-error");
 var componentName = 'FullPageError';
-
-// NOTE: the component SCSS is not imported here: it is rolled up separately.
-
 // Default values for props
 var defaults = {
   kind: 'custom'

package/lib/components/GetStartedCard/GetStartedCard.d.ts

@@ -1,5 +1,63 @@
+/**
+ * Copyright IBM Corp. 2024, 2024
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import React, { PropsWithChildren, ReactNode } from 'react';
+type MetaData = {
+    id?: string;
+    icon?: () => ReactNode;
+    iconDescription?: string;
+};
+interface GetStartedCardProps extends PropsWithChildren {
+    /**
+     * Provide an optional class to be applied to the containing node.
+     */
+    className?: string;
+    /**
+     * Optional if the card should be disabled
+     */
+    disabled?: boolean;
+    /**
+     * Provides the action icon that's displayed at the footer of the card
+     */
+    footerActionIcon: React.ElementType;
+    /**
+     * Optional label for the top of the card
+     */
+    label?: ReactNode;
+    /**
+     * Optional media content like an image to be placed in the card
+     */
+    media?: ReactNode;
+    /**
+     * Icons that are displayed on the card showing the time and skill needed
+     */
+    metadata: readonly MetaData[];
+    /**
+     * Provides the callback for a clickable card
+     */
+    onClick?: () => void;
+    /**
+     * Provides the icon that's displayed at the top of the card
+     */
+    pictogram?: () => ReactNode;
+    /**
+     * Provides number for card for tasks in a sequential order
+     */
+    sequence?: number;
+    /**
+     * Provides the status that's displayed at the top of the card
+     */
+    status?: 'complete' | 'incomplete';
+    /**
+     * Title that's displayed at the top of the card
+     */
+    title?: ReactNode;
+}
 /**
  * GetStartedCard a card with icon, number, and media variants
  */
-export let GetStartedCard: React.ForwardRefExoticComponent<React.RefAttributes<any>>;
-import React from 'react';
+export declare let GetStartedCard: React.ForwardRefExoticComponent<GetStartedCardProps & React.RefAttributes<HTMLDivElement>>;
+export {};

package/lib/components/GetStartedCard/GetStartedCard.js

@@ -21,16 +21,14 @@ function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'defau
 var React__default = /*#__PURE__*/_interopDefaultLegacy(React);
 
 var componentName = 'GetStartedCard';
-
 /**
  * GetStartedCard a card with icon, number, and media variants
  */
-exports.GetStartedCard = /*#__PURE__*/React__default["default"].forwardRef(function (_ref, ref) {
-  var rest = _rollupPluginBabelHelpers["extends"]({}, (_rollupPluginBabelHelpers.objectDestructuringEmpty(_ref), _ref));
-  return /*#__PURE__*/React__default["default"].createElement(Card.Card, _rollupPluginBabelHelpers["extends"]({
-    getStarted: true,
-    ref: ref
-  }, rest, devtools.getDevtoolsProps(componentName)));
+exports.GetStartedCard = /*#__PURE__*/React__default["default"].forwardRef(function (props, ref) {
+  return /*#__PURE__*/React__default["default"].createElement(Card.Card, _rollupPluginBabelHelpers["extends"]({}, _rollupPluginBabelHelpers.objectSpread2(_rollupPluginBabelHelpers.objectSpread2({}, props), {}, {
+    ref: ref,
+    getStarted: true
+  }), devtools.getDevtoolsProps(componentName)));
 });
 
 // Return a placeholder if not released and not enabled by feature flag
@@ -48,11 +46,12 @@ exports.GetStartedCard.propTypes = {
   /**
    * Provides the action icon that's displayed at the footer of the card
    */
+  /**@ts-ignore */
   footerActionIcon: index["default"].oneOfType([index["default"].func, index["default"].object]),
   /**
    * Optional label for the top of the card
    */
-  label: index["default"].oneOfType([index["default"].string, index["default"].object, index["default"].node]),
+  label: index["default"].oneOfType([index["default"].string, index["default"].node]),
   /**
    * Optional media content like an image to be placed in the card
    */
@@ -60,6 +59,7 @@ exports.GetStartedCard.propTypes = {
   /**
    * Icons that are displayed on the card showing the time and skill needed
    */
+  /**@ts-ignore */
   metadata: index["default"].arrayOf(index["default"].shape({
     id: index["default"].string,
     icon: index["default"].oneOfType([index["default"].func, index["default"].object]),
@@ -72,6 +72,7 @@ exports.GetStartedCard.propTypes = {
   /**
    * Provides the icon that's displayed at the top of the card
    */
+  /**@ts-ignore */
   pictogram: index["default"].oneOfType([index["default"].func, index["default"].object]),
   /**
    * Provides number for card for tasks in a sequential order
@@ -84,5 +85,5 @@ exports.GetStartedCard.propTypes = {
   /**
    * Title that's displayed at the top of the card
    */
-  title: index["default"].oneOfType([index["default"].string, index["default"].object, index["default"].node])
+  title: index["default"].oneOfType([index["default"].string, index["default"].node])
 };

package/lib/components/HTTPErrors/HTTPError403/HTTPError403.js

@@ -53,6 +53,12 @@ exports.HTTPError403 = /*#__PURE__*/React__default["default"].forwardRef(functio
   }));
 });
 
+/**@ts-ignore*/
+exports.HTTPError403.deprecated = {
+  level: 'warn',
+  details: "Please replace ".concat(componentName, " with FullPageError")
+};
+
 // Return a placeholder if not released and not enabled by feature flag
 exports.HTTPError403 = settings.pkg.checkComponentEnabled(exports.HTTPError403, componentName);
 

package/lib/components/HTTPErrors/HTTPError404/HTTPError404.js

@@ -53,6 +53,12 @@ exports.HTTPError404 = /*#__PURE__*/React__default["default"].forwardRef(functio
   }));
 });
 
+/**@ts-ignore*/
+exports.HTTPError404.deprecated = {
+  level: 'warn',
+  details: "Please replace ".concat(componentName, " with FullPageError")
+};
+
 // Return a placeholder if not released and not enabled by feature flag
 exports.HTTPError404 = settings.pkg.checkComponentEnabled(exports.HTTPError404, componentName);
 

package/lib/components/HTTPErrors/HTTPErrorOther/HTTPErrorOther.js

@@ -53,6 +53,12 @@ exports.HTTPErrorOther = /*#__PURE__*/React__default["default"].forwardRef(funct
   }));
 });
 
+/**@ts-ignore*/
+exports.HTTPErrorOther.deprecated = {
+  level: 'warn',
+  details: "Please replace ".concat(componentName, " with FullPageError")
+};
+
 // Return a placeholder if not released and not enabled by feature flag
 exports.HTTPErrorOther = settings.pkg.checkComponentEnabled(exports.HTTPErrorOther, componentName);