@carbon/ibm-products 2.80.0 → 2.81.0-rc.0

package/es/components/APIKeyModal/APIKeyModal.types.d.ts

@@ -1,234 +0,0 @@
-/**
- * Copyright IBM Corp. 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 { ReactNode, RefObject } from 'react';
-interface APIKeyModalCommonProps {
-    /**
-     * the api key that's displayed to the user when a request to create is fulfilled.
-     */
-    apiKey?: string;
-    /**
-     * label for the text input that holds the api key.
-     */
-    apiKeyLabel?: string;
-    /**
-     * the name of the api key. should only be supplied in edit mode.
-     */
-    apiKeyName?: string;
-    /**
-     * body content for the modal
-     */
-    body?: string;
-    /**
-     * optional class name
-     */
-    className?: string;
-    /**
-     * text for the close button
-     */
-    closeButtonText?: string;
-    /**
-     * text for the copy button
-     */
-    copyButtonText?: string;
-    /**
-     * Error message for when the copy function fails
-     */
-    copyErrorText?: string;
-    /**
-     * text description for the copy button icon
-     */
-    copyIconDescription?: string;
-    /**
-     * if you need more options for key creation beyond just the name use custom steps to obtain whatever data is required.
-     */
-    customSteps?: Array<{
-        valid?: boolean;
-        content?: ReactNode;
-        title?: string;
-    }>;
-    /**
-     * designates if the modal is in the edit mode
-     */
-    editing?: boolean;
-    /**
-     * designates if an error has occurred in a request
-     */
-    error?: boolean;
-    /**
-     * text to display if an error has occurred
-     */
-    errorText?: string;
-    /**
-     * default primary button text for modal in assumed default mode create or generate.
-     * in create mode this is the button text prior to supplying an api key, which then
-     * uses copyButtonText
-     */
-    generateButtonText?: string;
-    /**
-     * content to display if generate request was successful
-     */
-    generateSuccessBody?: ReactNode;
-    /**
-     * * @deprecated use `generateSuccessMessage` instead
-     * title for a successful key generation
-     */
-    generateSuccessTitle?: string;
-    /**
-     * success message for a successful key generation
-     */
-    generateSuccessMessage?: string;
-    /**
-     * default title for the modal in generate key mode
-     */
-    generateTitle?: string;
-    /**
-     * designates if the api input has the visibility toggle enabled
-     */
-    hasAPIKeyVisibilityToggle?: boolean;
-    /**
-     * designates if user is able to download the api key
-     */
-    hasDownloadLink?: boolean;
-    /**
-     * label text that's displayed when hovering over visibility toggler to hide key
-     */
-    hideAPIKeyLabel?: string;
-    /**
-     * Provide a ref to return focus to once the tearsheet is closed.
-     */
-    launcherButtonRef?: RefObject<any>;
-    /**
-     * designates if the modal is in a loading state via a request or some other in progress operation
-     */
-    loading?: boolean;
-    /**
-     * text that displays while modal is in the loading state
-     */
-    loadingText?: string;
-    /**
-     * general label text for modal
-     */
-    modalLabel?: string;
-    /**
-     * helper text for name input
-     */
-    nameHelperText?: string;
-    /**
-     * label for api key name input
-     */
-    nameLabel?: string;
-    /**
-     * placeholder text for api key name input
-     */
-    namePlaceholder?: string;
-    /**
-     * designates if a name is required or not for key generation. NOTE- if using custom steps set this to false since you will be using your own validation
-     */
-    nameRequired?: boolean;
-    /**
-     * handler for on modal close
-     */
-    onClose?(): void;
-    /**
-     * Optional callback if you want to use your own copy function instead of the build in one
-     * onCopy(apiKey)
-     */
-    onCopy?(apiKey: string): void;
-    /**
-     * handler for api key edit
-     */
-    onRequestEdit?(apiKeyName: string): void;
-    /**
-     * handler for api key generation
-     */
-    onRequestGenerate?(apiKeyName: string): void;
-    /**
-     * designates if modal is open or closed
-     */
-    open: boolean;
-    /**
-     * The DOM node the tearsheet should be rendered within. Defaults to document.body.
-     */
-    portalTarget?: ReactNode;
-    /**
-     * label text that's displayed when hovering over visibility toggler to show key
-     */
-    showAPIKeyLabel?: string;
-    /**
-     * helper text for password input
-     */
-    helperText?: string;
-}
-type CustomStepConditionalProps = {
-    /**
-     * if you need more options for key creation beyond just the name use custom steps to obtain whatever data is required.
-     */
-    customSteps?: Array<{
-        valid?: boolean;
-        content?: ReactNode;
-        title?: string;
-    }>;
-    /**
-     * text that displays in the secondary button when using custom steps to indicate to the user that there is a previous step
-     */
-    previousStepButtonText: string;
-    /**
-     * text that displays in the primary button when using custom steps to indicate to the user that there is a next step
-     */
-    nextStepButtonText: string;
-};
-type EditingConditionalProps = {
-    /**
-     * designates if the modal is in the edit mode
-     */
-    editing?: boolean;
-    /**
-     * text for the edit button
-     */
-    editButtonText: string;
-    /**
-     * designates if the edit request was successful
-     */
-    editSuccess: boolean;
-    /**
-     * * @deprecated use `editSuccessMessage` instead
-     * title for a successful edit
-     */
-    editSuccessTitle?: string;
-    /**
-     * success message for edit
-     */
-    editSuccessMessage: string;
-};
-type HasDownloadLinkProps = {
-    /**
-     * designates if user is able to download the api key
-     */
-    hasDownloadLink?: boolean;
-    /**
-     * the content that appears that indicates the key is downloadable
-     */
-    downloadBodyText?: string;
-    /**
-     * designates the name of downloadable json file with the key. if not specified will default to 'apikey'
-     */
-    downloadFileName: string;
-    /**
-     * designates the file type for the downloadable key
-     */
-    downloadFileType: 'txt' | 'json';
-    /**
-     * anchor text for the download link
-     */
-    downloadLinkText: string;
-    /**
-     * Aria-label for the download link
-     */
-    downloadLinkLabel?: string;
-};
-export type APIKeyModalProps = APIKeyModalCommonProps & CustomStepConditionalProps & EditingConditionalProps & HasDownloadLinkProps;
-export {};

