Skip to content

Commit 7e71e6c

Browse files
[material-ui][docs] Add docs for complementary Dialog components (#41313)
Signed-off-by: Sam Sycamore <[email protected]> Co-authored-by: Sam Sycamore <[email protected]>
1 parent 2b41c9a commit 7e71e6c

File tree

1 file changed

+15
-7
lines changed

1 file changed

+15
-7
lines changed

docs/data/material/components/dialogs/dialogs.md

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,18 +17,26 @@ Dialogs are purposefully interruptive, so they should be used sparingly.
1717

1818
{{"component": "modules/components/ComponentLinkHeader.js"}}
1919

20-
## Basic dialog
20+
## Introduction
2121

22-
Simple dialogs can provide additional details or actions about a list item.
23-
For example, they can display avatars, icons, clarifying subtext, or orthogonal actions (such as adding an account).
22+
Dialogs are implemented using a collection of related components:
2423

25-
Touch mechanics:
26-
27-
- Choosing an option immediately commits the option and closes the menu
28-
- Touching outside of the dialog, or pressing Back, cancels the action and closes the dialog
24+
- Dialog: the parent component that renders the modal.
25+
- Dialog Title: a wrapper used for the title of a Dialog.
26+
- Dialog Actions: an optional container for a Dialog's Buttons.
27+
- Dialog Content: an optional container for displaying the Dialog's content.
28+
- Dialog Content Text: a wrapper for text inside of `<DialogContent />`.
29+
- Slide: optional [Transition](https://mui.com/material-ui/transitions/#slide) used to slide the Dialog in from the edge of the screen.
2930

3031
{{"demo": "SimpleDialogDemo.js"}}
3132

33+
## Basics
34+
35+
```jsx
36+
import Dialog from '@mui/material/Dialog';
37+
import DialogTitle from '@mui/material/DialogTitle';
38+
```
39+
3240
## Alerts
3341

3442
Alerts are urgent interruptions, requiring acknowledgement, that inform the user about a situation.

0 commit comments

Comments
 (0)