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

Carbon for IBM Products

/**
 * Copyright IBM Corp. 2021, 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 { ComposedModal } from '@carbon/react';
import React, { ReactNode } from 'react';
export interface CreateModalProps extends React.ComponentProps<typeof ComposedModal> {
    /**
     * Specify an optional className to be applied to the modal root node
     */
    className?: string;
    /**
     * Specifies an optional handler which is called when the CreateModal
     * is closed.
     */
    onRequestClose?(): void;
    /**
     * Specifies an optional handler which is called when the CreateModal
     * primary button is pressed.
     */
    onRequestSubmit?(): void;
    /**
     * Specifies whether the CreateModal is open or not.
     */
    open?: boolean;
    /**
     * The title of the CreateModal is usually the product or service name.
     */
    title: ReactNode;
    /**
     * The subtitle of the CreateModal is optional and serves to provide more information about the modal.
     */
    subtitle?: ReactNode;
    /**
     * The description of the CreateModal serves to provide more information about the modal.
     */
    description: ReactNode;
    /**
     * Specifies the secondary button's text in the modal.
     */
    secondaryButtonText: string;
    /**
     * The DOM node the tearsheet should be rendered within. Defaults to document.body.
     */
    portalTarget?: ReactNode;
    /**
     * Specifies the primary button's text in the modal.
     */
    primaryButtonText: string;
    /**
     * Specifies a boolean for disabling or enabling the primary button. This is important for form validation
     * Returning `true` prevents the primary button from being clicked until required fields are completed.
     */
    disableSubmit?: boolean;
    /**
     * Specifies which DOM element in the form should be focused.
     */
    selectorPrimaryFocus: string;
}
/**
 * The `CreateModal` component provides a way for a user to quickly generate a new
resource. 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 CreateModal: React.ForwardRefExoticComponent<CreateModalProps & {
    children?: ReactNode | undefined;
} & React.RefAttributes<HTMLDivElement>>;