intersect
Scroll down, when part of this trigger moves out of the viewport, the
data-intersect
attribute will be removed and the color will change to black.
import "drab/intersect/define";
<drab-intersect threshold="1" class="flex flex-col items-center gap-10">
<div
data-trigger
class="flex min-h-48 items-center justify-center rounded-md border p-6 shadow"
>
<p>
Scroll down, when part of this trigger moves out of the viewport, the
<code>data-intersect</code>
attribute will be removed and the color will change to black.
</p>
</div>
<div
data-content
class="bg-primary data-intersect:bg-destructive size-48 rounded-full"
></div>
</drab-intersect>
Overview
Defined in: intersect/index.ts:16
Uses the Intersection Observer API to add a data-intersect
attribute to content
when the trigger
is intersecting.
Use onIntersect
and onExit
to customize further with JavaScript.
threshold
Specify a threshold
between 0
and 1
to determine how much of the trigger
should be visible for the intersection to occur.
Extends
Constructors
new Intersect()
new Intersect():
Intersect
Defined in: intersect/index.ts:23
Returns
Overrides
Accessors
event
Get Signature
get event(): keyof
HTMLElementEventMap
Defined in: base/index.ts:42
Event for the trigger
to execute.
For example, set to "mouseover"
to execute the event when the user hovers the mouse over the trigger
, instead of when they click it.
Default
"click";
Returns
keyof HTMLElementEventMap
Set Signature
set event(
value
):void
Defined in: base/index.ts:46
Parameters
value
keyof HTMLElementEventMap
Returns
void
Inherited from
Methods
announce()
announce(
message
):void
Defined in: base/index.ts:53
Parameters
message
string
message to announce to screen readers
Returns
void
Inherited from
connectedCallback()
connectedCallback():
void
Defined in: base/index.ts:171
Called when custom element is added to the page.
Returns
void
Inherited from
destroy()
destroy():
void
Defined in: base/index.ts:178
Passed into disconnectedCallback
, since Base
needs to run disconnectedCallback
as well. It is overridden in each element that needs to run disconnectedCallback
.
Returns
void
Inherited from
disconnectedCallback()
disconnectedCallback():
void
Defined in: base/index.ts:181
Called when custom element is removed from the page.
Returns
void
Inherited from
getContent()
getContent<
T
>(instance
):T
Defined in: base/index.ts:74
Type Parameters
• T extends HTMLElement
= HTMLElement
Parameters
instance
() => T
The instance of the desired element to validate against,
ex: HTMLDialogElement
. Defaults to HTMLElement
.
Returns
T
The element that matches the content
selector.
Default
this.querySelector("[data-content]");
Inherited from
getTrigger()
getTrigger<
T
>():NodeListOf
<T
>
Defined in: base/index.ts:61
Type Parameters
• T extends HTMLElement
= HTMLElement
Returns
NodeListOf
<T
>
All of the elements that match the trigger
selector.
Default
this.querySelectorAll("[data-trigger]");
Inherited from
mount()
mount():
void
Defined in: intersect/index.ts:50
Passed into queueMicrotask
in connectedCallback
. It is overridden in each component that needs to run connectedCallback
.
The reason for this is to make these elements work better with frameworks like Svelte. For SSR this isn’t necessary, but when client side rendering, the HTML within the custom element isn’t available before connectedCallback
is called. By waiting until the next microtask, the HTML content is available—then for example, listeners can be attached to elements inside.
Returns
void
Overrides
onExit()
onExit(
callback
):void
Defined in: intersect/index.ts:46
Parameters
callback
IntersectCallback
Runs when trigger
exits.
Returns
void
onIntersect()
onIntersect(
callback
):void
Defined in: intersect/index.ts:39
Parameters
callback
IntersectCallback
Runs when trigger
intersects.
Returns
void
safeListener()
safeListener<
K
,T
>(type
,listener
,element
,options
):void
Defined in: base/index.ts:136
Wrapper around document.body.addEventListener
that ensures when the
element is removed from the DOM, these event listeners are cleaned up.
Type Parameters
• K extends keyof DocumentEventMap
• T extends HTMLElement
| Document
| Window
= HTMLElement
Parameters
type
K
listener
(this
, ev
) => any
element
T
= ...
options
AddEventListenerOptions
= {}
Returns
void
Inherited from
swapContent()
swapContent(
revert
):void
Defined in: base/index.ts:93
Finds the HTMLElement | HTMLTemplateElement
via the swap
selector and
swaps this.content()
with the content of the element found.
Parameters
revert
Wait time (ms) before swapping back, set to false
to not revert.
default: 800
number
| false
Returns
void
Inherited from
triggerListener()
triggerListener<
T
,K
>(listener
,type
,options
?):void
Defined in: base/index.ts:153
Type Parameters
• T extends HTMLElement
• K extends keyof HTMLElementEventMap
Parameters
listener
(this
, e
) => any
Listener to attach to all of the trigger
elements.
type
K
= ...
options?
AddEventListenerOptions
Returns
void