@vonage/vivid-react
Version:
Vivid wrapped for easy React usage & IDE autocomplete support & typescript typings
55 lines (54 loc) • 3 kB
TypeScript
import React, { ReactNode, SyntheticEvent } from 'react';
/** VwcDialog
* For more info on this Vivid element please visit https://vivid.deno.dev/components/dialog
* @param {boolean} open - Indicates dialog's state **attribute** `open`
* @param {string | undefined} icon **attribute** `icon`
* @param {IconPlacement | undefined} iconPlacement **attribute** `icon-placement`
* @param {string | undefined} subtitle **attribute** `subtitle`
* @param {string | undefined} headline **attribute** `headline`
* @param {boolean} fullWidthBody **attribute** `full-width-body`
* @param {| string
| null} dismissButtonAriaLabel **attribute** `dismiss-button-aria-label`
* @param {boolean} noLightDismiss - Prevents the dialog from being dismissed when clicking outside it. **attribute** `no-light-dismiss`
* @param {boolean} noDismissOnEsc - Prevents the dialog from being dismissed when the escape key is pressed. **attribute** `no-dismiss-on-esc`
* @param {boolean} noDismissButton - Hides the dismiss button. **attribute** `no-dismiss-button`
* @param {boolean} nonDismissible - Disables all means of dismissal for the dialog. **attribute** `non-dismissible`
* @param {boolean} modal - Controls whether the dialog is modal. **attribute** `modal`
* @param {boolean} scrollableBody - Makes only the element's content area between the header and footer scrollable **attribute** `scrollable-body`
* @param {string} returnValue
* @param {'delegate'} _vividAriaBehaviour
* @param {string} VIVID_VERSION - The current version of the Vivid library, which is useful for debugging.
It can be accessed from any Vivid element via `<el>.constructor.VIVID_VERSION`.
* @param {string} componentName - Core component name, without prefix
*/
declare const VwcDialog: {
(props: {
children?: ReactNode;
slot?: string | undefined;
id?: string | undefined;
style?: React.CSSProperties | undefined;
ref?: React.RefObject<HTMLDivElement> | ((instance: HTMLDivElement | null) => void) | null | undefined;
onOpen?: ((event: SyntheticEvent) => void) | undefined;
onClose?: ((event: SyntheticEvent) => void) | undefined;
onCancel?: ((event: SyntheticEvent) => void) | undefined;
open?: boolean | undefined;
icon?: string | undefined;
iconPlacement?: any;
subtitle?: string | undefined;
headline?: string | undefined;
fullWidthBody?: boolean | undefined;
dismissButtonAriaLabel?: any;
noLightDismiss?: boolean | undefined;
noDismissOnEsc?: boolean | undefined;
noDismissButton?: boolean | undefined;
nonDismissible?: boolean | undefined;
modal?: boolean | undefined;
scrollableBody?: boolean | undefined;
returnValue?: string | undefined;
_vividAriaBehaviour?: any;
VIVID_VERSION?: string | undefined;
componentName?: string | undefined;
}): JSX.Element;
displayName: string;
};
export default VwcDialog;