@carbon/ibm-products 2.34.0 → 2.36.0-alpha.27

package/lib/components/EmptyStates/ErrorEmptyState/ErrorEmptyState.d.ts

@@ -1,5 +1,64 @@
+/**
+ * Copyright IBM Corp. 2020, 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.
+ */
+/// <reference path="../../../../src/custom-typings/index.d.ts" />
+import React, { ReactNode } from 'react';
+import { ButtonProps } from '@carbon/react';
+import { CarbonIconType } from '@carbon/icons-react/lib/CarbonIcon';
+interface ErrorEmptyStateProps {
+    /**
+     * Empty state action button
+     */
+    action?: {
+        kind?: 'primary' | 'secondary' | 'tertiary';
+        renderIcon?: CarbonIconType;
+        onClick?: ButtonProps['onClick'];
+        text?: string;
+    };
+    /**
+     * Provide an optional class to be applied to the containing node.
+     */
+    className?: string;
+    /**
+     * The alt text for empty state svg images. If not provided , title will be used.
+     */
+    illustrationDescription?: string;
+    /**
+     * Designates the position of the illustration relative to the content
+     */
+    illustrationPosition?: 'top' | 'right' | 'bottom' | 'left';
+    /**
+     * Empty state illustration theme variations.
+     * To ensure you use the correct themed illustrations, you can conditionally specify light or dark
+     * based on your app's current theme value. Example:
+     * `illustrationTheme={appTheme === ('carbon--g100' || 'carbon--g90') ? 'dark' : 'light'}`
+     */
+    illustrationTheme?: 'light' | 'dark';
+    /**
+     * Empty state link object
+     */
+    link?: {
+        text?: string | ReactNode;
+        href?: string;
+    };
+    /**
+     * Empty state size
+     */
+    size?: 'lg' | 'sm';
+    /**
+     * Empty state subtitle
+     */
+    subtitle?: string | ReactNode;
+    /**
+     * Empty state title
+     */
+    title: string | ReactNode;
+}
 /**
  * The `EmptyState` component follows the Carbon guidelines for empty states with some added specifications around illustration usage. For additional usage guidelines and documentation please refer to the links above.
  */
-export let ErrorEmptyState: React.ForwardRefExoticComponent<React.RefAttributes<any>>;
-import React from 'react';
+export declare let ErrorEmptyState: React.ForwardRefExoticComponent<ErrorEmptyStateProps & React.RefAttributes<HTMLDivElement>>;
+export {};

package/lib/components/EmptyStates/ErrorEmptyState/ErrorEmptyState.js

@@ -26,11 +26,9 @@ var React__default = /*#__PURE__*/_interopDefaultLegacy(React);
 var cx__default = /*#__PURE__*/_interopDefaultLegacy(cx);
 
 var _excluded = ["action", "className", "illustrationPosition", "illustrationDescription", "illustrationTheme", "link", "size", "subtitle", "title"];
-
 // The block part of our conventional BEM class names (blockClass__E--M).
 var blockClass = "".concat(settings.pkg.prefix, "--empty-state");
 var componentName = 'ErrorEmptyState';
-
 /**
  * The `EmptyState` component follows the Carbon guidelines for empty states with some added specifications around illustration usage. For additional usage guidelines and documentation please refer to the links above.
  */
@@ -59,7 +57,7 @@ exports.ErrorEmptyState = /*#__PURE__*/React__default["default"].forwardRef(func
     link: link,
     size: size,
     subtitle: subtitle,
-    title: title
+    title: title || ''
   }));
 });
 

package/lib/components/EmptyStates/NoDataEmptyState/NoDataEmptyState.d.ts

