@carbon/ibm-products-web-components
Version:
Carbon for IBM Products Web Components
109 lines • 3.92 kB
TypeScript
/**
* @license
*
* Copyright IBM Corp. 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 { LitElement } from 'lit';
import '@carbon/web-components/es/components/modal/index.js';
export declare const blockClass = "c4p--about-modal";
declare const CDSAboutModal_base: {
new (...args: any[]): {
_handles: Set<import("@carbon/web-components/es/globals/internal/handle").default>;
connectedCallback(): void;
disconnectedCallback(): void;
};
_hostListeners: {
[listenerName: string]: {
[type: string]: {
options?: boolean | AddEventListenerOptions;
};
};
};
} & typeof LitElement;
/**
* About Modal.
*
* @element c4p-about-modal
* @csspart dialog The dialog.
* The custom event fired before this about modal is being closed upon a user gesture.
* Cancellation of this event stops the user-initiated action of closing this about modal.
* @fires c4p-about-modal-beingclosed
* The custom event fired before this about modal is being closed upon a user gesture.
* Cancellation of this event stops the user-initiated action of closing this about modal.
* @fires c4p-about-modal-closed - The custom event fired after this about modal is closed upon a user gesture.
*/
declare class CDSAboutModal extends CDSAboutModal_base {
/**
* Determines if About Modal is open or not.
*/
open: boolean;
/**
* Determines if About Modal is open or not.
*/
closeIconDescription: string;
/**
* Determines if About Modal is open or not.
*/
copyrightText: any;
/**
* A visual symbol used to represent the product.
*/
logo: any;
/**
* Text that provides information on the version number of your product.
*/
version: any;
/**
* 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: any;
/**
* 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: any;
/**
* Subhead text providing any relevant product disclaimers including legal information (optional)
*/
content: any;
/**
* 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: any;
/**
* To check if the modal body is overflowing or not.
*/
private isOverflowing;
private container;
firstUpdated(): void;
updated(): void;
render(): import("lit-html").TemplateResult<1>;
private _handleKeydown;
/**
* Handles `click` event on this element.
*
* @param event The event.
*/
private _handleOutsideClick;
/**
* Handles user-initiated close request of this About Modal.
*
* @param triggeredBy The element that triggered this close request.
*/
private _handleClose;
private _checkOverflow;
/**
* The name of the custom event fired after this About Modal is closed upon a user gesture.
*/
static get eventClose(): string;
/**
* The name of the custom event fired before this About modal is being closed upon a user gesture.
* Cancellation of this event stops the user-initiated action of closing this About modal.
*/
static get eventBeforeClose(): string;
static styles: any;
}
export default CDSAboutModal;
//# sourceMappingURL=about-modal.d.ts.map