Skip to content

Commit f2a3431

Browse files
committed
udpate docs
1 parent 45baf2a commit f2a3431

File tree

4 files changed

+42
-14
lines changed

4 files changed

+42
-14
lines changed

README.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,6 @@
1919

2020
### 🙌 [Examples](https://hunterliu1003.github.io/vue-final-modal/examples)
2121

22-
### 🌏 [CDN example](https://codepen.io/hunterliu1003/pen/PoZmbPm?editors=1010)
23-
2422
## Introduction
2523

2624
If you need a highly customizable modal component for Vue.js, `Vue Final Modal` would be a nice choice.

docs/content/en/codepen.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Codepen
2+
title: Codepen examples
33
description: 'Vue Final Modal is a renderless, stackable, detachable and lightweight modal component.'
44
position: 5
55
category: Examples

docs/content/en/examples.md

Lines changed: 37 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,51 @@
11
---
2-
title: Advanced
2+
title: Advanced examples
33
description: 'Vue Final Modal is a renderless, stackable, detachable and lightweight modal component.'
44
position: 2
55
category: Examples
66
---
77

8-
<div class="space-y-4">
9-
<base-example></base-example>
10-
<base-example-lock-scroll></base-example-lock-scroll>
11-
<base-example-hide-overlay></base-example-hide-overlay>
12-
<base-example-click-to-close></base-example-click-to-close>
13-
<base-example-prevent-click></base-example-prevent-click>
14-
<base-example-stackable></base-example-stackable>
15-
<base-example-scroll></base-example-scroll>
16-
<base-example-attach></base-example-attach>
17-
</div>
8+
9+
## Simple
10+
11+
<base-example></base-example>
12+
13+
## Set lockScroll to `false`
14+
15+
<base-example-lock-scroll></base-example-lock-scroll>
16+
17+
## Hide overlay
18+
19+
<base-example-hide-overlay></base-example-hide-overlay>
20+
21+
## Click to close
22+
23+
<base-example-click-to-close></base-example-click-to-close>
24+
25+
## Prevent click
26+
27+
<base-example-prevent-click></base-example-prevent-click>
28+
29+
## Stackable
30+
31+
<base-example-stackable></base-example-stackable>
32+
33+
## Scrollable
34+
35+
<base-example-scroll></base-example-scroll>
36+
37+
## Detachable
38+
39+
<base-example-attach></base-example-attach>
40+
1841

1942
## Custom vue-final-modal component
2043

44+
2145
TBD
2246

47+
2348
## Override style
2449

50+
2551
TBD

docs/content/en/index.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,10 @@ const CLASS_TYPES = [String, Object, Array]
117117
- @before-close: Before close
118118
- @closed: After closed
119119

120+
## [See advanced examples](/examples)
121+
122+
## [See codepen examples](/examples)
123+
120124
## Roadmap
121125

122126
If you have any ideas for optimization of `vue-final-modal`, feel free to open [issues](https://github.com/hunterliu1003/vue-final-modal/issues) or [pull request](https://github.com/hunterliu1003/vue-final-modal/pulls).

0 commit comments

Comments
 (0)