@@ -1,5 +1,64 @@
+/**
+ * Copyright IBM Corp. 2020, 2021
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+/// <reference path="../../../../src/custom-typings/index.d.ts" />
+import React, { ReactNode } from 'react';
+import { ButtonProps } from '@carbon/react';
+import { CarbonIconType } from '@carbon/icons-react/lib/CarbonIcon';
+interface NoDataEmptyStateProps {
+    /**
+     * Empty state action button
+     */
+    action?: {
+        kind?: 'primary' | 'secondary' | 'tertiary';
+        renderIcon?: CarbonIconType;
+        onClick?: ButtonProps['onClick'];
+        text?: string;
+    };
+    /**
+     * Provide an optional class to be applied to the containing node.
+     */
+    className?: string;
+    /**
+     * The alt text for empty state svg images. If not provided, title will be used.
+     */
+    illustrationDescription?: string;
+    /**
+     * Designates the position of the illustration relative to the content
+     */
+    illustrationPosition?: 'top' | 'right' | 'bottom' | 'left';
+    /**
+     * Empty state illustration theme variations.
+     * To ensure you use the correct themed illustrations, you can conditionally specify light or dark
+     * based on your app's current theme value. Example:
+     * `illustrationTheme={appTheme === ('carbon--g100' || 'carbon--g90') ? 'dark' : 'light'}`
+     */
+    illustrationTheme?: 'light' | 'dark';
+    /**
+     * Empty state link object
+     */
+    link?: {
+        text?: string | ReactNode;
+        href?: string;
+    };
+    /**
+     * Empty state size
+     */
+    size?: 'lg' | 'sm';
+    /**
+     * Empty state subtitle
+     */
+    subtitle?: string | React.ReactNode;
+    /**
+     * Empty state title
+     */
+    title: string | React.ReactNode;
+}
 /**
  * The `EmptyState` component follows the Carbon guidelines for empty states with some added specifications around illustration usage. For additional usage guidelines and documentation please refer to the links above.
  */
-export let NoDataEmptyState: React.ForwardRefExoticComponent<React.RefAttributes<any>>;
-import React from 'react';
+export declare let NoDataEmptyState: React.ForwardRefExoticComponent<NoDataEmptyStateProps & React.RefAttributes<HTMLDivElement>>;
+export {};

package/lib/components/EmptyStates/NoDataEmptyState/NoDataEmptyState.js

@@ -30,7 +30,6 @@ var _excluded = ["action", "className", "illustrationPosition", "illustrationThe
 // The block part of our conventional BEM class names (blockClass__E--M).
 var blockClass = "".concat(settings.pkg.prefix, "--empty-state");
 var componentName = 'NoDataEmptyState';
-
 /**
  * The `EmptyState` component follows the Carbon guidelines for empty states with some added specifications around illustration usage. For additional usage guidelines and documentation please refer to the links above.
  */
@@ -59,7 +58,7 @@ exports.NoDataEmptyState = /*#__PURE__*/React__default["default"].forwardRef(fun
     link: link,
     size: size,
     subtitle: subtitle,
-    title: title
+    title: title || ''
   }));
 });
 

package/lib/components/EmptyStates/NoTagsEmptyState/NoTagsEmptyState.d.ts

@@ -1,5 +1,64 @@
+/**
+ * Copyright IBM Corp. 2020, 2021
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+/// <reference path="../../../../src/custom-typings/index.d.ts" />
+import React, { ReactNode } from 'react';
+import { ButtonProps } from '@carbon/react';
+import { CarbonIconType } from '@carbon/icons-react/lib/CarbonIcon';
+interface NoTagsEmptyStateProps {
+    /**
+     * Empty state action button
+     */
+    action?: {
+        kind?: 'primary' | 'secondary' | 'tertiary';
+        renderIcon?: CarbonIconType;
+        onClick?: ButtonProps['onClick'];
+        text?: string;
+    };
+    /**
+     * Provide an optional class to be applied to the containing node.
+     */
+    className?: string;
+    /**
+     * The alt text for empty state svg images. If not provided , title will be used.
+     */
+    illustrationDescription?: string;
+    /**
+     * Designates the position of the illustration relative to the content
+     */
+    illustrationPosition?: 'top' | 'right' | 'bottom' | 'left';
+    /**
+     * Empty state illustration theme variations.
+     * To ensure you use the correct themed illustrations, you can conditionally specify light or dark
+     * based on your app's current theme value. Example:
+     * `illustrationTheme={appTheme === ('carbon--g100' || 'carbon--g90') ? 'dark' : 'light'}`
+     */
+    illustrationTheme?: 'light' | 'dark';
+    /**
+     * Empty state link object
+     */
+    link?: {
+        text?: string | ReactNode;
+        href?: string;
+    };
+    /**
+     * Empty state size
+     */
+    size?: 'lg' | 'sm';
+    /**
+     * Empty state subtitle
+     */
+    subtitle?: string | ReactNode;
+    /**
+     * Empty state title
+     */
+    title: string | ReactNode;
+}
 /**
  * The `EmptyState` component follows the Carbon guidelines for empty states with some added specifications around illustration usage. For additional usage guidelines and documentation please refer to the links above.
  */