package/es/components/APIKeyModal/index.d.ts

@@ -1,2 +0,0 @@
-export { APIKeyModal } from './APIKeyModal';
-export type { APIKeyModalProps } from './APIKeyModal.types';

package/es/components/AboutModal/AboutModal.d.ts

@@ -1,73 +0,0 @@
-/**
- * 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.
- */
-import React, { ReactNode } from 'react';
-export interface AboutModalProps {
-    /**
-     * Provide additional detail for the modal footer, such as logos of
-     * technologies used in the product, legally required for some products
-     */
-    additionalInfo?: ReactNode;
-    /**
-     * Specify an optional className to be applied to the modal root node
-     */
-    className?: string;
-    /**
-     * Provide an accessible name for the close icon
-     */
-    closeIconDescription: string;
-    /**
-     * Provide any relevant product disclaimers or legal information
-     */
-    content?: ReactNode;
-    /**
-     * Specify the first year of product release to the current year
-     */
-    copyrightText: string;
-    /**
-     * Provide an array of Carbon `Link`s for additional detail about the
-     * product
-     */
-    links?: ReactNode[];
-    /**
-     * Provide a visual representation of the product
-     */
-    logo: ReactNode;
-    /**
-     * Specify an aria-label for the modal
-     */
-    modalAriaLabel?: string;
-    /**
-     * Specify an optional handler for closing modal. Returning `false`
-     * prevents the modal from closing
-     */
-    onClose?: () => void | boolean;
-    /**
-     * Specify whether the modal is currently open
-     */
-    open?: boolean;
-    /**
-     * Provide the DOM node where the modal should be rendered.
-     * Defaults to `document.body`
-     */
-    portalTarget?: ReactNode;
-    /**
-     * Provide the product name for the modal header
-     */
-    title: ReactNode;
-    /**
-     * Provide the product’s version number
-     */
-    version: string;
-}
-/**
- * The `AboutModal` component provides a way to communicate product information
- * to users. It is triggered by a user’s action, appears on top of the main
- * page content, and is persistent until dismissed. The purpose of this modal
- * should be immediately apparent to the user, with a clear and obvious path
- * to completion.
- */
-export declare const AboutModal: React.ForwardRefExoticComponent<AboutModalProps & React.RefAttributes<HTMLDivElement>>;

package/es/components/AboutModal/AboutModal.js

