feat(site): add buffering indicator api reference

closes #532 closes #533
2026-08-16 02:45:09 +00:00 · 2026-02-13 09:24:04 -06:00
parent 961909b5f5
commit 84b7b0774a
9 changed files with 196 additions and 0 deletions
@@ -46,6 +46,7 @@ export const BufferingIndicator = forwardRef(function BufferingIndicator(

  const state = useSyncExternalStore(
    (cb) => core.state.subscribe(cb),
+    () => core.state.current,
    () => core.state.current
  );

@@ -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,39 @@
+.buffering-indicator-basic {
+  display: flex;
+  width: 100%;
+  height: 100%;
+  position: relative;
+}
+
+.buffering-indicator-basic__overlay {
+  position: absolute;
+  inset: 0;
+  display: flex;
+  align-items: center;
+  justify-content: center;
+  pointer-events: none;
+  z-index: 30;
+}
+
+.buffering-indicator-basic__overlay .buffering-indicator-basic__spinner {
+  display: none;
+}
+
+.buffering-indicator-basic__overlay[data-visible] .buffering-indicator-basic__spinner {
+  display: block;
+}
+
+.buffering-indicator-basic__spinner {
+  width: 48px;
+  height: 48px;
+  border: 4px solid rgba(255, 255, 255, 0.3);
+  border-top-color: white;
+  border-radius: 50%;
+  animation: buffering-spin 0.8s linear infinite;
+}
+
+@keyframes buffering-spin {
+  to {
+    transform: rotate(360deg);
+  }
+}
@@ -0,0 +1,12 @@
+<video-player class="buffering-indicator-basic">
+    <video
+        src="https://stream.mux.com/lhnU49l1VGi3zrTAZhDm9LUUxSjpaPW9BL4jY25Kwo4/highest.mp4"
+        autoplay
+        muted
+        playsinline
+        loop
+    ></video>
+    <media-buffering-indicator class="buffering-indicator-basic__overlay">
+        <div class="buffering-indicator-basic__spinner"></div>
+    </media-buffering-indicator>
+</video-player>
@@ -0,0 +1,2 @@
+import '@videojs/html/video/player';
+import '@videojs/html/ui/buffering-indicator';
@@ -0,0 +1,39 @@
+.buffering-indicator-basic {
+  display: flex;
+  width: 100%;
+  height: 100%;
+  position: relative;
+}
+
+.buffering-indicator-basic__overlay {
+  position: absolute;
+  inset: 0;
+  display: flex;
+  align-items: center;
+  justify-content: center;
+  pointer-events: none;
+  z-index: 30;
+}
+
+.buffering-indicator-basic__overlay .buffering-indicator-basic__spinner {
+  display: none;
+}
+
+.buffering-indicator-basic__overlay[data-visible] .buffering-indicator-basic__spinner {
+  display: block;
+}
+
+.buffering-indicator-basic__spinner {
+  width: 48px;
+  height: 48px;
+  border: 4px solid rgba(255, 255, 255, 0.3);
+  border-top-color: white;
+  border-radius: 50%;
+  animation: buffering-spin 0.8s linear infinite;
+}
+
+@keyframes buffering-spin {
+  to {
+    transform: rotate(360deg);
+  }
+}
@@ -0,0 +1,27 @@
+import { BufferingIndicator, createPlayer, features, Video } from '@videojs/react';
+
+import './BasicUsage.css';
+
+const Player = createPlayer({ features: [...features.video] });
+
+export default function BasicUsage() {
+  return (
+    <Player.Provider>
+      <Player.Container className="buffering-indicator-basic">
+        <Video
+          src="https://stream.mux.com/lhnU49l1VGi3zrTAZhDm9LUUxSjpaPW9BL4jY25Kwo4/highest.mp4"
+          autoPlay
+          muted
+          playsInline
+          loop
+        />
+        <BufferingIndicator
+          className="buffering-indicator-basic__overlay"
+          render={(props, state) => (
+            <div {...props}>{state.visible && <div className="buffering-indicator-basic__spinner" />}</div>
+          )}
+        />
+      </Player.Container>
+    </Player.Provider>
+  );
+}
@@ -0,0 +1,65 @@
+---
+title: BufferingIndicator
+frameworkTitle:
+  html: media-buffering-indicator
+description: A component that displays a loading indicator when media is buffering
+---
+
+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/buffering-indicator/react/css/BasicUsage";
+import basicUsageReactTsx from "@/components/docs/demos/buffering-indicator/react/css/BasicUsage.tsx?raw";
+import basicUsageReactCss from "@/components/docs/demos/buffering-indicator/react/css/BasicUsage.css?raw";
+
+{/* HTML demos */}
+import BasicUsageDemoHtml from "@/components/docs/demos/buffering-indicator/html/css/BasicUsage.astro";
+import basicUsageHtml from "@/components/docs/demos/buffering-indicator/html/css/BasicUsage.html?raw";
+import basicUsageHtmlCss from "@/components/docs/demos/buffering-indicator/html/css/BasicUsage.css?raw";
+import basicUsageHtmlTs from "@/components/docs/demos/buffering-indicator/html/css/BasicUsage.ts?raw";
+
+## Anatomy
+
+<FrameworkCase frameworks={["react"]}>
+```tsx
+<BufferingIndicator />
+```
+</FrameworkCase>
+
+<FrameworkCase frameworks={["html"]}>
+```html
+<media-buffering-indicator></media-buffering-indicator>
+```
+</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="BufferingIndicator" />
@@ -25,6 +25,7 @@ export const sidebar: Sidebar = [
    sidebarLabel: 'Components',
    contents: [
      // sorted alphabetically
+      { slug: 'reference/buffering-indicator' },
      { slug: 'reference/controls' },
      { slug: 'reference/fullscreen-button' },
      { slug: 'reference/mute-button' },