@carbon/ibm-products
Version:
Carbon for IBM Products
74 lines • 2.27 kB
TypeScript
/**
* 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>>;
//# sourceMappingURL=AboutModal.d.ts.map