Interface RowProps

interface RowProps {
    arrowButtonBaseClassName?: string;
    arrowButtonBaseStyle?: CSSProperties;
    arrowButtonDisabledClassName?: string;
    arrowButtonDisabledStyle?: CSSProperties;
    arrowButtonEnabledClassName?: string;
    arrowButtonEnabledStyle?: CSSProperties;
    arrowColor?: string;
    arrowContainerDivProps?: HtmlDivProps;
    catalogLogoImageProps?: HtmlImgProps;
    catalogLogoType?: CatalogLogoType;
    convertChangeToText?: ((change: Change) => string);
    getLeftArrow?: ((props: ArrowProps) => ReactNode);
    getRightArrow?: ((props: ArrowProps) => ReactNode);
    getTitleDiv?: ((title?: string, props?: HtmlDivProps) => ReactNode);
    leftArrowAccessibilityText?: string;
    posterContainerAnchorProps?: HtmlAnchorProps;
    posterImageProps?: HtmlImgProps;
    posterListContainerDivProps?: HtmlDivProps;
    posterType?: PosterType;
    priorityCatalogs?: Catalog[];
    rightArrowAccessibilityText?: string;
    rootDivProps?: HtmlDivProps;
    source: Source;
    textDivProps?: HtmlDivProps;
    title?: string;
    titleDivProps?: HtmlDivProps;
    topBarDivProps?: HtmlDivProps;
}

Hierarchy (view full)

Properties

arrowButtonBaseClassName? arrowButtonBaseStyle? arrowButtonDisabledClassName? arrowButtonDisabledStyle? arrowButtonEnabledClassName? arrowButtonEnabledStyle? arrowColor? arrowContainerDivProps? catalogLogoImageProps? catalogLogoType? convertChangeToText? getLeftArrow? getRightArrow? getTitleDiv? leftArrowAccessibilityText? posterContainerAnchorProps? posterImageProps? posterListContainerDivProps? posterType? priorityCatalogs? rightArrowAccessibilityText? rootDivProps? source textDivProps? title? titleDivProps? topBarDivProps?

Properties

OptionalarrowButtonBaseClassName

arrowButtonBaseClassName?: string

The base class name for the arrow buttons. Applied to both the left and right arrow buttons all the time.

OptionalarrowButtonBaseStyle

arrowButtonBaseStyle?: CSSProperties

The base style for the arrow buttons. Applied to both the left and right arrow buttons all the time.

OptionalarrowButtonDisabledClassName

arrowButtonDisabledClassName?: string

The class name for arrows only applied when the arrow is disabled.

OptionalarrowButtonDisabledStyle

arrowButtonDisabledStyle?: CSSProperties

The style for arrows only applied when the arrow is disabled

OptionalarrowButtonEnabledClassName

arrowButtonEnabledClassName?: string

The class name for arrows only applied when the arrow is enabled.

OptionalarrowButtonEnabledStyle

arrowButtonEnabledStyle?: CSSProperties

The style for arrows only applied when the arrow is enabled.

OptionalarrowColor

arrowColor?: string

OptionalarrowContainerDivProps

arrowContainerDivProps?: HtmlDivProps

The props for the arrow container div that contains the arrows.

OptionalcatalogLogoImageProps

catalogLogoImageProps?: HtmlImgProps

The props for the catalog logo image.

OptionalcatalogLogoType

catalogLogoType?: CatalogLogoType

The type of the catalog logo to display.

Default Value

"dark"

OptionalconvertChangeToText

convertChangeToText?: ((change: Change) => string)

The function to convert a change to text. Such as converting an "upcoming" change to "Coming Soon on August 1". The text will be displayed below the catalog logo. If not provided, the default English.convertChangeToText will be used. You can check that function as an example to create your own.

This function is only used if there's a highlighted change.

A highlighted change is automatically picked, if the poster is displayed within a Row or a Grid component with a ChangesSource.

Default Value

English.convertChangeToText

OptionalgetLeftArrow

getLeftArrow?: ((props: ArrowProps) => ReactNode)

The function to get the left arrow component. If not provided, a default left arrow will be used.

OptionalgetRightArrow

getRightArrow?: ((props: ArrowProps) => ReactNode)

The function to get the right arrow component. If not provided, a default right arrow will be used.

OptionalgetTitleDiv

getTitleDiv?: ((title?: string, props?: HtmlDivProps) => ReactNode)

A function to create the title div. If not supplied, a default title div will be created if a title is provided.

OptionalleftArrowAccessibilityText

leftArrowAccessibilityText?: string

The accessibility text for the left arrow.

Default Value

"Left arrow"

OptionalposterContainerAnchorProps

posterContainerAnchorProps?: HtmlAnchorProps

The props for the root anchor that contains the poster, the catalog logo and the text div.

OptionalposterImageProps

posterImageProps?: HtmlImgProps

The props for the poster image.

OptionalposterListContainerDivProps

posterListContainerDivProps?: HtmlDivProps

The props for the poster list container div that contains the posters.

OptionalposterType

posterType?: PosterType

The type of the poster to display.

Default Value

"horizontal"

OptionalpriorityCatalogs

priorityCatalogs?: Catalog[]

The priority catalogs to use when displaying the shows. The catalogs are prioritized in the order they are provided.

If a show is available in multiple streaming catalogs, the first catalog in the list that contains the show will be used when showing the catalog logo and deep link.

OptionalrightArrowAccessibilityText

rightArrowAccessibilityText?: string

The accessibility text for the right arrow.

Default Value

"Right arrow"

OptionalrootDivProps

rootDivProps?: HtmlDivProps

The props for the root div that contains the entire row.

source

source: Source

The source of the items to display in the row.

See

Source

OptionaltextDivProps

textDivProps?: HtmlDivProps

The props for the text div to display the text below the catalog logo regarding the highlighted change such as "Coming Soon on August 1".

This field is only used if there's a highlighted change.

A highlighted change is automatically picked, if the poster is displayed within a Row or a Grid component with a ChangesSource.

Optionaltitle

title?: string

Title to display above the row.

OptionaltitleDivProps

titleDivProps?: HtmlDivProps

The props for the title div.

OptionaltopBarDivProps

topBarDivProps?: HtmlDivProps

The props for the top bar div that contains the title and arrows.

Settings

Member Visibility

On This Page

Properties