For the complete documentation index, see llms.txt. This page is also available as Markdown.

Configuration

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

Name
Description
Default Value

hide_show_detail

Hides the show detailed button on the product detail page

false

muted

Whether to open the video in fullscreen as muted.

false

pip

true | false

Picture in picture mode. Please note, necessary prerequisites needs to be met for PIP to work properly.

false

pip_navigate

true | false

Disables navigation upon PIP link is clicked. Behaviour suited for single page applications where navigation happens programmatically.

true

pip_target

_self | _blank Where to open PIP links. Setting to _blank will open the links in a new tab. Defaults to PIP iframe.

player_margin

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

player_minimize

true | false

Allow player to be minimized.

true

player_placement

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

Position of the minimized video player.

bottom-right

player_fullscreen

true | false Showing of Fullscreen button in player’s header

true

product_card

true | false

Whether to display product card carousel.

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.

share

hash | query | false 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 false - hides the share button on player

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_unmute

true | false Show/hide any unmute related UI elements

false

Last updated

Was this helpful?