bitmovin-player-ui
Version:
Bitmovin Player UI Framework
47 lines (46 loc) • 34.3 kB
HTML
<html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>UIContainerConfig | 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">UIContainerConfig</a></li></ul><h1>Interface UIContainerConfig</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Configuration interface for a <a href="../classes/UIContainer.html" class="tsd-kind-class">UIContainer</a>.</p>
</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">UIContainerConfig</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#arialabel">ariaLabel</a><span class="tsd-signature-symbol">?:</span> <a href="../types/LocalizableText.html" class="tsd-signature-type tsd-kind-type-alias">LocalizableText</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#components">components</a><span class="tsd-signature-symbol">?:</span> <a href="../classes/Component.html" class="tsd-signature-type tsd-kind-class">Component</a><span class="tsd-signature-symbol"><</span><a href="ComponentConfig.html" class="tsd-signature-type tsd-kind-interface">ComponentConfig</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#cssclass">cssClass</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#cssclasses">cssClasses</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#cssprefix">cssPrefix</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#deferuihidewhilesettingsopen">deferUiHideWhileSettingsOpen</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#disabled">disabled</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#hidden">hidden</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#hidedelay">hideDelay</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#hideimmediatelyonmouseleave">hideImmediatelyOnMouseLeave</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#hideplayerstateexceptions">hidePlayerStateExceptions</a><span class="tsd-signature-symbol">?:</span> <a href="../enums/PlayerUtils.PlayerState.html" class="tsd-signature-type tsd-kind-enum">PlayerState</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#id">id</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#role">role</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#tabindex">tabIndex</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#tag">tag</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#userinteractioneventsource">userInteractionEventSource</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">HTMLElement</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel tsd-hierarchy" data-refl="3536"><h4>Hierarchy (<a href="../hierarchy.html#UIContainerConfig">View Summary</a>)</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><a href="ContainerConfig.html" class="tsd-signature-type tsd-kind-interface">ContainerConfig</a><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">UIContainerConfig</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/5625eaf297b28370b8918d403e774f4cc0d2da1d/src/ts/components/UIContainer.ts#L19">src/ts/components/UIContainer.ts:19</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">Properties</h3><div class="tsd-index-list"><a href="#arialabel" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>aria<wbr/>Label?</span></a>
<a href="#components" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>components?</span></a>
<a href="#cssclass" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>css<wbr/>Class?</span></a>
<a href="#cssclasses" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>css<wbr/>Classes?</span></a>
<a href="#cssprefix" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>css<wbr/>Prefix?</span></a>
<a href="#deferuihidewhilesettingsopen" 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>defer<wbr/>Ui<wbr/>Hide<wbr/>While<wbr/>Settings<wbr/>Open?</span></a>
<a href="#disabled" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>disabled?</span></a>
<a href="#hidden" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>hidden?</span></a>
<a href="#hidedelay" 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>hide<wbr/>Delay?</span></a>
<a href="#hideimmediatelyonmouseleave" 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>hide<wbr/>Immediately<wbr/>On<wbr/>Mouse<wbr/>Leave?</span></a>
<a href="#hideplayerstateexceptions" 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>hide<wbr/>Player<wbr/>State<wbr/>Exceptions?</span></a>
<a href="#id" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>id?</span></a>
<a href="#role" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>role?</span></a>
<a href="#tabindex" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>tab<wbr/>Index?</span></a>
<a href="#tag" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>tag?</span></a>
<a href="#userinteractioneventsource" 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>user<wbr/>Interaction<wbr/>Event<wbr/>Source?</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-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 tsd-is-inherited"><h3 class="tsd-anchor-link" id="arialabel"><code class="tsd-tag">Optional</code><span>aria<wbr/>Label</span><a href="#arialabel" 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">ariaLabel</span><span class="tsd-signature-symbol">?:</span> <a href="../types/LocalizableText.html" class="tsd-signature-type tsd-kind-type-alias">LocalizableText</a></div><div class="tsd-comment tsd-typography"><p>WCAG20 standard for defining info about the component (usually the name)</p>
</div><aside class="tsd-sources"><p>Inherited from <a href="ContainerConfig.html">ContainerConfig</a>.<a href="ContainerConfig.html#arialabel">ariaLabel</a></p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/5625eaf297b28370b8918d403e774f4cc0d2da1d/src/ts/components/Component.ts#L66">src/ts/components/Component.ts:66</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="components"><code class="tsd-tag">Optional</code><span>components</span><a href="#components" 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">components</span><span class="tsd-signature-symbol">?:</span> <a href="../classes/Component.html" class="tsd-signature-type tsd-kind-class">Component</a><span class="tsd-signature-symbol"><</span><a href="ComponentConfig.html" class="tsd-signature-type tsd-kind-interface">ComponentConfig</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>Child components of the container.</p>
</div><aside class="tsd-sources"><p>Inherited from <a href="ContainerConfig.html">ContainerConfig</a>.<a href="ContainerConfig.html#components">components</a></p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/5625eaf297b28370b8918d403e774f4cc0d2da1d/src/ts/components/Container.ts#L15">src/ts/components/Container.ts:15</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="cssclass"><code class="tsd-tag">Optional</code><span>css<wbr/>Class</span><a href="#cssclass" 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">cssClass</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The CSS classes of the component. This is usually the class from where the component takes its styling.</p>
</div><aside class="tsd-sources"><p>Inherited from <a href="ContainerConfig.html">ContainerConfig</a>.<a href="ContainerConfig.html#cssclass">cssClass</a></p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/5625eaf297b28370b8918d403e774f4cc0d2da1d/src/ts/components/Component.ts#L34">src/ts/components/Component.ts:34</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="cssclasses"><code class="tsd-tag">Optional</code><span>css<wbr/>Classes</span><a href="#cssclasses" 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">cssClasses</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>Additional CSS classes of the component.</p>
</div><aside class="tsd-sources"><p>Inherited from <a href="ContainerConfig.html">ContainerConfig</a>.<a href="ContainerConfig.html#cssclasses">cssClasses</a></p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/5625eaf297b28370b8918d403e774f4cc0d2da1d/src/ts/components/Component.ts#L39">src/ts/components/Component.ts:39</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="cssprefix"><code class="tsd-tag">Optional</code><span>css<wbr/>Prefix</span><a href="#cssprefix" 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">cssPrefix</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>A prefix to prepend all CSS classes with.</p>
</div><aside class="tsd-sources"><p>Inherited from <a href="ContainerConfig.html">ContainerConfig</a>.<a href="ContainerConfig.html#cssprefix">cssPrefix</a></p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/5625eaf297b28370b8918d403e774f4cc0d2da1d/src/ts/components/Component.ts#L29">src/ts/components/Component.ts:29</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="deferuihidewhilesettingsopen"><code class="tsd-tag">Optional</code><span>defer<wbr/>Ui<wbr/>Hide<wbr/>While<wbr/>Settings<wbr/>Open</span><a href="#deferuihidewhilesettingsopen" 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">deferUiHideWhileSettingsOpen</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>When true, suspend the UIContainer's hide timer while a SettingsPanel is open,
and resume it when the panel closes.
Default: true</p>
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/5625eaf297b28370b8918d403e774f4cc0d2da1d/src/ts/components/UIContainer.ts#L49">src/ts/components/UIContainer.ts:49</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="disabled"><code class="tsd-tag">Optional</code><span>disabled</span><a href="#disabled" 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">disabled</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Specifies if the component is enabled (interactive) or not.
Default: false</p>
</div><aside class="tsd-sources"><p>Inherited from <a href="ContainerConfig.html">ContainerConfig</a>.<a href="ContainerConfig.html#disabled">disabled</a></p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/5625eaf297b28370b8918d403e774f4cc0d2da1d/src/ts/components/Component.ts#L51">src/ts/components/Component.ts:51</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="hidden"><code class="tsd-tag">Optional</code><span>hidden</span><a href="#hidden" 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">hidden</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Specifies if the component should be hidden at startup.
Default: false</p>
</div><aside class="tsd-sources"><p>Inherited from <a href="ContainerConfig.html">ContainerConfig</a>.<a href="ContainerConfig.html#hidden">hidden</a></p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/5625eaf297b28370b8918d403e774f4cc0d2da1d/src/ts/components/Component.ts#L45">src/ts/components/Component.ts:45</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="hidedelay"><code class="tsd-tag">Optional</code><span>hide<wbr/>Delay</span><a href="#hidedelay" 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">hideDelay</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>The delay in milliseconds after which the control bar will be hidden when there is no user interaction.
Set to -1 for the UI to be always shown.
Default: 2 seconds (2000)</p>
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/5625eaf297b28370b8918d403e774f4cc0d2da1d/src/ts/components/UIContainer.ts#L25">src/ts/components/UIContainer.ts:25</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="hideimmediatelyonmouseleave"><code class="tsd-tag">Optional</code><span>hide<wbr/>Immediately<wbr/>On<wbr/>Mouse<wbr/>Leave</span><a href="#hideimmediatelyonmouseleave" 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">hideImmediatelyOnMouseLeave</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Specify whether the UI should be hidden immediatly if the mouse leaves the userInteractionEventSource.
If false or not set it will wait for the hideDelay.
Default: true</p>
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/5625eaf297b28370b8918d403e774f4cc0d2da1d/src/ts/components/UIContainer.ts#L42">src/ts/components/UIContainer.ts:42</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="hideplayerstateexceptions"><code class="tsd-tag">Optional</code><span>hide<wbr/>Player<wbr/>State<wbr/>Exceptions</span><a href="#hideplayerstateexceptions" 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">hidePlayerStateExceptions</span><span class="tsd-signature-symbol">?:</span> <a href="../enums/PlayerUtils.PlayerState.html" class="tsd-signature-type tsd-kind-enum">PlayerState</a><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>An array of player states in which the UI will not be hidden, no matter what the <a href="#hidedelay" class="tsd-kind-property">hideDelay</a> is.</p>
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/5625eaf297b28370b8918d403e774f4cc0d2da1d/src/ts/components/UIContainer.ts#L29">src/ts/components/UIContainer.ts:29</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="id"><code class="tsd-tag">Optional</code><span>id</span><a href="#id" 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">id</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The HTML ID of the component.
Default: automatically generated with pattern 'ui-id-{guid}'.</p>
</div><aside class="tsd-sources"><p>Inherited from <a href="ContainerConfig.html">ContainerConfig</a>.<a href="ContainerConfig.html#id">id</a></p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/5625eaf297b28370b8918d403e774f4cc0d2da1d/src/ts/components/Component.ts#L24">src/ts/components/Component.ts:24</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="role"><code class="tsd-tag">Optional</code><span>role</span><a href="#role" 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">role</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Specifies the component role for WCAG20 standard</p>
</div><aside class="tsd-sources"><p>Inherited from <a href="ContainerConfig.html">ContainerConfig</a>.<a href="ContainerConfig.html#role">role</a></p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/5625eaf297b28370b8918d403e774f4cc0d2da1d/src/ts/components/Component.ts#L56">src/ts/components/Component.ts:56</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="tabindex"><code class="tsd-tag">Optional</code><span>tab<wbr/>Index</span><a href="#tabindex" 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">tabIndex</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>WCAG20 requirement for screen reader navigation</p>
</div><aside class="tsd-sources"><p>Inherited from <a href="ContainerConfig.html">ContainerConfig</a>.<a href="ContainerConfig.html#tabindex">tabIndex</a></p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/5625eaf297b28370b8918d403e774f4cc0d2da1d/src/ts/components/Component.ts#L61">src/ts/components/Component.ts:61</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="tag"><code class="tsd-tag">Optional</code><span>tag</span><a href="#tag" 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">tag</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The HTML tag name of the component.
Default: 'div'</p>
</div><aside class="tsd-sources"><p>Inherited from <a href="ContainerConfig.html">ContainerConfig</a>.<a href="ContainerConfig.html#tag">tag</a></p><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/5625eaf297b28370b8918d403e774f4cc0d2da1d/src/ts/components/Component.ts#L19">src/ts/components/Component.ts:19</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="userinteractioneventsource"><code class="tsd-tag">Optional</code><span>user<wbr/>Interaction<wbr/>Event<wbr/>Source</span><a href="#userinteractioneventsource" 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">userInteractionEventSource</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">HTMLElement</span></div><div class="tsd-comment tsd-typography"><p>The HTML element on which user interaction events (e.g. mouse and touch events) will be tracked to detect
interaction with the UI. These basically trigger showing and hiding of the UI.
Default: the UI container itself</p>
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/bitmovin/bitmovin-player-ui/blob/5625eaf297b28370b8918d403e774f4cc0d2da1d/src/ts/components/UIContainer.ts#L35">src/ts/components/UIContainer.ts:35</a></li></ul></aside></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-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="#arialabel" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>aria<wbr/>Label</span></a><a href="#components" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>components</span></a><a href="#cssclass" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>css<wbr/>Class</span></a><a href="#cssclasses" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>css<wbr/>Classes</span></a><a href="#cssprefix" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>css<wbr/>Prefix</span></a><a href="#deferuihidewhilesettingsopen"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>defer<wbr/>Ui<wbr/>Hide<wbr/>While<wbr/>Settings<wbr/>Open</span></a><a href="#disabled" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>disabled</span></a><a href="#hidden" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>hidden</span></a><a href="#hidedelay"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>hide<wbr/>Delay</span></a><a href="#hideimmediatelyonmouseleave"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>hide<wbr/>Immediately<wbr/>On<wbr/>Mouse<wbr/>Leave</span></a><a href="#hideplayerstateexceptions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>hide<wbr/>Player<wbr/>State<wbr/>Exceptions</span></a><a href="#id" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>id</span></a><a href="#role" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>role</span></a><a href="#tabindex" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>tab<wbr/>Index</span></a><a href="#tag" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>tag</span></a><a href="#userinteractioneventsource"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>user<wbr/>Interaction<wbr/>Event<wbr/>Source</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>