@@ -1,177 +0,0 @@
-/**
- * Copyright IBM Corp. 2020, 2025
- *
- * 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 { extends as _extends } from '../../_virtual/_rollupPluginBabelHelpers.js';
-import { unstable_FeatureFlags, ComposedModal, ModalHeader, ModalBody, Theme, ModalFooter } from '@carbon/react';
-import React__default, { useRef, useEffect } from 'react';
-import PropTypes from '../../_virtual/index.js';
-import cx from 'classnames';
-import { getDevtoolsProps } from '../../global/js/utils/devtools.js';
-import { useFocus } from '../../global/js/hooks/useFocus.js';
-import { pkg } from '../../settings.js';
-import { usePortalTarget } from '../../global/js/hooks/usePortalTarget.js';
-import uuidv4 from '../../global/js/utils/uuidv4.js';
-
-// The block part of our conventional BEM class names (blockClass__E--M).
-const blockClass = `${pkg.prefix}--about-modal`;
-const componentName = 'AboutModal';
-// NOTE: the component SCSS is not imported here: it is rolled up separately.
-
-/**
- * The `AboutModal` component provides a way to communicate product information
- * to users. It is triggered by a user’s action, appears on top of the main
- * page content, and is persistent until dismissed. The purpose of this modal
- * should be immediately apparent to the user, with a clear and obvious path
- * to completion.
- */
-const AboutModal = /*#__PURE__*/React__default.forwardRef((_ref, ref) => {
-  let {
-    additionalInfo,
-    className,
-    closeIconDescription,
-    copyrightText,
-    content,
-    links,
-    logo,
-    modalAriaLabel,
-    onClose,
-    open,
-    portalTarget: portalTargetIn,
-    title,
-    version,
-    // Collect any other property values passed in.
-    ...rest
-  } = _ref;
-  const bodyRef = useRef(null);
-  const localRef = useRef(undefined);
-  const modalRef = ref || localRef;
-  const contentRef = useRef(null);
-  const contentId = uuidv4();
-  const renderPortalUse = usePortalTarget(portalTargetIn);
-  const {
-    claimFocus
-  } = useFocus(modalRef);
-
-  // We can't add a ref directly to the ModalBody, so track it in a ref
-  // as the parent of the current bodyRef element
-  useEffect(() => {
-    bodyRef.current = contentRef.current?.parentElement;
-  }, [bodyRef]);
-  useEffect(() => {
-    if (open) {
-      claimFocus();
-    }
-    // eslint-disable-next-line react-hooks/exhaustive-deps
-  }, [modalRef, open]);
-  return renderPortalUse(/*#__PURE__*/React__default.createElement(unstable_FeatureFlags, {
-    enableExperimentalFocusWrapWithoutSentinels: true
-  }, /*#__PURE__*/React__default.createElement(ComposedModal, _extends({}, rest, {
-    className: cx(blockClass,
-    // Apply the block class to the main HTML element
-    className // Apply any supplied class names to the main HTML element.
-    ),
-    "aria-label": modalAriaLabel,
-    ref: modalRef,
-    onClose,
-    open
-  }, getDevtoolsProps(componentName)), /*#__PURE__*/React__default.createElement("div", {
-    className: `${blockClass}__logo`
-  }, logo), /*#__PURE__*/React__default.createElement(ModalHeader, {
-    className: `${blockClass}__header`,
-    closeModal: onClose,
-    iconDescription: closeIconDescription,
-    label: title,
-    labelClassName: `${blockClass}__title`
-  }), /*#__PURE__*/React__default.createElement(ModalBody, {
-    className: `${blockClass}__body`
-  }, /*#__PURE__*/React__default.createElement("div", {
-    className: `${blockClass}__body-content`,
-    ref: contentRef,
-    id: contentId
-  }, /*#__PURE__*/React__default.createElement("div", {
-    className: `${blockClass}__version`
-  }, version), links && links.length > 0 && /*#__PURE__*/React__default.createElement("div", {
-    className: `${blockClass}__links-container`
-  }, links.map((link, i) => /*#__PURE__*/React__default.createElement(React__default.Fragment, {
-    key: i
-  }, link))), content && /*#__PURE__*/React__default.createElement("p", {
-    className: `${blockClass}__content`
-  }, content), copyrightText && /*#__PURE__*/React__default.createElement("p", {
-    className: `${blockClass}__copyright-text`
-  }, copyrightText))), additionalInfo && /*#__PURE__*/React__default.createElement(Theme, {
-    theme: "g100"
-  }, /*#__PURE__*/React__default.createElement(ModalFooter, {
-    className: `${blockClass}__footer`
-  }, additionalInfo)))));
-});
-
-// Return a placeholder if not released and not enabled by feature flag
-AboutModal.displayName = componentName;
-
-// The types and DocGen commentary for the component props,
-// in alphabetical order (for consistency).
-// See https://www.npmjs.com/package/prop-types#usage.
-AboutModal.propTypes = {
-  /**
-   * Provide additional detail for the modal footer, such as logos of
-   * technologies used in the product, legally required for some products
-   */
-  additionalInfo: PropTypes.node,
-  /**
-   * Specify an optional className to be applied to the modal root node
-   */
-  className: PropTypes.string,
-  /**
-   * Provide an accessible name for the close icon
-   */
-  closeIconDescription: PropTypes.string.isRequired,
-  /**
-   * Provide any relevant product disclaimers or legal information
-   */
-  content: PropTypes.node,
-  /**
-   * Specify the first year of product release to the current year
-   */
-  copyrightText: PropTypes.string.isRequired,
-  /**
-   * Provide an array of Carbon `Link`s for additional detail about the
-   * product
-   */
-  links: PropTypes.arrayOf(PropTypes.element),
-  /**
-   * Provide a visual representation of the product
-   */
-  logo: PropTypes.node.isRequired,
-  /**
-   * Specify an aria-label for the modal
-   */
-  modalAriaLabel: PropTypes.string,
-  /**
-   * Specify an optional handler for closing modal. Returning `false`
-   * prevents the modal from closing
-   */
-  onClose: PropTypes.func,
-  /**
-   * Specify whether the modal is currently open
-   */
-  open: PropTypes.bool,
-  /**
-   * Provide the DOM node where the modal should be rendered.
-   * Defaults to `document.body`
-   */
-  portalTarget: PropTypes.node,
-  /**
-   * Provide the product name for the modal header
-   */
-  title: PropTypes.node.isRequired,
-  /**
-   * Provide the product’s version number
-   */
-  version: PropTypes.string.isRequired
-};
-
-export { AboutModal };

