DialogProps Interface
Properties for the Dialog component
Extends
- object
- CommonProps
Properties
Name | Type | Description | |
---|---|---|---|
alignment | undefined | DialogAlignment | Default alignment of dialog. | |
backgroundStyle | undefined | React.CSSProperties | Custom CSS Style for overlay | |
buttonCluster | undefined | DialogButtonDef[] | List of DialogButtonDef objects specifying buttons and associated onClick events | |
contentClassName | undefined | string | Custom CSS class name for the content | |
contentStyle | undefined | React.CSSProperties | Custom CSS Style for the content | |
footer | string | Element | Footer to show at bottom of dialog. | |
footerStyle | undefined | React.CSSProperties | Custom CSS Style for footer | |
header | undefined | React.ReactNode | Override for the header | |
height | string | number | initial height of dialog. | |
hideHeader | undefined | false | true | Whether the hide the header. | |
inset | undefined | false | true | Whether the content should be inset. | |
maxHeight | undefined | number | maximum height that the dialog may be resized to. | |
maxWidth | undefined | number | maximum width that the dialog may be resized to. | |
minHeight | undefined | number | minimum height that the dialog may be resized to. | |
minWidth | undefined | number | minimum width that the dialog may be resized to. | |
modal | undefined | false | true | Whether to show background overlay. | |
modelessId | undefined | string | An id for a modeless dialog | |
movable | undefined | false | true | Whether user can move dialog with cursor. | |
onClose | undefined | () => void | onClick event for X button for dialog | |
onEscape | undefined | () => void | 'keyup' event for Esc key | |
onModelessPointerDown | undefined | (event: PointerEvent, id: string) => void | Pointer Down event handler when modeless (modal = false) | |
onOutsideClick | undefined | (event: MouseEvent) => any | triggered when a click is triggered outside of this dialog. | |
opened | boolean | whether to show dialog or not | |
resizable | undefined | false | true | Whether user can resize dialog with cursor. | |
title | string | Element | Title to show in title bar of dialog | |
titleStyle | undefined | React.CSSProperties | Custom CSS Style for title | |
width | string | number | initial width of dialog. | |
x | undefined | number | initial x/left position of dialog. | |
y | undefined | number | initial y/top position of dialog. |
Inherited properties
Name | Type | Inherited from | Description |
---|---|---|---|
className | undefined | string | ClassNameProps | Custom CSS class name |
style | undefined | React.CSSProperties | CommonProps | Custom CSS style properties |
Defined in
Last Updated: 05 June, 2020