Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Docs: Add deprecation section on Dialog to use Dialog2 #1714

Merged
merged 4 commits into from
Dec 16, 2021
Merged

Docs: Add deprecation section on Dialog to use Dialog2 #1714

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a7a3c3f
Add deprecation block in docs
siddharthkp Dec 10, 2021
cd09d37
Merge branch 'main' into siddharth/dialog-deprecated-alternative
siddharthkp Dec 10, 2021
562253b
Merge branch 'main' into siddharth/dialog-deprecated-alternative
siddharthkp Dec 13, 2021
a6197bd
Merge branch 'main' into siddharth/dialog-deprecated-alternative
colebemis Dec 16, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions docs/content/deprecated/Dialog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,42 @@ title: Dialog
status: Deprecated
---

## Deprecation

Use [Dialog2](/Dialog2) instead.

**Before**

```jsx
<Dialog isOpen={open} onDismiss={() => setOpen(false)} aria-labelledby="header-id">
<Dialog.Header id="header-id">Title</Dialog.Header>
<Box p={3}>
<Text fontFamily="sans-serif">Some content</Text>
</Box>
</Dialog>
```

**After**

```jsx
{
open && (
<Dialog2
title="Dialog example"
subtitle={
<>
This is a <b>description</b> of the dialog.
</>
}
footerButtons={[{content: 'Ok', onClick: () => setOpen(false)}]}
onClose={() => setOpen(false)}
>
<Text fontFamily="sans-serif">Some content</Text>
</Dialog2>
)
}
```

import State from '../../components/State'

The dialog component is used for all modals. It renders on top of the rest of the app with an overlay.
Expand Down