Skip to content

Commit

Permalink
docs: Add note to legacy notes (#7022)
Browse files Browse the repository at this point in the history 
People keep finding the v4 legacy docs at docs.videojs.com/docs and Google keeps positioning them highly in search results. This attempts to lessen that.
  • Loading branch information
@mister-ben
mister-ben authored Jan 6, 2021
1 parent 661962c commit f87297b
Show file tree
Hide file tree
Showing 81 changed files with 341 additions and 62 deletions.
5 changes: 4 additions & 1 deletion docs/legacy-docs/api/audio-track-button.html
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
<!DOCTYPE html><html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"/><title>AudioTrackButton</title><script src="//use.edgefonts.net/source-code-pro.js">
// font for code blocks
</script><link href="http://fonts.googleapis.com/css?family=Open+Sans:400italic,700italic,400,700" rel="stylesheet" type="text/css"/> <!-- there are many other style for highlighted code here: https://cdnjs.com/libraries/highlight.js --><link rel="stylesheet" type="text/css" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.6/styles/atelier-forest.light.min.css"/><link rel="stylesheet" type="text/css" href="css/api-docs.css"/></head><body><section id="index" class="side-nav"><h2 class="sideNavHeader"><a href="index.html">API Index</a></h2><div id="memberIndex" class="member-index"><h3>AudioTrackButton Methods</h3><h4>Class Methods</h4><ul id="methodsList"><li><a href="#MethodsbuildCSSClass">buildCSSClass</a></li><li><a href="#MethodscreateItems">createItems</a></li></ul><h4>Inherited Methods from MenuButton</h4><ul><li><a href="#MethodscreateEl">createEl</a></li><li><a href="#MethodscreateMenu">createMenu</a></li><li><a href="#Methodsdisable">disable</a></li><li><a href="#MethodshandleClick">handleClick</a></li><li><a href="#MethodshandleKeyPress">handleKeyPress</a></li><li><a href="#MethodshandleSubmenuKeyPress">handleSubmenuKeyPress</a></li><li><a href="#MethodspressButton">pressButton</a></li><li><a href="#MethodsunpressButton">unpressButton</a></li><li><a href="#Methodsupdate">update</a></li></ul><h4>Inherited Methods from Button</h4><ul><li><a href="#MethodsaddChild">addChild</a></li></ul><h4>Inherited Methods from ClickableComponent</h4><ul><li><a href="#MethodscontrolText">controlText</a></li><li><a href="#Methodsenable">enable</a></li><li><a href="#MethodshandleBlur">handleBlur</a></li><li><a href="#MethodshandleFocus">handleFocus</a></li></ul><h4>Inherited Methods from Component</h4><ul><li><a href="#Methods$">$</a></li><li><a href="#Methods$$">$$</a></li><li><a href="#MethodsaddClass">addClass</a></li><li><a href="#Methodschildren">children</a></li><li><a href="#MethodsclearInterval">clearInterval</a></li><li><a href="#MethodsclearTimeout">clearTimeout</a></li><li><a href="#MethodscontentEl">contentEl</a></li><li><a href="#MethodscurrentDimension">currentDimension</a></li><li><a href="#MethodscurrentDimensions">currentDimensions</a></li><li><a href="#MethodscurrentHeight">currentHeight</a></li><li><a href="#MethodscurrentWidth">currentWidth</a></li><li><a href="#Methodsdimensions">dimensions</a></li><li><a href="#Methodsdispose">dispose</a></li><li><a href="#Methodsel">el</a></li><li><a href="#MethodsenableTouchActivity">enableTouchActivity</a></li><li><a href="#Methodsextend">extend</a></li><li><a href="#MethodsgetChild">getChild</a></li><li><a href="#MethodsgetChildById">getChildById</a></li><li><a href="#MethodsgetComponent">getComponent</a></li><li><a href="#MethodshasClass">hasClass</a></li><li><a href="#Methodsheight">height</a></li><li><a href="#Methodshide">hide</a></li><li><a href="#Methodsid">id</a></li><li><a href="#MethodsinitChildren">initChildren</a></li><li><a href="#Methodsname">name</a></li><li><a href="#Methodsoff">off</a></li><li><a href="#Methodson">on</a></li><li><a href="#Methodsone">one</a></li><li><a href="#Methodsoptions">options</a></li><li><a href="#Methodsplayer">player</a></li><li><a href="#Methodsready">ready</a></li><li><a href="#MethodsregisterComponent">registerComponent</a></li><li><a href="#MethodsremoveChild">removeChild</a></li><li><a href="#MethodsremoveClass">removeClass</a></li><li><a href="#MethodssetInterval">setInterval</a></li><li><a href="#MethodssetTimeout">setTimeout</a></li><li><a href="#Methodsshow">show</a></li><li><a href="#MethodstoggleClass">toggleClass</a></li><li><a href="#Methodstrigger">trigger</a></li><li><a href="#MethodstriggerReady">triggerReady</a></li><li><a href="#Methodswidth">width</a></li></ul></div></section><div id="main" class="section"><section id="top" class="section"><h1>AudioTrackButton</h1><div style="border:none" id="classDescription" class="description"><p>The base class for buttons that toggle specific text track types (e.g. subtitles)</p></div><p>DEFINED IN: <a href="https://github.com/videojs/video.js/blob/master/src/js/control-bar/audio-track-controls/audio-track-button.js#L9">audio-track-button.js line number: 9</a></p><p>EXTENDS: <a href="track-button.html">track-button.js</a></p><h3>Constructor</h3><pre><code>AudioTrackButton( player,[options] )</code></pre><h4>Parameters</h4><table><thead><tr><th>name</th><th>Type</th><th>Required</th><th>Description</th></tr></thead><tbody><tr><td>player</td><td>Player|Object</td></tr><tr><td>options</td><td>Object</td></tr></tbody></table></section><section id="methods" class="section"><h2>Methods</h2><div id="MethodsbuildCSSClass"><h3 id="buildCSSClassHeader">buildCSSClass()</h3><div id="buildCSSClassDescription" class="description"><p>Allow sub components to stack CSS class names</p></div><p class="vjs-only"><em id="buildCSSClassFooter">Defined in <a href="https://github.com/videojs/video.js/blob/master/src/js/control-bar/audio-track-controls/audio-track-button.js#L26">https://github.com/videojs/video.js/blob/master/src/js/control-bar/audio-track-controls/audio-track-button.js line number: 26</a></em></p><p><a href="#top">[back to top]</a></p></div><div id="MethodscreateItems"><h3 id="createItemsHeader">createItems()</h3><div id="createItemsDescription" class="description"><p>Create a menu item for each audio track</p></div><p class="vjs-only"><em id="createItemsFooter">Defined in <a href="https://github.com/videojs/video.js/blob/master/src/js/control-bar/audio-track-controls/audio-track-button.js#L36">https://github.com/videojs/video.js/blob/master/src/js/control-bar/audio-track-controls/audio-track-button.js line number: 36</a></em></p><p><a href="#top">[back to top]</a></p></div><div id="MethodscreateEl"><h3 id="createElHeader">createEl()</h3><div id="createElDescription" class="description"><p>Create the component's DOM element</p></div><p class="vjs-only"><em id="createElFooter">Defined in <a href="https://github.com/videojs/video.js/blob/master/src/js/menu/menu-button.js#L103">https://github.com/videojs/video.js/blob/master/src/js/menu/menu-button.js line number: 103</a></em></p><p><a href="#top">[back to top]</a></p></div><div id="MethodscreateMenu"><h3 id="createMenuHeader">createMenu()</h3><div id="createMenuDescription" class="description"><p>Create menu</p></div><p class="vjs-only"><em id="createMenuFooter">Defined in <a href="https://github.com/videojs/video.js/blob/master/src/js/menu/menu-button.js#L64">https://github.com/videojs/video.js/blob/master/src/js/menu/menu-button.js line number: 64</a></em></p><p><a href="#top">[back to top]</a></p></div><div id="Methodsdisable"><h3 id="disableHeader">disable()</h3><div id="disableDescription" class="description"><p>Enable the menu button</p></div><p class="vjs-only"><em id="disableFooter">Defined in <a href="https://github.com/videojs/video.js/blob/master/src/js/menu/menu-button.js#L248">https://github.com/videojs/video.js/blob/master/src/js/menu/menu-button.js line number: 248</a></em></p><p><a href="#top">[back to top]</a></p></div><div id="MethodshandleClick"><h3 id="handleClickHeader">handleClick()</h3><div id="handleClickDescription" class="description"><p>When you click the button it adds focus, which
</script><link href="http://fonts.googleapis.com/css?family=Open+Sans:400italic,700italic,400,700" rel="stylesheet" type="text/css"/> <!-- there are many other style for highlighted code here: https://cdnjs.com/libraries/highlight.js --><link rel="stylesheet" type="text/css" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.6/styles/atelier-forest.light.min.css"/><link rel="stylesheet" type="text/css" href="css/api-docs.css"/><link rel="canonical" href="https://docs.videojs.com/AudioTrackButton.html">
</head><body>
<p class="legacydocsnote">This documentation is for an outdated version of Video.js. See <a href="https://docs.videojs.com/AudioTrackButton.html">documentation for the current release</a>.
<section id="index" class="side-nav"><h2 class="sideNavHeader"><a href="index.html">API Index</a></h2><div id="memberIndex" class="member-index"><h3>AudioTrackButton Methods</h3><h4>Class Methods</h4><ul id="methodsList"><li><a href="#MethodsbuildCSSClass">buildCSSClass</a></li><li><a href="#MethodscreateItems">createItems</a></li></ul><h4>Inherited Methods from MenuButton</h4><ul><li><a href="#MethodscreateEl">createEl</a></li><li><a href="#MethodscreateMenu">createMenu</a></li><li><a href="#Methodsdisable">disable</a></li><li><a href="#MethodshandleClick">handleClick</a></li><li><a href="#MethodshandleKeyPress">handleKeyPress</a></li><li><a href="#MethodshandleSubmenuKeyPress">handleSubmenuKeyPress</a></li><li><a href="#MethodspressButton">pressButton</a></li><li><a href="#MethodsunpressButton">unpressButton</a></li><li><a href="#Methodsupdate">update</a></li></ul><h4>Inherited Methods from Button</h4><ul><li><a href="#MethodsaddChild">addChild</a></li></ul><h4>Inherited Methods from ClickableComponent</h4><ul><li><a href="#MethodscontrolText">controlText</a></li><li><a href="#Methodsenable">enable</a></li><li><a href="#MethodshandleBlur">handleBlur</a></li><li><a href="#MethodshandleFocus">handleFocus</a></li></ul><h4>Inherited Methods from Component</h4><ul><li><a href="#Methods$">$</a></li><li><a href="#Methods$$">$$</a></li><li><a href="#MethodsaddClass">addClass</a></li><li><a href="#Methodschildren">children</a></li><li><a href="#MethodsclearInterval">clearInterval</a></li><li><a href="#MethodsclearTimeout">clearTimeout</a></li><li><a href="#MethodscontentEl">contentEl</a></li><li><a href="#MethodscurrentDimension">currentDimension</a></li><li><a href="#MethodscurrentDimensions">currentDimensions</a></li><li><a href="#MethodscurrentHeight">currentHeight</a></li><li><a href="#MethodscurrentWidth">currentWidth</a></li><li><a href="#Methodsdimensions">dimensions</a></li><li><a href="#Methodsdispose">dispose</a></li><li><a href="#Methodsel">el</a></li><li><a href="#MethodsenableTouchActivity">enableTouchActivity</a></li><li><a href="#Methodsextend">extend</a></li><li><a href="#MethodsgetChild">getChild</a></li><li><a href="#MethodsgetChildById">getChildById</a></li><li><a href="#MethodsgetComponent">getComponent</a></li><li><a href="#MethodshasClass">hasClass</a></li><li><a href="#Methodsheight">height</a></li><li><a href="#Methodshide">hide</a></li><li><a href="#Methodsid">id</a></li><li><a href="#MethodsinitChildren">initChildren</a></li><li><a href="#Methodsname">name</a></li><li><a href="#Methodsoff">off</a></li><li><a href="#Methodson">on</a></li><li><a href="#Methodsone">one</a></li><li><a href="#Methodsoptions">options</a></li><li><a href="#Methodsplayer">player</a></li><li><a href="#Methodsready">ready</a></li><li><a href="#MethodsregisterComponent">registerComponent</a></li><li><a href="#MethodsremoveChild">removeChild</a></li><li><a href="#MethodsremoveClass">removeClass</a></li><li><a href="#MethodssetInterval">setInterval</a></li><li><a href="#MethodssetTimeout">setTimeout</a></li><li><a href="#Methodsshow">show</a></li><li><a href="#MethodstoggleClass">toggleClass</a></li><li><a href="#Methodstrigger">trigger</a></li><li><a href="#MethodstriggerReady">triggerReady</a></li><li><a href="#Methodswidth">width</a></li></ul></div></section><div id="main" class="section"><section id="top" class="section"><h1>AudioTrackButton</h1><div style="border:none" id="classDescription" class="description"><p>The base class for buttons that toggle specific text track types (e.g. subtitles)</p></div><p>DEFINED IN: <a href="https://github.com/videojs/video.js/blob/master/src/js/control-bar/audio-track-controls/audio-track-button.js#L9">audio-track-button.js line number: 9</a></p><p>EXTENDS: <a href="track-button.html">track-button.js</a></p><h3>Constructor</h3><pre><code>AudioTrackButton( player,[options] )</code></pre><h4>Parameters</h4><table><thead><tr><th>name</th><th>Type</th><th>Required</th><th>Description</th></tr></thead><tbody><tr><td>player</td><td>Player|Object</td></tr><tr><td>options</td><td>Object</td></tr></tbody></table></section><section id="methods" class="section"><h2>Methods</h2><div id="MethodsbuildCSSClass"><h3 id="buildCSSClassHeader">buildCSSClass()</h3><div id="buildCSSClassDescription" class="description"><p>Allow sub components to stack CSS class names</p></div><p class="vjs-only"><em id="buildCSSClassFooter">Defined in <a href="https://github.com/videojs/video.js/blob/master/src/js/control-bar/audio-track-controls/audio-track-button.js#L26">https://github.com/videojs/video.js/blob/master/src/js/control-bar/audio-track-controls/audio-track-button.js line number: 26</a></em></p><p><a href="#top">[back to top]</a></p></div><div id="MethodscreateItems"><h3 id="createItemsHeader">createItems()</h3><div id="createItemsDescription" class="description"><p>Create a menu item for each audio track</p></div><p class="vjs-only"><em id="createItemsFooter">Defined in <a href="https://github.com/videojs/video.js/blob/master/src/js/control-bar/audio-track-controls/audio-track-button.js#L36">https://github.com/videojs/video.js/blob/master/src/js/control-bar/audio-track-controls/audio-track-button.js line number: 36</a></em></p><p><a href="#top">[back to top]</a></p></div><div id="MethodscreateEl"><h3 id="createElHeader">createEl()</h3><div id="createElDescription" class="description"><p>Create the component's DOM element</p></div><p class="vjs-only"><em id="createElFooter">Defined in <a href="https://github.com/videojs/video.js/blob/master/src/js/menu/menu-button.js#L103">https://github.com/videojs/video.js/blob/master/src/js/menu/menu-button.js line number: 103</a></em></p><p><a href="#top">[back to top]</a></p></div><div id="MethodscreateMenu"><h3 id="createMenuHeader">createMenu()</h3><div id="createMenuDescription" class="description"><p>Create menu</p></div><p class="vjs-only"><em id="createMenuFooter">Defined in <a href="https://github.com/videojs/video.js/blob/master/src/js/menu/menu-button.js#L64">https://github.com/videojs/video.js/blob/master/src/js/menu/menu-button.js line number: 64</a></em></p><p><a href="#top">[back to top]</a></p></div><div id="Methodsdisable"><h3 id="disableHeader">disable()</h3><div id="disableDescription" class="description"><p>Enable the menu button</p></div><p class="vjs-only"><em id="disableFooter">Defined in <a href="https://github.com/videojs/video.js/blob/master/src/js/menu/menu-button.js#L248">https://github.com/videojs/video.js/blob/master/src/js/menu/menu-button.js line number: 248</a></em></p><p><a href="#top">[back to top]</a></p></div><div id="MethodshandleClick"><h3 id="handleClickHeader">handleClick()</h3><div id="handleClickDescription" class="description"><p>When you click the button it adds focus, which
will show the menu indefinitely.
So we'll remove focus when the mouse leaves the button.
Focus is needed for tab navigation.
Expand Down
Loading

0 comments on commit f87297b

Please sign in to comment.