feat(site): add pip button api reference

closes #530
This commit is contained in:
Darius Cepulis
2026-02-13 09:02:53 -06:00
parent 7efee3d033
commit 8bc76dac9c
10 changed files with 184 additions and 6 deletions
@@ -0,0 +1,10 @@
---
import HtmlDemo from '@/components/docs/demos/HtmlDemo.astro';
import html from './BasicUsage.html?raw';
import './BasicUsage.css';
---
<HtmlDemo html={html} />
<script>
import './BasicUsage.ts';
</script>
@@ -0,0 +1,35 @@
.pip-button-basic {
display: block;
position: relative;
}
.pip-button-basic video {
width: 100%;
}
.pip-button-basic__button {
padding-block: 8px;
position: absolute;
bottom: 10px;
right: 10px;
background: rgba(255, 255, 255, 0.7);
backdrop-filter: blur(10px);
color: black;
border: 1px solid rgba(255, 255, 255, 0.3);
border-radius: 9999px;
padding-inline: 20px;
cursor: pointer;
}
.pip-button-basic__button .show-when-pip {
display: none;
}
.pip-button-basic__button .show-when-not-pip {
display: none;
}
.pip-button-basic__button[data-pip] .show-when-pip {
display: inline;
}
.pip-button-basic__button:not([data-pip]) .show-when-not-pip {
display: inline;
}
@@ -0,0 +1,13 @@
<video-player class="pip-button-basic">
<video
src="https://stream.mux.com/lhnU49l1VGi3zrTAZhDm9LUUxSjpaPW9BL4jY25Kwo4/highest.mp4"
autoplay
muted
playsinline
loop
></video>
<media-pip-button class="pip-button-basic__button">
<span class="show-when-pip">Exit PiP</span>
<span class="show-when-not-pip">Enter PiP</span>
</media-pip-button>
</video-player>
@@ -0,0 +1,2 @@
import '@videojs/html/video/player';
import '@videojs/html/ui/pip-button';
@@ -0,0 +1,21 @@
.pip-button-basic {
position: relative;
}
.pip-button-basic video {
width: 100%;
}
.pip-button-basic__button {
padding-block: 8px;
position: absolute;
bottom: 10px;
right: 10px;
background: rgba(255, 255, 255, 0.7);
backdrop-filter: blur(10px);
color: black;
border: 1px solid rgba(255, 255, 255, 0.3);
border-radius: 9999px;
padding-inline: 20px;
cursor: pointer;
}
@@ -0,0 +1,25 @@
import { createPlayer, features, PiPButton, Video } from '@videojs/react';
import './BasicUsage.css';
const Player = createPlayer({ features: [...features.video] });
export default function BasicUsage() {
return (
<Player.Provider>
<Player.Container className="pip-button-basic">
<Video
src="https://stream.mux.com/lhnU49l1VGi3zrTAZhDm9LUUxSjpaPW9BL4jY25Kwo4/highest.mp4"
autoPlay
muted
playsInline
loop
/>
<PiPButton
className="pip-button-basic__button"
render={(props, state) => <button {...props}>{state.pip ? 'Exit PiP' : 'Enter PiP'}</button>}
/>
</Player.Container>
</Player.Provider>
);
}
@@ -0,0 +1,65 @@
---
title: PiPButton
frameworkTitle:
html: media-pip-button
description: A button component for entering and exiting picture-in-picture mode
---
import ApiReference from "@/components/docs/api-reference/ApiReference.astro";
import FrameworkCase from "@/components/docs/FrameworkCase.astro";
import StyleCase from "@/components/docs/StyleCase.astro";
import Demo from "@/components/docs/demos/Demo.astro";
{/* React demos */}
import BasicUsageDemoReact from "@/components/docs/demos/pip-button/react/css/BasicUsage";
import basicUsageReactTsx from "@/components/docs/demos/pip-button/react/css/BasicUsage.tsx?raw";
import basicUsageReactCss from "@/components/docs/demos/pip-button/react/css/BasicUsage.css?raw";
{/* HTML demos */}
import BasicUsageDemoHtml from "@/components/docs/demos/pip-button/html/css/BasicUsage.astro";
import basicUsageHtml from "@/components/docs/demos/pip-button/html/css/BasicUsage.html?raw";
import basicUsageHtmlCss from "@/components/docs/demos/pip-button/html/css/BasicUsage.css?raw";
import basicUsageHtmlTs from "@/components/docs/demos/pip-button/html/css/BasicUsage.ts?raw";
## Anatomy
<FrameworkCase frameworks={["react"]}>
```tsx
<PiPButton />
```
</FrameworkCase>
<FrameworkCase frameworks={["html"]}>
```html
<media-pip-button></media-pip-button>
```
</FrameworkCase>
## Examples
### Basic Usage
<FrameworkCase frameworks={["react"]}>
<StyleCase styles={["css"]}>
<Demo files={[
{ title: "App.tsx", code: basicUsageReactTsx, lang: "tsx" },
{ title: "App.css", code: basicUsageReactCss, lang: "css" },
]}>
<BasicUsageDemoReact client:idle />
</Demo>
</StyleCase>
</FrameworkCase>
<FrameworkCase frameworks={["html"]}>
<StyleCase styles={["css"]}>
<Demo files={[
{ title: "index.html", code: basicUsageHtml, lang: "html" },
{ title: "index.css", code: basicUsageHtmlCss, lang: "css" },
{ title: "index.ts", code: basicUsageHtmlTs, lang: "ts" },
]}>
<BasicUsageDemoHtml />
</Demo>
</StyleCase>
</FrameworkCase>
<ApiReference component="PipButton" />
+1
View File
@@ -28,6 +28,7 @@ export const sidebar: Sidebar = [
{ slug: 'reference/controls' },
{ slug: 'reference/fullscreen-button' },
{ slug: 'reference/mute-button' },
{ slug: 'reference/pip-button' },
{ slug: 'reference/play-button' },
{ slug: 'reference/poster' },
{ slug: 'reference/time' },