Skip to content

Commit

Permalink
Improve documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Peter Hegman committed Nov 6, 2019
1 parent cf95a7d commit dd1a23b
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ Include using a `<script>` tag

Once the plugin is installed the `v-scroll-lock` directive can be used in any of your components. When the value of the directive is `true` scrolling will be locked on all elements **except** the element the directive is bound to.

Here is an example of how you may implement it in a basic modal. See `src/components/Modal.vue` for a more in depth example.
Here is an example of how you may implement it in a basic modal. Please note the below example is to demonstrate usage of the `v-scroll-lock` directive and is not a complete implementation of a modal. See `src/components/Modal.vue` for a more in depth example.

```vue
<template>
Expand Down

0 comments on commit dd1a23b

Please sign in to comment.