THEOplayer Web SDK
    Preparing search index...

    Interface SocialSharingItem

    Represents a social media to which the player can share content.


    - Available since v2.14.5.

    interface SocialSharingItem {
        icon?: string;
        label?: string;
        src: string;
        text?: string;
    }
    Index

    Properties

    icon? label? src text?

    Properties

    icon?: string

    The icon which is displayed as a clickable sharing option.


    - It cannot be combined with SocialSharingItem.text.

    label?: string

    The label of the clickable sharing option.


    - For example, to add the title.

    src: string

    The URL that will be shared.


    - Overrides SocialSharing.url.
    - This can also be a string with the <URL> token. The token will be replaced by SocialSharing.url.
    - It can not be combined with SocialSharingItem.text.

    SocialSharing.url if present, else location.href.

    Optionaltext

    text?: string

    The text which is displayed as a clickable sharing option.


    - For example, to add embed codes.
    - It cannot be combined with SocialSharingItem.icon or SocialSharingItem.src.

    Settings

    Member Visibility

    On This Page

    Properties