-export let NoTagsEmptyState: React.ForwardRefExoticComponent<React.RefAttributes<any>>;
-import React from 'react';
+export declare let NoTagsEmptyState: React.ForwardRefExoticComponent<NoTagsEmptyStateProps & React.RefAttributes<HTMLDivElement>>;
+export {};

package/lib/components/EmptyStates/NoTagsEmptyState/NoTagsEmptyState.js

@@ -26,11 +26,9 @@ var React__default = /*#__PURE__*/_interopDefaultLegacy(React);
 var cx__default = /*#__PURE__*/_interopDefaultLegacy(cx);
 
 var _excluded = ["action", "className", "illustrationPosition", "illustrationTheme", "illustrationDescription", "link", "size", "subtitle", "title"];
-
 // The block part of our conventional BEM class names (blockClass__E--M).
 var blockClass = "".concat(settings.pkg.prefix, "--empty-state");
 var componentName = 'NoTagsEmptyState';
-
 /**
  * The `EmptyState` component follows the Carbon guidelines for empty states with some added specifications around illustration usage. For additional usage guidelines and documentation please refer to the links above.
  */
@@ -59,7 +57,7 @@ exports.NoTagsEmptyState = /*#__PURE__*/React__default["default"].forwardRef(fun
     link: link,
     size: size,
     subtitle: subtitle,
-    title: title
+    title: title = ''
   }));
 });
 

package/lib/components/EmptyStates/NotFoundEmptyState/NotFoundEmptyState.d.ts

@@ -1,5 +1,64 @@
+/**
+ * Copyright IBM Corp. 2020, 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.
+ */
+/// <reference path="../../../../src/custom-typings/index.d.ts" />
+import React, { ReactNode } from 'react';
+import { ButtonProps } from '@carbon/react';
+import { CarbonIconType } from '@carbon/icons-react/lib/CarbonIcon';
+interface NotFoundEmptyStateProps {
+    /**
+     * Empty state action button
+     */
+    action?: {
+        kind?: 'primary' | 'secondary' | 'tertiary';
+        renderIcon?: CarbonIconType;
+        onClick?: ButtonProps['onClick'];
+        text?: string;
+    };
+    /**
+     * Provide an optional class to be applied to the containing node.
+     */
+    className?: string;
+    /**
+     * The alt text for empty state svg images. If not provided , title will be used.
+     */
+    illustrationDescription?: string;
+    /**
+     * Designates the position of the illustration relative to the content
+     */
+    illustrationPosition?: 'top' | 'right' | 'bottom' | 'left';
+    /**
+     * Empty state illustration theme variations.
+     * To ensure you use the correct themed illustrations, you can conditionally specify light or dark
+     * based on your app's current theme value. Example:
+     * `illustrationTheme={appTheme === ('carbon--g100' || 'carbon--g90') ? 'dark' : 'light'}`
+     */
+    illustrationTheme?: 'light' | 'dark';
+    /**
+     * Empty state link object
+     */
+    link?: {
+        text?: string | ReactNode;
+        href?: string;
+    };
+    /**
+     * Empty state size
+     */
+    size?: 'lg' | 'sm';
+    /**
+     * Empty state subtitle
+     */
+    subtitle: string | ReactNode;
+    /**
+     * Empty state title
+     */
+    title: string | ReactNode;
+}
 /**
  * The `EmptyState` component follows the Carbon guidelines for empty states with some added specifications around illustration usage. For additional usage guidelines and documentation please refer to the links above.
  */
-export let NotFoundEmptyState: React.ForwardRefExoticComponent<React.RefAttributes<any>>;
-import React from 'react';
+export declare let NotFoundEmptyState: React.ForwardRefExoticComponent<NotFoundEmptyStateProps & React.RefAttributes<HTMLDivElement>>;
+export {};

package/lib/components/EmptyStates/NotFoundEmptyState/NotFoundEmptyState.js