package/es/components/AboutModal/index.d.ts

@@ -1,8 +0,0 @@
-/**
- * Copyright IBM Corp. 2021, 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.
- */
-export { AboutModal } from './AboutModal';
-export type { AboutModalProps } from './AboutModal';

package/es/components/ActionBar/ActionBar.d.ts

@@ -1,65 +0,0 @@
-import React, { PropsWithChildren, ForwardedRef } from 'react';
-import { ButtonProps } from '@carbon/react';
-import { CarbonIconType } from '@carbon/icons-react/lib/CarbonIcon';
-interface Action extends ButtonProps<React.ElementType> {
-    id?: string;
-    key: string;
-    iconDescription: string;
-    label: string;
-    onClick?: () => void;
-    renderIcon: CarbonIconType;
-}
-interface ActionBarProps extends PropsWithChildren {
-    /**
-     * Specifies the action bar items. Each item is specified as an object
-     * with required fields: key for array rendering, renderIcon, iconDescription and
-     * label to provide the icon to display,
-     * and optional 'onClick' to receive notifications when the button is clicked.
-     * Additional fields in the object will be passed to the
-     * Button component, and these can include 'disabled', 'ref', 'className',
-     * and any other Button props.
-     *
-     * Note that the Button props 'kind', 'size',
-     * 'tooltipPosition', 'tooltipAlignment' and 'type' are ignored, as these
-     * cannot be used for an action bar item.
-     *
-     * Carbon Button API https://react.carbondesignsystem.com/?path=/docs/components-button--default#component-api
-     */
-    actions?: readonly Action[];
-    /**
-     * className
-     */
-    className?: string;
-    /**
-     * maxVisible : Maximum action bar items visible before going into the overflow menu
-     */
-    maxVisible?: number;
-    /**
-     * class name applied to the overflow options
-     */
-    menuOptionsClass?: string;
-    /**
-     * onItemCountChange - event reporting maxWidth
-     */
-    onWidthChange?: (sizes?: {
-        minWidth?: number;
-        maxWidth?: number;
-    }) => void;
-    /**
-     * overflowAriaLabel label for open close button overflow used for action bar items that do nto fit.
-     */
-    overflowAriaLabel: string;
-    /**
-     * overflowMenuRef for the overflow menu width that is needed to calculate the width of the action bar with overflow
-     */
-    overflowMenuRef?: ForwardedRef<HTMLDivElement>;
-    /**
-     * align tags to right of available space
-     */
-    rightAlign?: boolean;
-}
-/**
- * The ActionBar is used internally by the PageHeader to wrap ActionBarItems.
- */
-export declare const ActionBar: React.ForwardRefExoticComponent<ActionBarProps & React.RefAttributes<HTMLDivElement>>;
-export {};