bitmovin-player-ui
Version:
Bitmovin Player UI Framework
58 lines (57 loc) • 32.4 kB
HTML
<html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>NavigationGroup | bitmovin-player-ui</title><meta name="description" content="Documentation for bitmovin-player-ui"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">bitmovin-player-ui</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">NavigationGroup</a></li></ul><h1>Class NavigationGroup</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Used as part of spatial navigation. Groups together different components to which you can navigate to, in a single
navigation group.</p>
<p>Responsible for finding elements in direction on navigation and for tracking active element inside the group.
Triggers blur and focus on element when active element is changed, as well as click on element on <code>Action.SELECT</code>.
Will call <code>hideUi()</code> on passed in container if <code>Action.BACK</code> is called.</p>
<p>To have more control over grouping related elements together, you can use <code>FocusableContainer</code>.</p>
<p>Example 1:
<code>
new RootNavigationGroup(uiContainer, playbackToggleOverlay, seekBar, bottomControlBar, titleBar)
</code></p>
<p>In this example all components which are passed to the <code>RootNavigationGroup</code> will be navigable on a 'flat' hierarchy.
Elements form within the bottomControlBar and the titleBar will be resolved lazily and it's possible to navigate
from/to every element.</p>
<p>Example 2:
<code>
new RootNavigationGroup(
uiContainer, playbackToggleOverlay, seekBar, new FocusableContainer(bottomControlBar, playbackToggleButton), new FocusableContainer(titleBar)
)
</code></p>
<p>In this example the bottomControlBar and the titleBar are considered as a group of elements. Their components
will still be resolved lazily, but the navigation will target the whole container instead of the individual
components. In addition, a primary component can be set for each <code>FocusableContainer</code>, which will be component that
receives focus first when the container is focused.</p>
</div></section><section class="tsd-panel tsd-hierarchy" data-refl="808"><h4>Hierarchy (<a href="../hierarchy.html#NavigationGroup">View Summary</a>)</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">NavigationGroup</span><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><a href="RootNavigationGroup.html" class="tsd-signature-type tsd-kind-class">RootNavigationGroup</a></li><li class="tsd-hierarchy-item"><a href="SettingsPanelNavigationGroup.html" class="tsd-signature-type tsd-kind-class">SettingsPanelNavigationGroup</a></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/c158eb7d6864d483ce3102eac3655a2d7f8c0123/src/ts/spatialnavigation/NavigationGroup.ts#L44">src/ts/spatialnavigation/NavigationGroup.ts:44</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="#container" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>container</span></a>
<a href="#onaction" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Action?</span></a>
<a href="#onnavigation" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Navigation?</span></a>
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="#disable" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>disable</span></a>
<a href="#enable" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>enable</span></a>
<a href="#focusfirstcomponent" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>focus<wbr/>First<wbr/>Component</span></a>
<a href="#getactivecomponent" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Active<wbr/>Component</span></a>
<a href="#handleaction" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>handle<wbr/>Action</span></a>
<a href="#handlenavigation" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>handle<wbr/>Navigation</span></a>
<a href="#release" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>release</span></a>
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Constructors</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="constructor"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="constructornavigationgroup"><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">NavigationGroup</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">container</span><span class="tsd-signature-symbol">:</span> <a href="Container.html" class="tsd-signature-type tsd-kind-class">Container</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/ContainerConfig.html" class="tsd-signature-type tsd-kind-interface">ContainerConfig</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">components</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Focusable</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">NavigationGroup</a><a href="#constructornavigationgroup" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">container</span>: <a href="Container.html" class="tsd-signature-type tsd-kind-class">Container</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/ContainerConfig.html" class="tsd-signature-type tsd-kind-interface">ContainerConfig</a><span class="tsd-signature-symbol">></span></span></li><li><span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">components</span>: <span class="tsd-signature-type">Focusable</span><span class="tsd-signature-symbol">[]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">NavigationGroup</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/c158eb7d6864d483ce3102eac3655a2d7f8c0123/src/ts/spatialnavigation/NavigationGroup.ts#L51">src/ts/spatialnavigation/NavigationGroup.ts:51</a></li></ul></aside></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Properties</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="container"><code class="tsd-tag">Readonly</code><span>container</span><a href="#container" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">container</span><span class="tsd-signature-symbol">:</span> <a href="Container.html" class="tsd-signature-type tsd-kind-class">Container</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/ContainerConfig.html" class="tsd-signature-type tsd-kind-interface">ContainerConfig</a><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/c158eb7d6864d483ce3102eac3655a2d7f8c0123/src/ts/spatialnavigation/NavigationGroup.ts#L52">src/ts/spatialnavigation/NavigationGroup.ts:52</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="onaction"><code class="tsd-tag">Optional</code><span>on<wbr/>Action</span><a href="#onaction" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">onAction</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">ActionCallback</span></div><div class="tsd-comment tsd-typography"><p>If overwritten, allows to implement custom action behavior. Per default, the internal handler will still be
executed. To prevent execution of the default action handler, call <code>preventDefault()</code>;</p>
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-action">Param: action<a href="#param-action" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>{Action} The action that was called</p>
</div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-target">Param: target<a href="#param-target" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>{HTMLElement} The target element that action was called on</p>
</div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-preventdefault">Param: preventDefault<a href="#param-preventdefault" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>{() => void} A function that, when called, will prevent the execution of the default handler</p>
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/c158eb7d6864d483ce3102eac3655a2d7f8c0123/src/ts/spatialnavigation/NavigationGroup.ts#L108">src/ts/spatialnavigation/NavigationGroup.ts:108</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="onnavigation"><code class="tsd-tag">Optional</code><span>on<wbr/>Navigation</span><a href="#onnavigation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">onNavigation</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">NavigationCallback</span></div><div class="tsd-comment tsd-typography"><p>If overwritten, allows to implement custom navigation behavior. Per default, the internal handler will still be
executed. To prevent execution of the default navigation handler, call <code>preventDefault()</code>;</p>
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-direction">Param: direction<a href="#param-direction" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>{Direction} The direction to move along</p>
</div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-target-1">Param: target<a href="#param-target-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>{HTMLElement} The target element for the event</p>
</div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-preventdefault-1">Param: preventDefault<a href="#param-preventdefault-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>{() => void} A function that, when called, will prevent the execution of the default handler</p>
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/c158eb7d6864d483ce3102eac3655a2d7f8c0123/src/ts/spatialnavigation/NavigationGroup.ts#L98">src/ts/spatialnavigation/NavigationGroup.ts:98</a></li></ul></aside></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Methods</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="disable"><span>disable</span><a href="#disable" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="disable-1"><span class="tsd-kind-call-signature">disable</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#disable-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Disable navigation group</p>
<p>Call blur on active element, set as undefined, and track it as element before disable.</p>
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/c158eb7d6864d483ce3102eac3655a2d7f8c0123/src/ts/spatialnavigation/NavigationGroup.ts#L234">src/ts/spatialnavigation/NavigationGroup.ts:234</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="enable"><span>enable</span><a href="#enable" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="enable-1"><span class="tsd-kind-call-signature">enable</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#enable-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Enable navigation group</p>
<p>Sets active element to either element that was active before disable, or first element of tracked elements.
If it is settings panel, it will always focus first element in the list.</p>
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/c158eb7d6864d483ce3102eac3655a2d7f8c0123/src/ts/spatialnavigation/NavigationGroup.ts#L248">src/ts/spatialnavigation/NavigationGroup.ts:248</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="focusfirstcomponent"><span>focus<wbr/>First<wbr/>Component</span><a href="#focusfirstcomponent" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="focusfirstcomponent-1"><span class="tsd-kind-call-signature">focusFirstComponent</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#focusfirstcomponent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/c158eb7d6864d483ce3102eac3655a2d7f8c0123/src/ts/spatialnavigation/NavigationGroup.ts#L139">src/ts/spatialnavigation/NavigationGroup.ts:139</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getactivecomponent"><span>get<wbr/>Active<wbr/>Component</span><a href="#getactivecomponent" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="getactivecomponent-1"><span class="tsd-kind-call-signature">getActiveComponent</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">AnyComponent</span><a href="#getactivecomponent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the active HTMLElement.</p>
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AnyComponent</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/c158eb7d6864d483ce3102eac3655a2d7f8c0123/src/ts/spatialnavigation/NavigationGroup.ts#L113">src/ts/spatialnavigation/NavigationGroup.ts:113</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="handleaction"><span>handle<wbr/>Action</span><a href="#handleaction" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="handleaction-1"><span class="tsd-kind-call-signature">handleAction</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">action</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Action</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#handleaction-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Handles an action event.</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">action</span>: <span class="tsd-signature-type">Action</span></span><div class="tsd-comment tsd-typography"><p>The action of the event</p>
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/c158eb7d6864d483ce3102eac3655a2d7f8c0123/src/ts/spatialnavigation/NavigationGroup.ts#L224">src/ts/spatialnavigation/NavigationGroup.ts:224</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="handlenavigation"><span>handle<wbr/>Navigation</span><a href="#handlenavigation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="handlenavigation-1"><span class="tsd-kind-call-signature">handleNavigation</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">direction</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Direction</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#handlenavigation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Handles a navigation event.</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">direction</span>: <span class="tsd-signature-type">Direction</span></span><div class="tsd-comment tsd-typography"><p>The direction of the navigation event</p>
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><p>true if navigation was successful, false otherwise</p>
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/c158eb7d6864d483ce3102eac3655a2d7f8c0123/src/ts/spatialnavigation/NavigationGroup.ts#L203">src/ts/spatialnavigation/NavigationGroup.ts:203</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="release"><span>release</span><a href="#release" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="release-1"><span class="tsd-kind-call-signature">release</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#release-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Dispose of navigation group</p>
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/c158eb7d6864d483ce3102eac3655a2d7f8c0123/src/ts/spatialnavigation/NavigationGroup.ts#L305">src/ts/spatialnavigation/NavigationGroup.ts:305</a></li></ul></aside></div></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#container"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>container</span></a><a href="#onaction"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Action</span></a><a href="#onnavigation"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Navigation</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#disable"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>disable</span></a><a href="#enable"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>enable</span></a><a href="#focusfirstcomponent"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>focus<wbr/>First<wbr/>Component</span></a><a href="#getactivecomponent"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Active<wbr/>Component</span></a><a href="#handleaction"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>handle<wbr/>Action</span></a><a href="#handlenavigation"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>handle<wbr/>Navigation</span></a><a href="#release"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>release</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">bitmovin-player-ui</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>