@carbon/ibm-products/lib/components/AboutModal/AboutModal.d.ts

Carbon for IBM Products

/**
 * 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 {
    /**
     * If you are legally required to display logos of technologies used
     * to build your product you can provide this in the additionalInfo.
     * Additional information will be displayed in the footer.
     */
    additionalInfo?: ReactNode;
    /**
     * Provide an optional class to be applied to the modal root node.
     */
    className?: string;
    /**
     * The accessibility title for the close icon.
     */
    closeIconDescription: string;
    /**
     * Subhead text providing any relevant product disclaimers including
     * legal information (optional)
     */
    content?: ReactNode;
    /**
     * Trademark and copyright information. Displays first year of
     * product release to current year.
     */
    copyrightText: string;
    /**
     * An array of Carbon `Link` component if there are additional information
     * to call out within the card. The about modal should be used to display
     * the product information and not where users go to find help (optional)
     */
    links?: ReactNode[];
    /**
     * A visual symbol used to represent the product.
     */
    logo: ReactNode;
    /**
     * Specifies aria label for AboutModal
     */
    modalAriaLabel?: string;
    /**
     * Specifies an optional handler which is called when the AboutModal
     * is closed. Returning `false` prevents the AboutModal from closing.
     */
    onClose?: () => void | boolean;
    /**
     * Specifies whether the AboutModal is open or not.
     */
    open?: boolean;
    /**
     * The DOM node the tearsheet should be rendered within. Defaults to document.body.
     */
    portalTarget?: ReactNode;
    /**
     * Header text that provides the product name. The IBM Services logo
     * consists of two discrete, but required, elements: the iconic
     * IBM 8-bar logo represented alongside the IBM Services logotype.
     * Please follow these guidelines to ensure proper execution.
     */
    title: ReactNode;
    /**
     * Text that provides information on the version number of your product.
     */
    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 let AboutModal: React.ForwardRefExoticComponent<AboutModalProps & React.RefAttributes<HTMLDivElement>>;