@@ -26,11 +26,9 @@ var React__default = /*#__PURE__*/_interopDefaultLegacy(React);
 var cx__default = /*#__PURE__*/_interopDefaultLegacy(cx);
 
 var _excluded = ["action", "className", "illustrationPosition", "illustrationTheme", "illustrationDescription", "link", "size", "subtitle", "title"];
-
 // The block part of our conventional BEM class names (blockClass__E--M).
 var blockClass = "".concat(settings.pkg.prefix, "--empty-state");
 var componentName = 'NotFoundEmptyState';
-
 /**
  * The `EmptyState` component follows the Carbon guidelines for empty states with some added specifications around illustration usage. For additional usage guidelines and documentation please refer to the links above.
  */
@@ -59,7 +57,7 @@ exports.NotFoundEmptyState = /*#__PURE__*/React__default["default"].forwardRef(f
     link: link,
     size: size,
     subtitle: subtitle,
-    title: title
+    title: title || ''
   }));
 });
 

package/lib/components/EmptyStates/UnauthorizedEmptyState/UnauthorizedEmptyState.d.ts

@@ -1,5 +1,64 @@
+/**
+ * Copyright IBM Corp. 2020, 2021
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+/// <reference path="../../../../src/custom-typings/index.d.ts" />
+import React, { ReactNode } from 'react';
+import { ButtonProps } from '@carbon/react';
+import { CarbonIconType } from '@carbon/icons-react/lib/CarbonIcon';
+interface UnauthorizedEmptyStateProps {
+    /**
+     * Empty state action button
+     */
+    action?: {
+        kind?: 'primary' | 'secondary' | 'tertiary';
+        renderIcon?: CarbonIconType;
+        onClick?: ButtonProps['onClick'];
+        text?: string;
+    };
+    /**
+     * Provide an optional class to be applied to the containing node.
+     */
+    className?: string;
+    /**
+     * The alt text for empty state svg images. If not provided , title will be used.
+     */
+    illustrationDescription?: string;
+    /**
+     * Designates the position of the illustration relative to the content
+     */
+    illustrationPosition?: 'top' | 'right' | 'bottom' | 'left';
+    /**
+     * Empty state illustration theme variations.
+     * To ensure you use the correct themed illustrations, you can conditionally specify light or dark
+     * based on your app's current theme value. Example:
+     * `illustrationTheme={appTheme === ('carbon--g100' || 'carbon--g90') ? 'dark' : 'light'}`
+     */
+    illustrationTheme?: 'light' | 'dark';
+    /**
+     * Empty state link object
+     */
+    link?: {
+        text?: string | ReactNode;
+        href?: string;
+    };
+    /**
+     * Empty state size
+     */
+    size?: 'lg' | 'sm';
+    /**
+     * Empty state subtitle
+     */
+    subtitle: string | ReactNode;
+    /**
+     * Empty state title
+     */
+    title: string | ReactNode;
+}
 /**
  * The `EmptyState` component follows the Carbon guidelines for empty states with some added specifications around illustration usage. For additional usage guidelines and documentation please refer to the links above.
  */
-export let UnauthorizedEmptyState: React.ForwardRefExoticComponent<React.RefAttributes<any>>;
-import React from 'react';
+export declare let UnauthorizedEmptyState: React.ForwardRefExoticComponent<UnauthorizedEmptyStateProps & React.RefAttributes<HTMLDivElement>>;
+export {};

package/lib/components/EmptyStates/UnauthorizedEmptyState/UnauthorizedEmptyState.js

@@ -30,7 +30,6 @@ var _excluded = ["action", "className", "illustrationPosition", "illustrationThe
 // The block part of our conventional BEM class names (blockClass__E--M).
 var blockClass = "".concat(settings.pkg.prefix, "--empty-state");
 var componentName = 'UnauthorizedEmptyState';
-
 /**
  * The `EmptyState` component follows the Carbon guidelines for empty states with some added specifications around illustration usage. For additional usage guidelines and documentation please refer to the links above.
  */
@@ -59,7 +58,7 @@ exports.UnauthorizedEmptyState = /*#__PURE__*/React__default["default"].forwardR
     link: link,
     size: size,
     subtitle: subtitle,
-    title: title
+    title: title || ''
   }));
 });
 

