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