Methods
# inner Modal(props) → {React.ReactElement}
Wrapper of the Mui Dialog component
Prevent closing by clicking outside of the dialog by NOT passing in a handleClose prop
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
props |
object
|
||
open |
boolean
|
whether the dialog is open or not | |
title |
string
|
<optional> |
the title of the dialog |
okLabel |
string
|
<optional> |
the label for the OK button |
disableOk |
boolean
|
<optional> |
disable the OK button |
cancelLabel |
string
|
<optional> |
the label for the Cancel button |
disableCancel |
boolean
|
<optional> |
disable the OK button |
showX |
boolean
|
<optional> |
whether to show the X in the top right corner |
hideActions |
boolean
|
<optional> |
whether to hide the actions (OK and Cancel buttons) |
hideCancel |
boolean
|
<optional> |
whether to hide the Cancel button |
hideOk |
boolean
|
<optional> |
whether to hide the OK button |
onOk |
function
|
<optional> |
the function to call when the OK button is clicked |
onCancel |
function
|
<optional> |
the function to call when the Cancel button is clicked |
handleClose |
function
|
<optional> |
the function to call when the dialog is closed |
okColor |
string
|
<optional> |
the color of the OK button |
cancelColor |
string
|
<optional> |
the color of the Cancel button |
- React component
React.ReactElement
# inner ShowHidden(props) → {React.ReactElement|null}
Parameters:
| Name | Type | Description |
|---|---|---|
props |
object
|
props object |
hide |
boolean
|
whether to hide the button or not |
props |
object
|
props for the Button component |
- React component
React.ReactElement
|
null