Skip to content

Support toggle feature #2

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
elalemanyo wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Support toggle feature #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6cdffe2
Add toggle option to ScrollReveal for conditional unobserving
elalemanyo Oct 26, 2024
aa79865
Add toggle attribute for ScrollReveal component
elalemanyo Oct 26, 2024
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
2 changes: 1 addition & 1 deletion components/scroll-reveal/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@

<div class="h-screen"></div>

<div data-controller="scroll-reveal" data-scroll-reveal-threshold-value="0.9">
<div data-controller="scroll-reveal" data-scroll-reveal-threshold-value="0.9" data-scroll-reveal-toggle-value="true">
<p data-scroll-reveal-target="item" class="reveal">With custom</p>
<p data-scroll-reveal-target="item" class="reveal">options!</p>
</div>
Expand Down
19 changes: 15 additions & 4 deletions components/scroll-reveal/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,19 @@ interface Option {
class?: string
threshold?: number
rootMargin?: string
toggle?: boolean
}

export default class ScrollReveal extends Controller {
declare classValue: string
declare thresholdValue: number
declare rootMarginValue: string
declare toggleValue: boolean

declare class: string
declare threshold: number
declare rootMargin: string
declare toggle: boolean
declare observer: IntersectionObserver

declare readonly itemTargets: HTMLElement[]
Expand All @@ -23,6 +26,7 @@ export default class ScrollReveal extends Controller {
class: String,
threshold: Number,
rootMargin: String,
toggle: Boolean,
}

initialize(): void {
Expand All @@ -33,6 +37,7 @@ export default class ScrollReveal extends Controller {
this.class = this.classValue || this.defaultOptions.class || "in"
this.threshold = this.thresholdValue || this.defaultOptions.threshold || 0.1
this.rootMargin = this.rootMarginValue || this.defaultOptions.rootMargin || "0px"
this.toggle = this.toggleValue || this.defaultOptions.toggle || false

this.observer = new IntersectionObserver(this.intersectionObserverCallback, this.intersectionObserverOptions)
this.itemTargets.forEach((item) => this.observer.observe(item))
Expand All @@ -42,17 +47,23 @@ export default class ScrollReveal extends Controller {
this.itemTargets.forEach((item) => this.observer.unobserve(item))
}

intersectionObserverCallback(entries: IntersectionObserverEntry[], observer: IntersectionObserver): void {
entries.forEach((entry) => {
intersectionObserverCallback (entries: IntersectionObserverEntry[], observer: IntersectionObserver): void {
entries.forEach(entry => {
const target = entry.target as HTMLElement
if (entry.intersectionRatio > this.threshold) {
const target = entry.target as HTMLElement
target.classList.add(...this.class.split(" "))

if (target.dataset.delay) {
target.style.transitionDelay = target.dataset.delay
}

observer.unobserve(target)
if (!this.toggle) {
observer.unobserve(target)
}
}

if (this.toggle && (entry.intersectionRatio < this.threshold || !entry.isIntersecting)) {
target.classList.remove(...this.class.split(' '))
}
})
}
Expand Down