package/lib/components/ExportModal/ExportModal.d.ts

@@ -1,5 +1,113 @@
+/// <reference path="../../../src/custom-typings/index.d.ts" />
+import React, { ReactNode } from 'react';
+import { ComposedModal } from '@carbon/react';
+type InputType = 'text' | 'password';
+type PreformattedExtensions = {
+    extension?: string;
+    description?: string;
+};
+interface RemoveModalProps extends React.ComponentProps<typeof ComposedModal> {
+    /**
+     * Body content for the modal
+     */
+    body?: string;
+    /**
+     * Optional class name
+     */
+    className?: string;
+    /**
+     * specify if an error occurred
+     */
+    error?: boolean;
+    /**
+     * messaging to display in the event of an error
+     */
+    errorMessage?: string;
+    /**
+     * name of the file being exported
+     */
+    filename: string;
+    /**
+     * label text that's displayed when hovering over visibility toggler to hide key
+     */
+    hidePasswordLabel?: string;
+    /**
+     * label for the text input
+     */
+    inputLabel?: string;
+    /**
+     * specify the type of text input
+     */
+    inputType: InputType;
+    /**
+     * text for an invalid input
+     */
+    invalidInputText?: string;
+    /**
+     * specify if the modal is in a loading state
+     */
+    loading?: boolean;
+    /**
+     * message to display during the loading state
+     */
+    loadingMessage?: string;
+    /**
+     * Specify a handler for closing modal
+     */
+    onClose?: () => void;
+    /**
+     * Specify a handler for "submitting" modal. Returns the file name
+     */
+    onRequestSubmit?: (value?: string) => void;
+    /**
+     * Specify whether the Modal is currently open
+     */
+    open?: boolean;
+    /**
+     * The DOM node the tearsheet should be rendered within. Defaults to document.body.
+     */
+    portalTarget?: ReactNode;
+    /**
+     * Array of extensions to display as radio buttons
+     */
+    preformattedExtensions: readonly PreformattedExtensions[];
+    /**
+     * Label for the preformatted label form group
+     */
+    preformattedExtensionsLabel?: string;
+    /**
+     * Specify the text for the primary button
+     */
+    primaryButtonText: string;
+    /**
+     * Specify the text for the secondary button
+     */
+    secondaryButtonText: string;
+    /**
+     * label text that's displayed when hovering over visibility toggler to show key
+     */
+    showPasswordLabel?: string;
+    /**
+     * messaging to display if the export was successful
+     */
+    successMessage?: string;
+    /**
+     * specify if the export was successful
+     */
+    successful?: boolean;
+    /**
+     * The text displayed at the top of the modal
+     */
+    title: string;
+    /**
+     * array of valid extensions the file can have
+     */
+    validExtensions: readonly any[];
+}
 /**
  * Modal dialog version of the export pattern
  */
-export let ExportModal: React.ForwardRefExoticComponent<React.RefAttributes<any>>;
-import React from 'react';
+export declare let ExportModal: React.ForwardRefExoticComponent<RemoveModalProps & {
+    children?: React.ReactNode;
+} & React.RefAttributes<unknown>>;
+export {};

package/lib/components/ExportModal/ExportModal.js

@@ -35,7 +35,6 @@ var defaults = {
   preformattedExtensions: Object.freeze([]),
   validExtensions: Object.freeze([])
 };
-
 /**
  * Modal dialog version of the export pattern
  */
@@ -48,7 +47,7 @@ exports.ExportModal = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
     hidePasswordLabel = _ref.hidePasswordLabel,
     inputLabel = _ref.inputLabel,
     _ref$inputType = _ref.inputType,
-    inputType = _ref$inputType === void 0 ? defaults.inputType : _ref$inputType,
+    inputType = _ref$inputType === void 0 ? 'text' : _ref$inputType,
     invalidInputText = _ref.invalidInputText,
     loading = _ref.loading,
     loadingMessage = _ref.loadingMessage,
