Skip to content

Create modal.mdx #21

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

Closed
pruthvi2103 wants to merge 6 commits into from
Closed

Create modal.mdx #21

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
fe6113c
Create modal.mdx
pruthvi2103 Jul 18, 2022
5d46ac2
Squashed commit of the following:
pruthvi2103 Aug 13, 2022
1b68153
Merge remote-tracking branch 'upstream/main'
pruthvi2103 Aug 17, 2022
5ffcd92
Merge remote-tracking branch 'upstream/main'
pruthvi2103 Aug 23, 2022
a98b120
Merge branch 'main' into modal/spec
pruthvi2103 Aug 23, 2022
266c0d8
Update modal.mdx
pruthvi2103 Aug 23, 2022
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
22 changes: 22 additions & 0 deletions docs/docs/components/modal.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Modal (Spec)

## Notes

- use Create Portal for Markup
- Proper settings to control the trigger
- Proper way to adjust size, position, etc.
- Overlay Customization and option to not show it
- Lock scroll when modal is visible
- Close on ClickOutside
- Close on EscapeKey
- use `<dialog>` element instead of `<div>`

| Attributes | Values | Optional ? |
| :-------------------- | :------------------: | ---------: |
| `isOpen` | boolean (true/false) | No |
| `onClose` | function | Yes |
| `onOpen` | function | Yes |
| `size` | string | Yes |
| `showOverlay` | boolean | Yes |
| `closeOnOutsideClick` | boolean | Yes |
| `overlayStyles` | Style Object | Yes |