Skip to Content

youtube

import "drab/youtube/define";
<drab-youtube uid="gouiY85kD2o">
	<iframe
		data-content
		loading="lazy"
		title="Renegade - Kevin Olusola"
		class="bg-background aspect-video w-full rounded scheme-dark"
	></iframe>
</drab-youtube>

Overview

Defined in: youtube/index.ts:12

Embeds a YouTube video iframe into a website with the video uid, using www.youtube-nocookie.com.

Extends

Constructors

new YouTube()

new YouTube(): YouTube

Defined in: youtube/index.ts:15

Returns

YouTube

Overrides

Base.constructor

Properties

observedAttributes

static observedAttributes: readonly ["autoplay", "start", "uid"]

Defined in: youtube/index.ts:13

Accessors

autoplay

Get Signature

get autoplay(): boolean

Defined in: youtube/index.ts:25

Whether the video should start playing when loaded.

Returns

boolean

Set Signature

set autoplay(value): void

Defined in: youtube/index.ts:29

Parameters
value

boolean

Returns

void


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

Base.event


iframe

Get Signature

get iframe(): HTMLIFrameElement

Defined in: youtube/index.ts:20

The HTMLIFrameElement within the element.

Returns

HTMLIFrameElement


start

Get Signature

get start(): string

Defined in: youtube/index.ts:35

The start time of the video (seconds).

Returns

string

Set Signature

set start(value): void

Defined in: youtube/index.ts:39

Parameters
value

string

Returns

void


uid

Get Signature

get uid(): string

Defined in: youtube/index.ts:49

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".

Returns

string

Set Signature

set uid(v): void

Defined in: youtube/index.ts:55

Parameters
v

string

Returns

void

Methods

announce()

announce(message): void

Defined in: base/index.ts:53

Parameters

message

string

message to announce to screen readers

Returns

void

Inherited from

Base.announce


attributeChangedCallback()

attributeChangedCallback(): void

Defined in: youtube/index.ts:65

Returns

void


connectedCallback()

connectedCallback(): void

Defined in: base/index.ts:171

Called when custom element is added to the page.

Returns

void

Inherited from

Base.connectedCallback


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

Base.destroy


disconnectedCallback()

disconnectedCallback(): void

Defined in: base/index.ts:181

Called when custom element is removed from the page.

Returns

void

Inherited from

Base.disconnectedCallback


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

Base.getContent


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

Base.getTrigger


mount()

mount(): void

Defined in: youtube/index.ts:59

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

Base.mount


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

Base.safeListener


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

Base.swapContent


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

Inherited from

Base.triggerListener