GuidesAPI ReferenceRelease Notes
HomeLog InHome
Guides

Blaze Moments Gradient

The headerGradient and footerGradient props are specific to the BlazePlayerMomentTheme type. They define the configuration for the header or footer gradient in moments player view components. These properties allow you to customize the appearance of the header and footer gradients, providing flexibility in styling the Blaze Moments player according to your design preferences.

Properties

isVisible

isVisible: boolean = true

A flag indicates whether the gradient is visible. Defaults to 'true'

startColor

startColor: string = '#000000FF' //Hex

The start color of the gradient. Defaults to BLACK

endColor

endColor: string = '#00000000' //Hex

The end color of the gradient. Defaults to TRANSPARENT

endPositioning - Only for footer gradient

endPositioning: PlayerFooterGradientPositioning =  'BottomToPlayer' | 'BottomToContainer';

The end point at which the gradient begins on the screen is determined by
the ending position of the player or the container

Initialization

The Blaze Moments Gradient can be initialized in Moments player view component props with custom values for its properties or with the default values:

BlazeMomentsHeaderGradient

interface BlazeMomentsHeaderGradient {
  isVisible: boolean;
  startColor: string; //Hex
  endColor: string; //Hex
}

BlazeMomentsFooterGradient

interface BlazeMomentsFooterGradient {
  isVisible: boolean;
  startColor: string; //Hex
  endColor: string; //Hex
  endPositioning: PlayerFooterGradientPositioning;
}

Did this page help you?