Player Attributes

As Firework custom elements are configured using HTML attributes, Player attributes will affect Video Player behavior

hide_show_detail

Hides the show detailed button on the product detail page. Defaults to false.

share

hash | query

Similar to router. Share link in player will be yours url instead of "fw.tv". Can be used independently of router settings.

  • hash - uses hash # portion of your page url

  • query - uses query ? search parameter

share_template

URL template to be used as a share link base along with the share attribute. Example: https://example.com/videos?utm-source=fw-share

player_margin

CSS string to specify minimized player distance from the edges. Works in conjunction with player_placement

player_placement

top-left | top-right | bottom-right | bottom-left

Position of the minimized video player. Defaults to bottom-right

player_minimize

true | false

Allow player to be minimized. Defaults to true

pip

true | false

Picture in picture mode. Defaults to false

Please note, necessary prerequisites needs to be met for PIP to work properly.

pip_navigate

true | false

Disables navigation upon PIP link is clicked. Behavior suited for single page applications where navigation happens programmatically. Defaults to true

product_card

true | false

Whether to display product card carousel. Defaults to true.

reset_transform

fullscreen | always | never

Removes CSS transform and relative position from ancestor elements. Transform and relative position present on the parent elements will cause the creation of a new stacking context which will screw up with z-indexes. Setting reset_transform to always is usually the solution to the missing floating PIP player.

Last updated