vime-pip-control

A control for toggling picture-in-picture (PiP) mode. This control is not displayed if PiP cannot be requested (checked via the canSetPiP() player method).

Visual

Vime mute control component

Usage

<vime-player>
<!-- ... -->
<vime-ui>
<!-- ... -->
<vime-controls>
<!-- ... -->
<vime-pip-control></vime-pip-control>
</vime-controls>
</vime-ui>
</vime-player>

Properties

PropertyAttributeDescriptionTypeDefault
enterIconenter-iconThe URL to an SVG element or fragment to display for entering PiP.string'#vime-enter-pip'
exitIconexit-iconThe URL to an SVG element or fragment to display for exiting PiP.string'#vime-exit-pip'
hideTooltiphide-tooltipWhether the tooltip should not be displayed.booleanfalse
keyskeysA slash (/) separated string of JS keyboard keys (KeyboardEvent.key), that when caught in a keydown event, will trigger a click event on the control.string ∣ undefined'p'
tooltipDirectiontooltip-directionThe direction in which the tooltip should grow."left" ∣ "right" ∣ undefinedundefined
tooltipPositiontooltip-positionWhether the tooltip is positioned above/below the control."bottom" ∣ "top"'top'

Dependencies

Used by

Depends on

Graph

graph TD;
vime-pip-control --> vime-control
vime-pip-control --> vime-icon
vime-pip-control --> vime-tooltip
vime-default-controls --> vime-pip-control
style vime-pip-control fill:#f9f,stroke:#333,stroke-width:4px

Built with StencilJS