<media-pip-button>
The <media-pip-button>
component is used to toggle the picture-in-picture mode of the video.
The contents and behavior of the <media-pip-button>
will update automatically based on the PiP state and availability.
- When the media is not in PiP mode, the component will switch to display the contents of the
enter
slot. - When the media is PiP mode, the component will switch to display the contents of the
exit
slot.
Default usage
Section titled Default usageCustomize icons
Section titled Customize iconsYou can modify the contents of the <media-pip-button>
component using slots.
This is useful if you’d like to use your own custom PiP button instead of the default one provided by media-chrome.
Here’s an example of how you can replace the default PiP icons with the words “Enter” and “Exit”
Styling with attributes
Section titled Styling with attributesThe <media-pip-button>
doesn’t expose any configuration attributes.
However, it will be updated with Media UI Attributes any time the PiP state and availability changes.
You can use these attributes to style the button. For example, hide the button if PiP is unavailable:
media-pip-button:not([mediapipunavailable]) {
display: none;
}
Or make the background blue if the media is in PiP mode.
media-pip-button[mediaispip] {
--media-control-background: blue;
}
Reference
Section titled ReferenceSlots
Section titled SlotsName | Description |
---|---|
enter |
An element shown when the media is not in PIP mode and pressing the button will trigger entering PIP mode. |
exit |
An element shown when the media is in PIP and pressing the button will trigger exiting PIP mode. |
Attributes
Section titled AttributesName | Type | Description |
---|---|---|
disabled |
boolean |
The Boolean disabled attribute makes the element not mutable or focusable. |
mediacontroller |
string |
The element `id` of the media controller to connect to (if not nested within). |
Media UI Attributes
Section titled Media UI Attributes
The media UI attributes will be set automatically by the controller if they are
connected via nesting or the mediacontroller
attribute.
Only set these attributes manually if you know what you're doing.
Name | Type | Description |
---|---|---|
mediapipunavailable |
(unavailable|unsupported) |
Set if picture-in-picture is unavailable. |
mediaispip |
boolean |
Present if the media is playing in picture-in-picture. |
CSS Variables
Section titled CSS VariablesName | Default | Description |
---|---|---|
--media-pip-button-display |
inline-flex |
`display` property of button. |
--media-primary-color |
rgb(238 238 238) |
Default color of text and icon. |
--media-secondary-color |
rgb(20 20 30 / .7) |
Default color of button background. |
--media-text-color |
var(--media-primary-color, rgb(238 238 238)) |
`color` of button text. |
--media-icon-color |
var(--media-primary-color, rgb(238 238 238)) |
`fill` color of button icon. |
--media-control-display |
`display` property of control. | |
--media-control-background |
var(--media-secondary-color, rgb(20 20 30 / .7)) |
`background` of control. |
--media-control-hover-background |
rgba(50 50 70 / .7) |
`background` of control hover state. |
--media-control-padding |
10px |
`padding` of control. |
--media-control-height |
24px |
`line-height` of control. |
--media-font |
var(--media-font-weight, bold) var(--media-font-size, 14px) / var(--media-text-content-height, var(--media-control-height, 24px)) var(--media-font-family, helvetica neue, segoe ui, roboto, arial, sans-serif) |
`font` shorthand property. |
--media-font-weight |
bold |
`font-weight` property. |
--media-font-family |
helvetica neue, segoe ui, roboto, arial, sans-serif |
`font-family` property. |
--media-font-size |
14px |
`font-size` property. |
--media-text-content-height |
var(--media-control-height, 24px) |
`line-height` of button text. |
--media-button-icon-width |
`width` of button icon. | |
--media-button-icon-height |
var(--media-control-height, 24px) |
`height` of button icon. |
--media-button-icon-transform |
`transform` of button icon. | |
--media-button-icon-transition |
`transition` of button icon. |