feat(site): add pip button api reference

closes #530
2026-08-16 02:45:09 +00:00 · 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>
+  );
+}