-
Notifications
You must be signed in to change notification settings - Fork 94
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Rename 'Getting Started' to 'Installation' and rework confusing infor…
…mation
- Loading branch information
Showing
3 changed files
with
50 additions
and
47 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
# Installation | ||
|
||
Install `vue-final-modal` with your favorite package manager: | ||
|
||
```bash | ||
pnpm add vue-final-modal@next | ||
# or with yarn | ||
yarn add vue-final-modal@next | ||
# or with npm | ||
npm install vue-final-modal@next | ||
``` | ||
|
||
:::tip | ||
`vue-final-modal@next` install Vue Final Modal v3 for Vue 3. If your app is using Vue 2, you need to install Vue Final Modal v2: `vue-final-modal@latest`. | ||
::: | ||
|
||
## Usage | ||
|
||
Here we show the simplest way to use Vue Final Modal: | ||
|
||
```vue | ||
<template> | ||
<button @click="showModal = true"> | ||
show modal | ||
</button> | ||
<VueFinalModal v-model="showModal"> | ||
Modal Content! | ||
</VueFinalModal> | ||
</template> | ||
<script> | ||
import { VueFinalModal } from 'vue-final-modal' | ||
export default { | ||
components: { | ||
VueFinalModal, | ||
}, | ||
setup() { | ||
const showModal = ref(false) | ||
return { showModal } | ||
}, | ||
} | ||
</script> | ||
``` | ||
|
||
There are many more features and use cases for Vue Final Modal. Be sure to browse through all the docs! |