Skip to content

Commit 702f29a

Browse files
committed
add gif preview to readme and mention features
1 parent ac493e5 commit 702f29a

File tree

1 file changed

+13
-3
lines changed

1 file changed

+13
-3
lines changed

README.md

+13-3
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,20 @@ Two modal component with transitions using Vue's teleport feature.
44

55
Created using [Vue 3](https://vuejs.org/) and [PicoCSS](https://picocss.com/) which is a CSS framework based on Semantic HTML5 with accessibility in mind.
66

7-
## Benefits of teleport
7+
## Features
8+
9+
- Both modal components can be closed by **clicking outside** of the modal-box
10+
- Shows aria-busy loading indicator when clicking on `Show Modal` button
11+
- In Firefox browsers, *backdrop* filter will not work until they implement this CSS property
12+
- It is accessible and has semantic tags
13+
- Minimal styles and works without [PicoCSS](https://picocss.com/)
14+
15+
> Closing modal by pressing **escape** key is the next feature that I will add
16+
17+
![Preview](./screenshot/Vue-Modal-Component.gif)
18+
19+
## Benefits of Teleport (Vue 3 feature)
820

921
Teleport makes sure modal is the closed element in terms of depth because it is injected to just before the body end tag.
1022

1123
Compare *BaseModal* component with *TeleportModal*; when clicking on `Show Modal` button, **aria-busy loading** indicator is awefully visible on *BaseModal*. But on *TeleportModal* thanks to Vue's Teleport feature, `Show Modal` button loading will be rendered behind the `modal-wrapper` since it has a backdrop filter (blur) effect, so there is no unexpected behaviour.
12-
13-
<!-- ![Preview](./screenshot/Vue-Modal-Component.gif) -->

0 commit comments

Comments
 (0)