Start sharing components as a team!Share components as a team!Join Bit to build your applications faster.Get Started Free

dialog

v3.9.2arrow_drop_down
v3.9.2
STATUS
Passing
DOWNLOADS
793
LICENSE
MIT
VISIBILITY
Public
PUBLISHED
6 months ago
SIZE
29 KB
subject
Dialogs are overlaid modal paper based components with a backdrop.
1 contributor
Use dialog in your project ?
Copied
npm i @bit/mui-org.material-ui.dialog
Set Bit as a scoped registryLearn more
npm config set '@bit:registry' https://node.bit.dev
Component Example
React
React
Vue
Angular
Add dependency... help_outline
Just
import
any of the 1 million components
and packages in Bit or NPM to the example.
import Button from '@bit/grommet.grommet.button';
import Lodash from 'lodash';
revert changes
reload
toggle layout
maximize
modifieddraft
modifieddraft
modifieddraft
modifieddraft
modifieddraft
CustomizedDialogDemo;
modifieddraft
modifieddraft
modifieddraft
modifieddraft
modifieddraft
modifieddraft
modifieddraft
modifieddraft
modifieddraft
modifieddraft
SimpleDialogDemo;
modifieddraft
modifieddraft
chevron_left
chevron_right
Dialog ()

Dialogs are overlaid modal paper based components with a backdrop.

Properties
NameTypeDefault valueDescription
BackdropProps
object
children
node

Dialog children, usually the included sub-components.

classes
object

Override or extend the styles applied to the component. See CSS API below for more details.

className
string
disableBackdropClick
boolfalse

If true, clicking the backdrop will not fire the onClose callback.

disableEscapeKeyDown
boolfalse

If true, hitting escape will not fire the onClose callback.

fullScreen
boolfalse

If true, the dialog will be full-screen

fullWidth
boolfalse

If true, the dialog stretches to maxWidth.

maxWidth
'xs' | 'sm' | 'md' | 'lg' | 'xl' | false'sm'

Determine the max width of the dialog. The dialog width grows with the size of the screen, this property is useful on the desktop where you might need some coherent different width size across your application. Set to false to disable maxWidth.

onBackdropClick
function

Callback fired when the backdrop is clicked.

onClose
function

The event source of the callback

onEnter
function

Callback fired before the dialog enters.

onEntered
function

Callback fired when the dialog has entered.

onEntering
function

Callback fired when the dialog is entering.

onEscapeKeyDown
function

Callback fired when the escape key is pressed, disableKeyboard is false and the modal is in focus.

onExit
function

Callback fired before the dialog exits.

onExited
function

Callback fired when the dialog has exited.

onExiting
function

Callback fired when the dialog is exiting.

open
bool

If true, the Dialog is open.

PaperComponent
customPaper

The component used to render the body of the dialog.

PaperProps
object

Properties applied to the Paper element.

scroll
'body' | 'paper''paper'

Determine the container for scrolling the dialog.

TransitionComponent
customFade

The component used for the transition.

transitionDuration
number | {"enter":"number","exit":"number"}{ enter: duration.enteringScreen, exit: duration.leavingScreen }

The duration for the transition, in milliseconds. You may specify a single timeout for all transitions, or individually with an object.

TransitionProps
object

Properties applied to the Transition element.