fix(player): update web component docs links

vidstack · Oct 17, 2023 · 0433f99 · 0433f99
1 parent 66c20d4
commit 0433f99
Show file tree

Hide file tree

Showing 37 changed files with 40 additions and 37 deletions.
diff --git a/packages/vidstack/src/elements/define/buttons/live-button-element.ts b/packages/vidstack/src/elements/define/buttons/live-button-element.ts
@@ -3,7 +3,7 @@ import { Host } from 'maverick.js/element';
 import { LiveButton } from '../../../components';
 
 /**
- * @docs {@link https://www.vidstack.io/docs/player/components/buttons/live-button}
+ * @docs {@link https://www.vidstack.io/docs/wc/player/components/buttons/live-button}
  * @example
  * ```html
  * <media-live-button>

diff --git a/packages/vidstack/src/elements/define/captions-element.ts b/packages/vidstack/src/elements/define/captions-element.ts
@@ -3,7 +3,7 @@ import { Host } from 'maverick.js/element';
 import { Captions } from '../../components';
 
 /**
- * @docs {@link https://www.vidstack.io/docs/player/components/display/captions}
+ * @docs {@link https://www.vidstack.io/docs/wc/player/components/display/captions}
  * @example
  * ```html
  * <media-captions></media-captions>

diff --git a/packages/vidstack/src/elements/define/chapter-title-element.ts b/packages/vidstack/src/elements/define/chapter-title-element.ts
@@ -8,7 +8,7 @@ import { useMediaContext } from '../../core/api/media-context';
 class ChapterTitle extends Component {}
 
 /**
- * @docs {@link https://www.vidstack.io/docs/player/components/display/chapter-title}
+ * @docs {@link https://www.vidstack.io/docs/wc/player/components/display/chapter-title}
  * @example
  * ```html
  * <media-chapter-title></media-chapter-title>

diff --git a/packages/vidstack/src/elements/define/controls-element.ts b/packages/vidstack/src/elements/define/controls-element.ts
@@ -3,7 +3,7 @@ import { Host } from 'maverick.js/element';
 import { Controls } from '../../components';
 
 /**
- * @docs {@link https://www.vidstack.io/docs/player/components/media/controls}
+ * @docs {@link https://www.vidstack.io/docs/wc/player/components/display/controls}
  * @example
  * ```html
  * <media-player>

diff --git a/packages/vidstack/src/elements/define/controls-group-element.ts b/packages/vidstack/src/elements/define/controls-group-element.ts
@@ -3,7 +3,7 @@ import { Host } from 'maverick.js/element';
 import { ControlsGroup } from '../../components';
 
 /**
- * @docs {@link https://www.vidstack.io/docs/player/components/media/controls}
+ * @docs {@link https://www.vidstack.io/docs/wc/player/components/display/controls}
  * @example
  * ```html
  * <media-player>

diff --git a/packages/vidstack/src/elements/define/gesture-element.ts b/packages/vidstack/src/elements/define/gesture-element.ts
@@ -3,7 +3,7 @@ import { Host } from 'maverick.js/element';
 import { Gesture } from '../../components';
 
 /**
- * @docs {@link https://www.vidstack.io/docs/player/components/media/gesture}
+ * @docs {@link https://www.vidstack.io/docs/wc/player/components/display/gesture}
  * @example
  * ```html
  * <media-player>

diff --git a/packages/vidstack/src/elements/define/icon-element.ts b/packages/vidstack/src/elements/define/icon-element.ts
@@ -12,7 +12,7 @@ const svgTemplate = /* #__PURE__*/ createTemplate(
  * [media icons catalog](https://www.vidstack.io/media-icons) to preview them all. Do note, the
  * icon `type` can be dynamically changed.
  *
- * @docs {@link https://www.vidstack.io/docs/player/components/display/icons}
+ * @docs {@link https://www.vidstack.io/docs/wc/player/components/display/icons}
  * @example
  * ```html
  * <media-icon type="play"></media-icon>

diff --git a/packages/vidstack/src/elements/define/layouts/default/audio-layout-element.ts b/packages/vidstack/src/elements/define/layouts/default/audio-layout-element.ts
@@ -14,7 +14,7 @@ import { DefaultLayoutIconsLoader } from './icons-loader';
 import { createMenuContainer } from './shared-layout';
 
 /**
- * @docs {@link https://www.vidstack.io/docs/player/core-concepts/layouts/default}
+ * @docs {@link https://www.vidstack.io/docs/wc/player/core-concepts/layouts/default}
  * @example
  * ```html
  * <media-player>

diff --git a/packages/vidstack/src/elements/define/layouts/default/video-layout-element.ts b/packages/vidstack/src/elements/define/layouts/default/video-layout-element.ts
@@ -18,7 +18,7 @@ import {
 } from './video-layout';
 
 /**
- * @docs {@link https://www.vidstack.io/docs/player/core-concepts/layouts/default}
+ * @docs {@link https://www.vidstack.io/docs/wc/player/core-concepts/layouts/default}
  * @example
  * ```html
  * <media-player>

diff --git a/packages/vidstack/src/elements/define/layouts/layout-element.ts b/packages/vidstack/src/elements/define/layouts/layout-element.ts
@@ -1,5 +1,6 @@
 import { Component, effect } from 'maverick.js';
 import { Host } from 'maverick.js/element';
+
 import { PlayerQueryList } from '../../../core';
 
 class MediaLayout extends Component<{ when: string }> {
@@ -9,7 +10,7 @@ class MediaLayout extends Component<{ when: string }> {
 }
 
 /**
- * @docs {@link https://www.vidstack.io/docs/player/layouts#custom}
+ * @docs {@link https://www.vidstack.io/docs/wc/player/layouts#custom}
  * @example
  * ```html
  * <media-layout when="(view-type: video)">

diff --git a/packages/vidstack/src/elements/define/menus/audio-radio-group-element.ts b/packages/vidstack/src/elements/define/menus/audio-radio-group-element.ts
@@ -5,7 +5,7 @@ import { renderMenuItemsTemplate } from './_template';
 
 /**
  * @part label - Contains the audio track option label.
- * @docs {@link https://www.vidstack.io/docs/player/components/menu/audio-menu}
+ * @docs {@link https://www.vidstack.io/docs/wc/player/components/menu/audio-menu}
  * @example
  * ```html
  * <media-menu>

diff --git a/packages/vidstack/src/elements/define/menus/captions-radio-group-element.ts b/packages/vidstack/src/elements/define/menus/captions-radio-group-element.ts
@@ -5,7 +5,7 @@ import { renderMenuItemsTemplate } from './_template';
 
 /**
  * @part label - Contains the caption/subtitle option label.
- * @docs {@link https://www.vidstack.io/docs/player/components/menu/captions-menu-items}
+ * @docs {@link https://www.vidstack.io/docs/wc/player/components/menu/captions-menu-items}
  * @example
  * ```html
  * <media-menu>

diff --git a/packages/vidstack/src/elements/define/menus/chapters-radio-group-element.ts b/packages/vidstack/src/elements/define/menus/chapters-radio-group-element.ts
@@ -8,7 +8,7 @@ import { renderMenuItemsTemplate } from './_template';
  * @part label - Contains the chapter option title.
  * @part start-time - Contains the chapter option start time.
  * @part duration - Contains the chapter option duration.
- * @docs {@link https://www.vidstack.io/docs/player/components/menu/chapters-menu}
+ * @docs {@link https://www.vidstack.io/docs/wc/player/components/menu/chapters-menu}
  * @example
  * ```html
  * <media-menu>

diff --git a/packages/vidstack/src/elements/define/menus/menu-button-element.ts b/packages/vidstack/src/elements/define/menus/menu-button-element.ts
@@ -3,7 +3,7 @@ import { Host } from 'maverick.js/element';
 import { MenuButton } from '../../../components';
 
 /**
- * @docs {@link https://www.vidstack.io/docs/player/components/menu/menu}
+ * @docs {@link https://www.vidstack.io/docs/wc/player/components/menu/menu}
  * @example
  * ```html
  * <media-menu>

diff --git a/packages/vidstack/src/elements/define/menus/menu-element.ts b/packages/vidstack/src/elements/define/menus/menu-element.ts
@@ -4,7 +4,7 @@ import { Menu } from '../../../components';
 
 /**
  * @part close-target - Closes menu when pressed.
- * @docs {@link https://www.vidstack.io/docs/player/components/menu/menu}
+ * @docs {@link https://www.vidstack.io/docs/wc/player/components/menu/menu}
  * @example
  * ```html
  * <media-menu>

diff --git a/packages/vidstack/src/elements/define/menus/menu-item-element.ts b/packages/vidstack/src/elements/define/menus/menu-item-element.ts
@@ -3,7 +3,7 @@ import { Host } from 'maverick.js/element';
 import { MenuItem } from '../../../components';
 
 /**
- * @docs {@link https://www.vidstack.io/docs/player/components/menu/menu}
+ * @docs {@link https://www.vidstack.io/docs/wc/player/components/menu/menu}
  * @example
  * ```html
  * <media-menu>

diff --git a/packages/vidstack/src/elements/define/menus/menu-items-element.ts b/packages/vidstack/src/elements/define/menus/menu-items-element.ts
@@ -1,8 +1,9 @@
 import { Host } from 'maverick.js/element';
+
 import { MenuItems } from '../../../components';
 
 /**
- * @docs {@link https://www.vidstack.io/docs/player/components/menu/menu}
+ * @docs {@link https://www.vidstack.io/docs/wc/player/components/menu/menu}
  * @example
  * ```html
  * <media-menu>

diff --git a/packages/vidstack/src/elements/define/menus/menu-portal-element.ts b/packages/vidstack/src/elements/define/menus/menu-portal-element.ts
@@ -1,9 +1,10 @@
 import { Host, type Attributes } from 'maverick.js/element';
 import { isString } from 'maverick.js/std';
+
 import { MenuPortal, type MenuPortalProps } from '../../../components';
 
 /**
- * @docs {@link https://www.vidstack.io/docs/player/components/menu/menu#portal}
+ * @docs {@link https://www.vidstack.io/docs/wc/player/components/menu/menu#portal}
  * @example
  * ```html
  * <media-menu>

diff --git a/packages/vidstack/src/elements/define/menus/quality-radio-group-element.ts b/packages/vidstack/src/elements/define/menus/quality-radio-group-element.ts
@@ -7,7 +7,7 @@ import { renderMenuItemsTemplate } from './_template';
 /**
  * @part label - Contains the quality option label.
  * @part bitrate - Contains the quality option bitrate.
- * @docs {@link https://www.vidstack.io/docs/player/components/menu/quality-menu}
+ * @docs {@link https://www.vidstack.io/docs/wc/player/components/menu/quality-menu}
  * @example
  * ```html
  * <media-menu>

diff --git a/packages/vidstack/src/elements/define/menus/radio-element.ts b/packages/vidstack/src/elements/define/menus/radio-element.ts
@@ -3,7 +3,7 @@ import { Host } from 'maverick.js/element';
 import { Radio } from '../../../components';
 
 /**
- * @docs {@link https://www.vidstack.io/docs/player/components/menu/radio}
+ * @docs {@link https://www.vidstack.io/docs/wc/player/components/menu/radio}
  * @example
  * ```html
  * <media-radio-group value="720">

diff --git a/packages/vidstack/src/elements/define/menus/radio-group-element.ts b/packages/vidstack/src/elements/define/menus/radio-group-element.ts
@@ -3,7 +3,7 @@ import { Host } from 'maverick.js/element';
 import { RadioGroup } from '../../../components';
 
 /**
- * @docs {@link https://www.vidstack.io/docs/player/components/menu/radio-group}
+ * @docs {@link https://www.vidstack.io/docs/wc/player/components/menu/radio-group}
  * @example
  * ```html
  * <media-radio-group value="720">

diff --git a/packages/vidstack/src/elements/define/menus/speed-radio-group-element.ts b/packages/vidstack/src/elements/define/menus/speed-radio-group-element.ts
@@ -5,7 +5,7 @@ import { renderMenuItemsTemplate } from './_template';
 
 /**
  * @part label - Contains the speed option label.
- * @docs {@link https://www.vidstack.io/docs/player/components/menu/playback-rate-menu}
+ * @docs {@link https://www.vidstack.io/docs/wc/player/components/menu/playback-rate-menu}
  * @example
  * ```html
  * <media-menu>

diff --git a/packages/vidstack/src/elements/define/player-element.ts b/packages/vidstack/src/elements/define/player-element.ts
@@ -5,7 +5,7 @@ import { MediaPlayer } from '../../components';
 import type { MediaPlayerProps } from '../../core/api/player-props';
 
 /**
- * @docs {@link https://www.vidstack.io/docs/player/components/media/player}
+ * @docs {@link https://www.vidstack.io/docs/wc/player/components/core/player}
  * @example
  * ```html
  * <media-player src="...">

diff --git a/packages/vidstack/src/elements/define/poster-element.ts b/packages/vidstack/src/elements/define/poster-element.ts
@@ -6,7 +6,7 @@ import { Poster } from '../../components';
 import { useMediaContext, type MediaContext } from '../../core/api/media-context';
 
 /**
- * @docs {@link https://www.vidstack.io/docs/player/components/media/poster}
+ * @docs {@link https://www.vidstack.io/docs/wc/player/components/display/poster}
  * @example
  * ```html
  * <media-player>

diff --git a/packages/vidstack/src/elements/define/provider-element.ts b/packages/vidstack/src/elements/define/provider-element.ts
@@ -6,7 +6,7 @@ import { MediaProvider } from '../../components';
 import { useMediaContext, type MediaContext } from '../../core/api/media-context';
 
 /**
- * @docs {@link https://www.vidstack.io/docs/player/components/media/provider}
+ * @docs {@link https://www.vidstack.io/docs/wc/player/components/core/provider}
  * @example
  * ```html
  * <media-player>

diff --git a/packages/vidstack/src/elements/define/sliders/slider-chapters-element.ts b/packages/vidstack/src/elements/define/sliders/slider-chapters-element.ts
@@ -6,7 +6,7 @@ import { cloneTemplate, requestScopedAnimationFrame } from '../../../utils/dom';
 
 /**
  * @part chapter-title - Contains the current chapter title.
- * @docs {@link https://www.vidstack.io/docs/player/components/sliders/slider-chapters}
+ * @docs {@link https://www.vidstack.io/docs/wc/player/components/sliders/slider-chapters}
  * @example
  * ```html
  * <media-time-slider>

diff --git a/packages/vidstack/src/elements/define/sliders/slider-element.ts b/packages/vidstack/src/elements/define/sliders/slider-element.ts
@@ -3,7 +3,7 @@ import { Host } from 'maverick.js/element';
 import { Slider } from '../../../components';
 
 /**
- * @docs {@link https://www.vidstack.io/docs/player/components/sliders/slider}
+ * @docs {@link https://www.vidstack.io/docs/wc/player/components/sliders/slider}
  * @example
  * ```html
  * <media-slider min="0" max="100" value="50" aria-label="...">

diff --git a/packages/vidstack/src/elements/define/sliders/slider-preview-element.ts b/packages/vidstack/src/elements/define/sliders/slider-preview-element.ts
@@ -3,7 +3,7 @@ import { Host } from 'maverick.js/element';
 import { SliderPreview } from '../../../components';
 
 /**
- * @docs {@link https://www.vidstack.io/docs/player/components/sliders/slider#preview}
+ * @docs {@link https://www.vidstack.io/docs/wc/player/components/sliders/slider#preview}
  */
 export class MediaSliderPreviewElement extends Host(HTMLElement, SliderPreview) {
   static tagName = 'media-slider-preview';

diff --git a/packages/vidstack/src/elements/define/sliders/slider-value-element.ts b/packages/vidstack/src/elements/define/sliders/slider-value-element.ts
@@ -4,7 +4,7 @@ import { Host } from 'maverick.js/element';
 import { SliderValue } from '../../../components';
 
 /**
- * @docs {@link https://www.vidstack.io/docs/player/components/sliders/slider-value}
+ * @docs {@link https://www.vidstack.io/docs/wc/player/components/sliders/slider-value}
  * @example
  * ```html
  * <media-time-slider>

diff --git a/packages/vidstack/src/elements/define/sliders/slider-video-element.ts b/packages/vidstack/src/elements/define/sliders/slider-video-element.ts
@@ -11,7 +11,7 @@ const videoTemplate = /* #__PURE__*/ createTemplate(
 );
 
 /**
- * @docs {@link https://www.vidstack.io/docs/player/components/sliders/slider-video}
+ * @docs {@link https://www.vidstack.io/docs/wc/player/components/sliders/slider-video}
  * @example
  * ```html
  * <media-time-slider>

diff --git a/packages/vidstack/src/elements/define/sliders/time-slider-element.ts b/packages/vidstack/src/elements/define/sliders/time-slider-element.ts
@@ -3,7 +3,7 @@ import { Host } from 'maverick.js/element';
 import { TimeSlider } from '../../../components';
 
 /**
- * @docs {@link https://www.vidstack.io/docs/player/components/sliders/time-slider}
+ * @docs {@link https://www.vidstack.io/docs/wc/player/components/sliders/time-slider}
  * @example
  * ```html
  * <media-time-slider>

diff --git a/packages/vidstack/src/elements/define/sliders/volume-slider-element.ts b/packages/vidstack/src/elements/define/sliders/volume-slider-element.ts
@@ -3,7 +3,7 @@ import { Host } from 'maverick.js/element';
 import { VolumeSlider } from '../../../components';
 
 /**
- * @docs {@link https://www.vidstack.io/docs/player/components/sliders/volume-slider}
+ * @docs {@link https://www.vidstack.io/docs/wc/player/components/sliders/volume-slider}
  * @example
  * ```html
  * <media-volume-slider>

diff --git a/packages/vidstack/src/elements/define/thumbnail-element.ts b/packages/vidstack/src/elements/define/thumbnail-element.ts
@@ -11,7 +11,7 @@ const imgTemplate = /* #__PURE__*/ createTemplate(
 );
 
 /**
- * @docs {@link https://www.vidstack.io/docs/player/components/display/thumbnail}
+ * @docs {@link https://www.vidstack.io/docs/wc/player/components/display/thumbnail}
  * @example
  * ```html
  * <media-player>

diff --git a/packages/vidstack/src/elements/define/time-element.ts b/packages/vidstack/src/elements/define/time-element.ts
@@ -4,7 +4,7 @@ import { Host } from 'maverick.js/element';
 import { Time } from '../../components';
 
 /**
- * @docs {@link https://www.vidstack.io/docs/player/components/display/time}
+ * @docs {@link https://www.vidstack.io/docs/wc/player/components/display/time}
  * @example
  * ```html
  * <media-time type="current"></media-time>

diff --git a/packages/vidstack/src/elements/define/tooltips/tooltip-content-element.ts b/packages/vidstack/src/elements/define/tooltips/tooltip-content-element.ts
@@ -3,7 +3,7 @@ import { Host } from 'maverick.js/element';
 import { TooltipContent } from '../../../components';
 
 /**
- * @docs {@link https://www.vidstack.io/docs/player/components/tooltip}
+ * @docs {@link https://www.vidstack.io/docs/wc/player/components/tooltip}
  * @example
  * ```html
  * <media-tooltip>

diff --git a/packages/vidstack/src/elements/define/tooltips/tooltip-element.ts b/packages/vidstack/src/elements/define/tooltips/tooltip-element.ts
@@ -3,7 +3,7 @@ import { Host } from 'maverick.js/element';
 import { Tooltip } from '../../../components';
 
 /**
- * @docs {@link https://www.vidstack.io/docs/player/components/tooltip}
+ * @docs {@link https://www.vidstack.io/docs/wc/player/components/tooltip}
  * @example
  * ```html
  * <media-tooltip>

diff --git a/packages/vidstack/src/elements/define/tooltips/tooltip-trigger-element.ts b/packages/vidstack/src/elements/define/tooltips/tooltip-trigger-element.ts
@@ -3,7 +3,7 @@ import { Host } from 'maverick.js/element';
 import { TooltipTrigger } from '../../../components';
 
 /**
- * @docs {@link https://www.vidstack.io/docs/player/components/tooltip}
+ * @docs {@link https://www.vidstack.io/docs/wc/player/components/tooltip}
  * @example
  * ```html
  * <media-tooltip>