animate
<script type="module">
const animate = document.querySelector("drab-animate");
animate.triggerListener(() => animate.animateElement());
</script>
<drab-animate
animation-keyframe-from-transform="scale(1)"
animation-keyframe-50-transform="scale(0)"
animation-keyframe-to-transform="scale(1)"
animation-option-duration="1000"
animation-option-delay="100"
animation-option-easing="ease-in"
>
<button data-trigger type="button" class="button button-primary">
Animate
</button>
<div class="flex h-56 items-center justify-center pt-12">
<span data-content class="size-32 rounded-full bg-rose-700"></span>
</div>
</drab-animate>
Overview
The Animate base class provides a declarative way to use the Web Animations API through HTML attributes. The animateElement method uses these attributes and persists the final animation state. Other elements in drab extend this class to provide animations. You can also extend this class to create your own custom animated element.
Keyframes can be set via HTML attributes on the element in the form of:
<drab-animate animation-keyframe-offset-property="value"></drab-animate>
offset can be to, from, or a number.
property can be any animatable CSS property separated by dashes.
Animations options can be set:
<drab-animate animation-option-property="value"></drab-animate>
property can be duration, delay, or easing.
Hierarchy
↳
Animate↳↳
ContextMenu↳↳
Details↳↳
Dialog↳↳
Popover
Constructors
constructor
• new Animate(): Animate
Returns
Overrides
Defined in
src/package/animate/index.ts:39
Properties
#listenerController
• Private #listenerController: AbortController
To clean up event listeners added to document when the element is removed.
Inherited from
Defined in
Accessors
animationOptions
• get animationOptions(): KeyframeAnimationOptions
Returns
KeyframeAnimationOptions
An object containing the values of each animation-option attribute
Defined in
src/package/animate/index.ts:46
event
• get event(): keyof HTMLElementEventMap
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.
Returns
keyof HTMLElementEventMap
Default
"click";
Inherited from
Base.event
Defined in
• set event(value): void
Parameters
| Name | Type |
|---|---|
value | keyof HTMLElementEventMap |
Returns
void
Inherited from
Base.event
Defined in
keyframes
• get keyframes(): Keyframe[]
Returns
Keyframe[]
Defined in
src/package/animate/index.ts:128
Methods
animateElement
▸ animateElement(animateOptions?): Promise<void>
Parameters
| Name | Type | Description |
|---|---|---|
animateOptions | Object | animates this.content() by default |
animateOptions.element? | HTMLElement | - |
animateOptions.options? | KeyframeAnimationOptions | - |
Returns
Promise<void>
Description
Animates a particular element using the web animations API.
- Disables animation if the user prefers reduced motion.
- Sets default options
- Uses the keyframes provided from
this.keyframes - Waits for the animation to complete
- Sets the start and end styles based on the first and last keyframe
Defined in
src/package/animate/index.ts:76
connectedCallback
▸ connectedCallback(): void
Returns
void
Inherited from
Defined in
destroy
▸ destroy(): void
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
Defined in
disconnectedCallback
▸ disconnectedCallback(): void
Returns
void
Inherited from
Defined in
getContent
▸ getContent<T>(instance?): T
Type parameters
| Name | Type |
|---|---|
T | extends HTMLElement = HTMLElement |
Parameters
| Name | Type | Description |
|---|---|---|
instance | () => T | The instance of the desired element, ex: HTMLDialogElement. Defaults to HTMLElement. |
Returns
T
The element that matches the content selector.
Default
this.querySelector("[data-content]");
Inherited from
Defined in
getTrigger
▸ getTrigger<T>(): NodeListOf<T>
Type parameters
| Name | Type |
|---|---|
T | extends HTMLElement = HTMLElement |
Returns
NodeListOf<T>
All of the elements that match the trigger selector.
Default
this.querySelectorAll("[data-trigger]");
Inherited from
Defined in
mount
▸ mount(): void
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
Inherited from
Defined in
safeListener
▸ safeListener<K, T>(type, listener, element?, options?): void
Wrapper around document.body.addEventListener that ensures when the element is removed from the DOM, these event listeners are cleaned up.
Type parameters
| Name | Type |
|---|---|
K | extends keyof DocumentEventMap |
T | extends Window | Document | HTMLElement = HTMLElement |
Parameters
| Name | Type |
|---|---|
type | K |
listener | (this: T, ev: DocumentEventMap[K]) => any |
element | T |
options | AddEventListenerOptions |
Returns
void
Inherited from
Defined in
swapContent
▸ swapContent(revert?, delay?): void
Finds the HTMLElement | HTMLTemplateElement via the swap selector and swaps this.content() with the content of the element found.
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
revert | boolean | true | Swap back to old content |
delay | number | 800 | Wait time before swapping back |
Returns
void
Inherited from
Defined in
triggerListener
▸ triggerListener<T, K>(listener, type?, options?): void
Type parameters
| Name | Type |
|---|---|
T | extends HTMLElement |
K | extends keyof HTMLElementEventMap |
Parameters
| Name | Type | Description |
|---|---|---|
listener | (this: T, e: HTMLElementEventMap[K]) => any | Listener to attach to all of the trigger elements. |
type | K | - |
options? | AddEventListenerOptions | - |
Returns
void