Dialog

Source@react-form-builder/components-material-ui

Introduction

The Dialog component creates modal overlay windows that prompt users to make decisions, enter information, or acknowledge important messages. Dialogs are essential for creating focused user interactions without navigating away from the current context. The component follows Material Design dialog guidelines with proper elevation, transitions, and accessibility features.

The Dialog component is based on Material UI Dialog. It is included within the following NPM package: @react-form-builder/components-material-ui.

The Dialog component can be configured to create various dialog types including alerts, confirmations, forms, and custom content displays. It can be styled and customized to fit specific design and functionality requirements by using various properties that are presented and described below.

Main properties

The following general properties are available within the Main tab:

Name	Type	Description	Default
Open	boolean	Controls whether the dialog is visible	false
Full screen	boolean	If true, the dialog will be full screen	-
Full width	boolean	If true, the dialog stretches to its maximum width	false
Max width	'xs' | 'sm' | 'md' | 'lg' | 'xl'	Maximum width of the dialog	'md'
Scroll	'paper' | 'body'	Determines the scroll container for the dialog content	'paper'
Disable escape key down	boolean	If true, pressing the escape key will not close the dialog	-
On close	event	Event handler triggered when the dialog closes	-

At the bottom of the Main properties menu, you can find additional options:

• Render When: Provides conditional rendering for your component as described in the corresponding chapter.
• HTML attributes: Allows you to provide custom HTML attributes for your form.

Style properties

These are properties that allow to customize the size, color and other style properties of your component:

• For Device: You can provide component's style customization for all devices or specific devices by using this dropdown list. Refer to Adaptive Layout for more details.

• Component > Class Name: Add a class name for your component for the subsequent styling if necessary.

• Wrapper: The options below enable you to tailor the appearance of your component and customize it for a specific device type, as selected in the For Device property:

  Name	Type	Description
  Width	number	Specifies the width for your component
  Height	number	Specifies the height for your component
  Margin top/right/bottom/left	number	Margin values for you component
  Color	string	Allows customizing the text color
  Background color	string	Enables customizing the background color