Settings
AddonsCard design schemaElement typesSocial Bar

SocialBar

Allows you to display and configure the socialbar component.

Interface

interface INewSocialBar extends IElement {
  contentUniqueId: string;
  socialStats: ISocialStats;
  statItems?: Array<ISocialItem | SocialStats>;
  overflowItems?: Array<ISocialItem | SocialStats>;
  highlightedItem?: ISocialItem | SocialActions;
  callToSetView?: boolean;
  urls?: IUrl;
  baseType?: BaseType;
}

Example

NewSocialBar
{
  "type": "NewSocialBar",
  "contentUniqueId": "{base.uniqueId}",
  "socialStats": "{base.socials}",
  "statItems": ["Likes", "Comments", "Views"],
  "highlightedItem": "Bookmark",
  "overflowItems": [
    "Tags",
    "Favorite",
    "Share",
    "Feedback",
    "Follow",
    {
      "key": "GoToDetail",
      "text": {
        "t": "common.goToDetail"
      },
      "icon": "OpenInNewWindow",
      "onClick": {
        "type": "OpenUrl",
        "url": "{base.urls.contentPageUrl}",
        "setView": true
      },
      "propertyName": "open"
    },
    {
      "key": "Open",
      "text": {
        "t": "common.open"
      },
      "icon": "OpenFile",
      "onClick": {
        "type": "OpenUrl",
        "url": "{base.urls.detailUrl}"
      },
      "propertyName": "open"
    },
    {
      "key": "OpenFileLocation",
      "text": {
        "t": "common.openFileLocation"
      },
      "icon": "FabricOpenFolderHorizontal",
      "onClick": {
        "type": "OpenUrl",
        "url": "{base.urls.fileLocation}"
      },
      "propertyName": "openLocation"
    },
    {
      "key": "ViewDetail",
      "text": {
        "t": "common.viewDetail"
      },
      "icon": "OpenInNewWindow",
      "onClick": {
        "type": "OpenForm",
        "formId": "6dd996da-ee6f-4233-b079-fb4e5f94b417"
      },
      "propertyName": "view"
    },
    {
      "key": "Translate",
      "text": {
        "t": "common.translation"
      },
      "icon": "LocaleLanguage",
      "onClick": {
        "type": "Translate"
      },
      "propertyName": "translate",
      "visible": "{base.translation.active}"
    },
    {
      "key": "CopyLink",
      "text": {
        "t": "common.copyLink"
      },
      "icon": "Copy",
      "onClick": {
        "type": "CopyLink"
      },
      "propertyName": "copy"
    }
  ],
  "callToSetView": false,
  "urls": "{base.urls}",
  "baseType": "{base.baseType}"
}

Properties

type

Must be “NewSocialBar”.

  • Type: "NewSocialBar"

  • Required: Yes

contentUniqueId

Unique id of de content.

  • Type: string

  • Required: Yes

socialStats

Statistics and social settings.

statItems

Overwrite social stat items. If no item is indicated, by default it will show likes, views, and comments.

overflowItems

Overwrite social bar three-dot menu items. If no item is indicated, by default it will share and feedback.

highlightedItem

Highlight the item indicated next to the three dots, by default it will not show anything.

callToSetView

if “true”, the API will be called to indicate that the current page has been visited.

  • Type: boolean

  • Required: No

urls

Set of urls required for the share panel copy link option.

  • Type: IUrl

  • Required: No

baseType

Specifies the base type to which the content belongs.

Related CardTags