@coveo/headless
    Preparing search index...

    Interface SpotlightContent

    interface SpotlightContent {
        altText?: string;
        clickUri: string;
        description?: string;
        descriptionFontColor?: string;
        desktopImage: string;
        id: string;
        mobileImage?: string;
        name?: string;
        nameFontColor?: string;
        position: number;
        responseId?: string;
        resultType: SPOTLIGHT;
    }

    Hierarchy

    • ResultPosition
    • BaseSpotlightContent
      • SpotlightContent
    Index

    Properties

    altText? clickUri description? descriptionFontColor? desktopImage id mobileImage? name? nameFontColor? position responseId? resultType

    Properties

    altText?: string

    The accessibility text for the image.

    clickUri: string

    The URI to navigate to when the spotlight content is clicked.

    description?: string

    The description of the spotlight content.

    descriptionFontColor?: string

    The font color for the description text in hex format (e.g. #ffffff).

    desktopImage: string

    The image URL for desktop display.

    id: string

    The unique identifier of the spotlight content.

    mobileImage?: string

    The image URL for mobile display.

    name?: string

    The name of the spotlight content.

    nameFontColor?: string

    The font color for the name text in hex format (e.g. #ffffff).

    position: number

    The 1-based result's position across the non-paginated result set.

    For example, if the result is the third one on the second page, and there are 10 results per page, its position is 13 (not 3).

    responseId?: string

    The ID of the response that returned the spotlight content.

    resultType: SPOTLIGHT

    The result type identifier, always SPOTLIGHT for spotlight content.

    Settings

    Member Visibility
    In this article
    Properties