youtube-vid
v1.0.0
Published
HTML Custom Element for YouTube videos with a title, icon and an accordion-like UX.
Downloads
25
Maintainers
morganneyReadme
<youtube-vid>
HTML custom element for rendering a YouTube video with a heading, icon and accordion behavior via the native <details> element.
CDN Example
It's simple to get up and started from a CDN. Just drop the <script> element in your page's HTML file and you're all set.
<!doctype html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<title>youtube-vid CDN Demo</title>
<meta name="description" content="HTML custom element for a youtube video." />
<meta
name="viewport"
content="width=device-width, initial-scale=1.0, maximum-scale=2.0"
/>
<link rel="stylesheet" href="https://unpkg.com/youtube-vid/dist/ytvStyles.css" />
<script
type="module"
src="https://unpkg.com/youtube-vid/dist/youtubeVid/defined.js"
></script>
</head>
<body>
<main>
<youtube-vid id="qQIO3pBFfXI" width="50%">
<span slot="icon">🎹</span>
<span slot="title">In Too Deep — Genesis</span>
</youtube-vid>
</main>
</body>
</html>Next.js Example
First install the package.
npm install youtube-vidNow create a page that loads one of the packages exports, ideally the defined subpath to register the custom element with the browser. For example, the page might look like:
'use client'
import { useEffect } from 'react'
import 'youtube-vid/styles'
export default function Page() {
useEffect(() => {
const loadYtv = async () => {
await import('youtube-vid/defined')
}
loadYtv()
}, [])
return (
<youtube-vid id="abc123">
<span slot="icon">🎵</span>
<span slot="title">Video Title</span>
</youtub-vid>
)
}Attributes
You can pass a couple of attributes. The id is required.
idthe id of the YouTube video to load.widththe css width of the element, defaults to100%.
<youtube-vid id="abc123" width="300px">
<span slot="icon">📺</span>
<span slot="title">Video Title</span>
</youtube-vid>