Skip to content

Commit 3dfc67b

Browse files
committed
Chore(docs): update link items
1 parent 96726d4 commit 3dfc67b

File tree

5 files changed

+23
-17
lines changed

5 files changed

+23
-17
lines changed

README.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,22 @@
11
# Vuejs Dialog
22

3-
| Vue Version | Plugin Version |
4-
|----------|----------------|
5-
| Vue 2 | 1.x |
6-
| Vue 3 | 2.x |
3+
> A lightweight, promise based alert, prompt and confirm dialog.
74
5+
[![npm version](https://badge.fury.io/js/vuejs-dialog.svg)](https://badge.fury.io/js/vuejs-dialog)
6+
[![Build Status](https://travis-ci.org/Godofbrowser/vuejs-dialog.svg?branch=master)](https://travis-ci.org/Godofbrowser/vuejs-dialog)
7+
[![Scrutinizer](https://img.shields.io/scrutinizer/g/Godofbrowser/vuejs-dialog.svg?branch=master)](https://scrutinizer-ci.com/g/Godofbrowser/vuejs-dialog/?branch=master)
8+
[![npm](https://img.shields.io/npm/dt/vuejs-dialog.svg)](https://github.com/Godofbrowser/vuejs-dialog/archive/master.zip)
9+
10+
The content below is for the Vue3 compatible version of vuejs-dialog, you can find the Vue2 compatible version [here](https://github.com/Godofbrowser/vuejs-dialog/tree/v1.x)
11+
12+
| Vue Version | Plugin Version |
13+
|-------------|-----------------------------------------------------------------|
14+
| Vue 2 | [1.x](https://github.com/Godofbrowser/vuejs-dialog/tree/v1.x) |
15+
| Vue 3 | [2.x](https://github.com/Godofbrowser/vuejs-dialog/tree/master) |
816

917
## Recommended IDE Setup
1018

1119
- [Documentation](https://example.com/)
1220
- [Live Demos](https://example.com/)
13-
- Older Vue2 compatible version [here](https://example.com/)
14-
21+
- [2.x](https://github.com/Godofbrowser/vuejs-dialog/tree/master)
22+
- Older Vue2 compatible version [here](https://github.com/Godofbrowser/vuejs-dialog/tree/v1.x)

docs/.vuepress/config.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import {shikiPlugin} from "@vuepress/plugin-shiki";
77
// Ref (default theme): https://ecosystem.vuejs.press/themes/default/markdown.html
88

99
export default defineUserConfig({
10-
title: 'Vuejs Dialog Plugin',
10+
title: 'Vuejs Dialog',
1111
description: 'A lightweight, promise based alert, prompt and confirm dialog',
1212
repo: 'godofbrowser/vuejs-dialog',
1313
bundler: viteBundler(),
@@ -28,7 +28,7 @@ export default defineUserConfig({
2828
'/index.md',
2929
'/features.md',
3030
'/digging-deeper.md',
31-
'/example-use-cases.md',
31+
'/demos.md',
3232
]
3333
}),
3434
})

docs/example-use-cases.md renamed to docs/demos.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Example use cases
1+
# Live Demos
22
Below are some practical example use cases that you may find useful.
33

44
## Quick alert after an event occurs

docs/features.md

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,35 @@
11
# Features
22

3+
[[toc]]
4+
35
## Alert
46
An alert dialog can be triggered using the `$dialog.alert()` method. This method returns a promise which resolves when the dialog is dismissed.
57

68
<UIExamplesWrapper><FeaturesExampleAlert /></UIExamplesWrapper>
79
@[code](components/examples/FeaturesExampleAlert.vue)
810

9-
10-
1111
## Confirm
1212
A confirm dialog can be triggered with the `$dialog.confirm()` method. Like the alert dialog, this method returns a promise which resolves when the dialog is dismissed.
1313
In this section we shall explore how to create a basic confirm dialog as well as the two other variations of the confirm dialog namely; soft and hard confirmation dialogs.
1414

15-
1615
### Basic confirm dialog
1716
<UIExamplesWrapper><FeaturesExampleConfirm /></UIExamplesWrapper>
1817
@[code](components/examples/FeaturesExampleConfirm.vue)
1918

20-
2119
### Soft confirm dialog
2220
<UIExamplesWrapper><FeaturesExampleConfirmSoft /></UIExamplesWrapper>
2321
@[code](components/examples/FeaturesExampleConfirmSoft.vue)
2422

25-
2623
### Hard confirm dialog
2724
<UIExamplesWrapper><FeaturesExampleConfirmHard /></UIExamplesWrapper>
2825
@[code](components/examples/FeaturesExampleConfirmHard.vue)
2926

30-
3127
## Prompt
3228
The `$dialog.prompt()` method creates a prompt dialog. Use the prompt dialog to ask user directly for input.
3329

3430
<UIExamplesWrapper><FeaturesExamplePrompt /></UIExamplesWrapper>
3531
@[code](components/examples/FeaturesExamplePrompt.vue)
3632

37-
38-
3933
## Confirm directive
4034
Add the `v-confirm` directive to any element to instantly cause it to trigger a confirm dialog. This dialog upon confirmation will trigger the default action or the provided callback when available.
4135

docs/index.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,3 +108,7 @@ export default {
108108
<button v-confirm="'Hello world!'">Open dialog</button>
109109
</template>
110110
```
111+
112+
## Typescript support
113+
114+
// Todo:

0 commit comments

Comments
 (0)