Interface SocialSharingItem

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

Remarks


- Available since v2.14.5.

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

Properties

icon? label? src text?

Properties

Optional icon

icon?: string

The icon which is displayed as a clickable sharing option.

Remarks


- It cannot be combined with SocialSharingItem.text.

Optional label

label?: string

The label of the clickable sharing option.

Remarks


- For example, to add the title.

src

src: string

The URL that will be shared.

Remarks


- 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.

Default Value

SocialSharing.url if present, else location.href.

Optional text

text?: string

The text which is displayed as a clickable sharing option.

Remarks


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

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc