Skip to content

feat: compatible with vue3 and vue2 #260

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

feat: compatible with vue3 and vue2 #260

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 27 additions & 19 deletions cypress/integration/index.spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,31 +1,39 @@
/// <reference types="cypress" />

var routes = ['/', '/vue3.html']

describe('vue observe visibility', () => {
it('detects visibility when scrolling', () => {
cy.visit('/')
cy.get('[id="is-visible"]').should('not.be.checked')
cy.get('.test').scrollIntoView()
cy.get('[id="is-visible"]').should('be.checked')
cy.get('.info').scrollIntoView()
cy.get('[id="is-visible"]').should('not.be.checked')
for (var i = 0; i < routes.length; i++) {
cy.visit(routes[i])
cy.get('[id="is-visible"]').should('not.be.checked')
cy.get('.test').scrollIntoView()
cy.get('[id="is-visible"]').should('be.checked')
cy.get('.info').scrollIntoView()
cy.get('[id="is-visible"]').should('not.be.checked')
}
})

it('detects visibility when toggling the element', () => {
cy.visit('/')
cy.get('.test').scrollIntoView()
cy.get('[id="is-visible"]').should('be.checked')
cy.get('.toggle').click()
cy.get('.test').should('not.be.visible')
cy.get('[id="is-visible"]').should('not.be.checked')
cy.get('.toggle').click()
cy.get('.test').should('be.visible')
cy.get('[id="is-visible"]').should('be.checked')
for (var i = 0; i < routes.length; i++) {
cy.visit(routes[i])
cy.get('.test').scrollIntoView()
cy.get('[id="is-visible"]').should('be.checked')
cy.get('.toggle').click()
cy.get('.test').should('not.be.visible')
cy.get('[id="is-visible"]').should('not.be.checked')
cy.get('.toggle').click()
cy.get('.test').should('be.visible')
cy.get('[id="is-visible"]').should('be.checked')
}
})

it('can be disabled', () => {
cy.visit('/')
cy.get('[id="disabled"]').click().should('be.checked')
cy.get('.test').scrollIntoView()
cy.get('[id="is-visible"]').should('not.be.checked')
for (var i = 0; i < routes.length; i++) {
cy.visit(routes[i])
cy.get('[id="disabled"]').click().should('be.checked')
cy.get('.test').scrollIntoView()
cy.get('[id="is-visible"]').should('not.be.checked')
}
})
})
8 changes: 8 additions & 0 deletions src/directives/observe-visibility.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,8 +113,16 @@ function unbind (el) {
}
}

function beforeMount (el, binding, vnode) {
vnode.context = binding.instance
bind(el, binding, vnode)
}

export default {
bind,
update,
unbind,
/* vue3 support */
beforeMount,
unmounted: unbind,
}
2 changes: 1 addition & 1 deletion src/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,6 @@ if (typeof window !== 'undefined') {
} else if (typeof global !== 'undefined') {
GlobalVue = global.Vue
}
if (GlobalVue) {
if (GlobalVue && typeof GlobalVue.version === 'string' && GlobalVue.version[0] === '2') {
GlobalVue.use(plugin)
}
169 changes: 169 additions & 0 deletions vue3.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,169 @@
<html>

<head>
<style>
body {
font-family: sans-serif;
}

#app {
padding: 100px;
}

.toolbar {
position: fixed;
bottom: 12px;
left: 0;
width: 100%;
}

.toolbar .wrapper {
background: white;
padding: 12px;
border-radius: 3px;
box-shadow: 0 5px 20px rgba(0, 0, 0, 0.07);
display: flex;
align-items: center;
border: #eee 1px solid;
}

.toolbar .wrapper>*:not(:last-child) {
margin-right: 6px;
}

.separator {
margin: 0 12px;
}

.info {
color: #eee;
}

.test {
background: #eee;
height: 100%;
border-radius: 3px;
flex-direction: column;
}

.info,
.test {
font-size: 42px;
}

.test-wrapper {
margin: 3000px 0;
height: 400px;
}

.toolbar,
.info,
.test {
display: flex;
align-items: center;
justify-content: center;
}

input[type="number"] {
width: 90px;
}

.number {
display: inline-block;
width: 40px;
font-family: monospace;
text-align: center;
background: #eee;
border-radius: 3px;
padding: 4px 0;
}
</style>
</head>

<body>
<div id="app">
<div class="toolbar">
<div class="wrapper">
<input id="is-visible" type="checkbox" v-model="isVisible" disabled>
<label for="is-visible">Is visible?</label>

<input id="disabled" type="checkbox" v-model="disabled">
<label for="disabled">Disable</label>

<span class="separator"></span>

<button class="toggle" @click="show = !show">Toggle</button>

<span class="separator"></span>

<label for="throttle">Throttle</label>
<input id="throttle" type="number" v-model="throttle" min="0" step="100">

<input id="throttle-leading-visible" type="checkbox" v-model="leadingVisible">
<label for="throttle-leading-visible">Leading (Visible)</label>
<input id="throttle-leading-hidden" type="checkbox" v-model="leadingHidden">
<label for="throttle-leading-hidden">Leading (Hidden)</label>

<span class="separator"></span>

<label for="threshold">Threshold</label>
<span class="number">{{ threshold }}</span>
<input type="range" v-model="threshold" min="0" max="1" step="0.01">
<input id="once" type="checkbox" v-model="once">
<label for="once">Once</label>
</div>
</div>

<div class="info">Scroll down</div>
<div class="test-wrapper">
<div v-show="show" ref="test" class="test" v-observe-visibility="disabled ? false : {
callback: visibilityChanged,
throttle,
throttleOptions: {
leading: leadingVisible && leadingHidden ? 'both' : leadingVisible ? 'visible' : leadingHidden ? 'hidden' : false,
},
intersection: {
threshold,
},
once,
}">
<div v-for="n in count">Hello world!</div>
</div>
</div>
</div>


<script src="https://unpkg.com/vue@3.5.12/dist/vue.global.js"></script>
<script src="./dist/vue-observe-visibility.min.js"></script>
<script>
// App
const app = Vue.createApp({
data() {
return {
show: true,
isVisible: true,
throttle: 0,
leadingVisible: false,
leadingHidden: false,
threshold: 0,
count: 1,
once: false,
disabled: false,
}
},
methods: {
visibilityChanged: function (isVisible, entry) {
this.isVisible = isVisible
this.count++
console.log('is visible:', isVisible, 'intersection:', Math.round(entry.intersectionRatio * 100) + '%')
}
}
})

app.use(VueObserveVisibility)

app.mount('#app')
</script>
</body>

</html>