@@ -85,7 +84,10 @@ exports.ExportModal = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
   React.useEffect(function () {
     var _preformattedExtensio;
     setName(filename);
-    setExtension(preformattedExtensions === null || preformattedExtensions === void 0 || (_preformattedExtensio = preformattedExtensions[0]) === null || _preformattedExtensio === void 0 ? void 0 : _preformattedExtensio.extension);
+    if (preformattedExtensions && preformattedExtensions.length > 0 && (_preformattedExtensio = preformattedExtensions[0]) !== null && _preformattedExtensio !== void 0 && _preformattedExtensio.extension) {
+      var _preformattedExtensio2;
+      setExtension(preformattedExtensions === null || preformattedExtensions === void 0 || (_preformattedExtensio2 = preformattedExtensions[0]) === null || _preformattedExtensio2 === void 0 ? void 0 : _preformattedExtensio2.extension);
+    }
   }, [filename, preformattedExtensions, open]);
   var onNameChangeHandler = function onNameChangeHandler(evt) {
     setName(evt.target.value);
@@ -98,7 +100,7 @@ exports.ExportModal = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
   };
   var onSubmitHandler = function onSubmitHandler() {
     var returnName = extension ? "".concat(filename, ".").concat(extension.toLocaleLowerCase()) : name;
-    onRequestSubmit(returnName);
+    onRequestSubmit && onRequestSubmit(returnName);
   };
   var hasInvalidExtension = function hasInvalidExtension() {
     if (!dirtyInput || !validExtensions || !validExtensions.length) {
@@ -195,6 +197,7 @@ exports.ExportModal.propTypes = {
   /**
    * Body content for the modal
    */
+  /**@ts-ignore*/
   body: index["default"].string,
   /**
    * Optional class name
@@ -223,6 +226,7 @@ exports.ExportModal.propTypes = {
   /**
    * specify the type of text input
    */
+  /**@ts-ignore */
   inputType: index["default"].oneOf(['text', 'password']),
   /**
    * text for an invalid input
@@ -255,6 +259,7 @@ exports.ExportModal.propTypes = {
   /**
    * Array of extensions to display as radio buttons
    */
+  /**@ts-ignore */
   preformattedExtensions: index["default"].arrayOf(index["default"].shape({
     extension: index["default"].string,
     description: index["default"].string
@@ -290,6 +295,7 @@ exports.ExportModal.propTypes = {
   /**
    * array of valid extensions the file can have
    */
+  /**@ts-ignore */
   validExtensions: index["default"].array
 };
 exports.ExportModal.displayName = componentName;

package/lib/components/FilterPanel/FilterPanelAccordion/FilterPanelAccordion.js

@@ -64,7 +64,7 @@ exports.FilterPanelAccordion = settings.pkg.checkComponentEnabled(exports.Filter
 exports.FilterPanelAccordion.displayName = componentName;
 exports.FilterPanelAccordion.propTypes = {
   /**
-   * Props specific to the internal `Accordion`.
+   * Props specific to the internal `Accordion` component.
    */
   accordionProps: index["default"].shape({}),
   /**

package/lib/components/FilterPanel/FilterPanelAccordionItem/FilterPanelAccordionItem.js

@@ -71,7 +71,7 @@ exports.FilterPanelAccordionItem = settings.pkg.checkComponentEnabled(exports.Fi
 exports.FilterPanelAccordionItem.displayName = componentName;
 exports.FilterPanelAccordionItem.propTypes = {
   /**
-   * Props specific to the internal `AccordionItem`.
+   * Props specific to the internal `AccordionItem` component.
    */
   accordionItemProps: index["default"].shape({}),
   /**
@@ -95,7 +95,7 @@ exports.FilterPanelAccordionItem.propTypes = {
    */
   title: index["default"].string,
   /**
-   * Props specific to the internal `TruncatedList`.
+   * Props specific to the internal `TruncatedList` component.
    */
   truncatedListProps: index["default"].shape({})
 };

package/lib/components/FilterPanel/FilterPanelCheckbox/FilterPanelCheckbox.d.ts

@@ -1,5 +1,10 @@
 /**
  * Provides a checkbox, label, and count.
+ *
+ * This component is returning Carbon's Checkbox.
+ *
+ * All of Carbon Checkbox's props are directly available
+ * through "...rest", including id, onClick, etc.
  */
 export let FilterPanelCheckbox: React.ForwardRefExoticComponent<React.RefAttributes<any>>;
 import React from 'react';