youtube
<drab-youtube uid="gouiY85kD2o">
<iframe
data-content
loading="lazy"
title="Renegade - Kevin Olusola"
class="aspect-video w-full rounded"
></iframe>
</drab-youtube>
Overview
Embeds a YouTube video iframe into a website with the video uid, using www.youtube-nocookie.com.
Extends
Constructors
new YouTube()
new YouTube():
YouTube
Returns
Overrides
Source
src/package/youtube/index.ts:12
Properties
#listenerController
private
#listenerController:AbortController
To clean up event listeners added to document
when the element is removed.
Inherited from
Source
observedAttributes
static
observedAttributes: readonly ["autoplay"
,"start"
,"uid"
]
Source
src/package/youtube/index.ts:10
Accessors
autoplay
get
autoplay():boolean
Whether the video should start playing when loaded.
set
autoplay(value
):void
Parameters
• value: boolean
Returns
boolean
Source
src/package/youtube/index.ts:22
event
get
event(): keyofHTMLElementEventMap
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";
set
event(value
):void
Parameters
• value: keyof HTMLElementEventMap
Returns
keyof HTMLElementEventMap
Source
iframe
get
iframe():HTMLIFrameElement
The HTMLIFrameElement
within the element.
Returns
HTMLIFrameElement
Source
src/package/youtube/index.ts:17
start
get
start():string
The start time of the video (seconds).
set
start(value
):void
Parameters
• value: string
Returns
string
Source
src/package/youtube/index.ts:32
uid
get
uid():string
The video’s YouTube uid, found within the url of the video.
For example if the video url is https://youtu.be/gouiY85kD2o, the uid
is "gouiY85kD2o"
.
set
uid(v
):void
Parameters
• v: string
Returns
string
Source
src/package/youtube/index.ts:46
Methods
attributeChangedCallback()
attributeChangedCallback():
void
Returns
void
Source
src/package/youtube/index.ts:62
connectedCallback()
connectedCallback():
void
Called when custom element is added to the page.
Returns
void
Inherited from
Source
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
Source
disconnectedCallback()
disconnectedCallback():
void
Called when custom element is removed from the page.
Returns
void
Inherited from
Source
getContent()
getContent<
T
>(instance
):T
Type parameters
• T extends HTMLElement
= HTMLElement
Parameters
• instance= undefined
The instance of the desired element, ex: HTMLDialogElement
. Defaults to HTMLElement
.
Returns
T
The element that matches the content
selector.
Inherited from
Default
this.querySelector("[data-content]");
Source
getTrigger()
getTrigger<
T
>():NodeListOf
<T
>
Type parameters
• T extends HTMLElement
= HTMLElement
Returns
NodeListOf
<T
>
All of the elements that match the trigger
selector.
Inherited from
Default
this.querySelectorAll("[data-trigger]");
Source
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
Overrides
Source
src/package/youtube/index.ts:56
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
• K extends keyof DocumentEventMap
• T extends Window
| Document
| HTMLElement
= HTMLElement
Parameters
• type: K
• listener
• element: T
= undefined
• options: AddEventListenerOptions
= {}
Returns
void
Inherited from
Source
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
• revert: boolean
= true
Swap back to old content
• delay: number
= 800
Wait time before swapping back
Returns
void
Inherited from
Source
triggerListener()
triggerListener<
T
,K
>(listener
,type
,options
?):void
Type parameters
• T extends HTMLElement
• K extends keyof HTMLElementEventMap
Parameters
• listener
Listener to attach to all of the trigger
elements.
• type: K
= undefined
• options?: AddEventListenerOptions
Returns
void