npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

v-body-scroll-lock

v1.1.3

Published

Vue directive for an easy use of the body-scroll-lock library.

Downloads

1,483

Readme

v-body-scroll-lock

A Vue directive to lock the body from scrolling without stopping the target element from scrolling. Uses the body-scroll-lock library (https://github.com/willmcpo/body-scroll-lock). Works on mobile and tablet (iOS, Android) and desktop (Chrome, Firefox, Safari).

Table of Contents

Installation

Yarn

yarn add v-body-scroll-lock

Npm

npm i v-body-scroll-lock --save

How to use

Add v-body-scroll-lock or v-bsl (short version) to the element which you want to keep scrollable. v-body-scroll-lock and v-bsl take a boolean as an argument like v-body-scroll-lock="modalIsOpen" If modalIsOpen is true, body scroll lock will be applied to other elements except for the one which has v-body-scroll-lock="modalIsOpen"

Code

For a more deep example checkout App.vue in /src/App.vue.

<template>
    <div v-body-scroll-lock="modalIsOpen"  
         v-show="modalIsOpen" 
         class="modal">
         <p>This is a modal! I am scrollable while the body is not!</p>
         <button @click="closeModal">Close modal</button>
    </div>
</template>
<script>
export default {
    name: 'modal',
    data() {
        return {
            modalIsOpen: false,   
        }
    },
    methods: {
        closeModal() {
            this.modalIsOpen = false;
        },
        openModal() {
            this.modalIsOpen = true;
        }
    }
}
</script>

Options

reserveScrollBarGap

Reserves the with of the scrollbar and prevents the unpleasant flickering effect that can occur when locking the body scroll. More info here.

To enable the reserveScrollBarGap option add :reserveScrollBarGap after v-body-scroll-lock or v-bsl. Example: v-body-scroll-lock:reserveScrollBarGap="modalIsOpen".

Issues

Issues can be created on the issues page.

Contributing

To contribute, please make a pull request.