Skip to content

Commit ad84e81

Browse files
committed
Update README.md
1 parent cf3677d commit ad84e81

File tree

1 file changed

+15
-7
lines changed

1 file changed

+15
-7
lines changed

README.md

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,14 @@
11
# Vuetify 3 Dialog
22
Lite Vue plugin working with Vuetify, allowing you to show dialogs or snackbars programatically.
33

4+
## Summary
5+
- [Installation](#install-it)
6+
- [Usage](#usage)
7+
- [Dialogs](#dialogs)
8+
- [Snackbars](#snackbars)
9+
- [SFC compatibility](#sfc-compatibility)
10+
- [Developers](#developers)
11+
412
## Install it
513
First, run `npm install vuetify3-dialog`.
614
**⚠️You must have Vuetify installed on your project. If you don't have installed yet, please follow this link : [Install Vuetify](https://vuetifyjs.com/en/getting-started/installation/)**
@@ -34,12 +42,11 @@ this.$dialog.create({
3442
title: "My title",
3543
text: "My dialog message",
3644
buttons: [
37-
{ title: 'My first button', key: 'button1' },
38-
{ title: 'My second button', key: 'button2' },
39-
{ title: 'My third button', key: 'button3' },
45+
{ title: 'My first button', key: 'button1', /* any v-btn api option */ },
46+
...
4047
],
4148
cardOptions: {
42-
//any v-card api option
49+
//any v-card api options
4350
}
4451
}).then((anwser) => {
4552
//Do something with the anwser corresponding to the key of the clicked button
@@ -59,7 +66,8 @@ You can also create a simple dialog with a message and a title, by precizing lev
5966
this.$dialog.info(
6067
"My dialog message",
6168
"My title", //optional
62-
{ width: '500px'} //optional v-card api option
69+
{ width: '500px'} //optional v-card api options,
70+
{ variant: 'outlined' } //optional v-btn api options
6371
).then(() => {
6472
//Do something when the user close the dialog
6573
})
@@ -79,7 +87,7 @@ this.$notify.create({
7987
level: 'success',
8088
location: 'top right',
8189
notifyOptions: {
82-
//any v-snackbar api option
90+
//any v-snackbar api options
8391
}
8492
})
8593
.then(() => {
@@ -91,7 +99,7 @@ You can also create a simple snackbar with a message and a title, by precizing l
9199
```js
92100
this.$notify.info(
93101
"My snackbar message",
94-
{ variant: 'outlined' } // any v-snackbar api option
102+
{ variant: 'outlined' } // any v-snackbar api options
95103
).then(() => {
96104
//Do something when the user close the snackbar
97105
})

0 commit comments

Comments
 (0)