Reference

Provider

Whenever you're dealing with a provider in your template, you're actually working with a Provider object.

Properties

name

Type: string

The name of the provider.

handle

Type: string

The handle of the provider.

primaryColor

Type: string|null

The primary brand color of the provider.

icon

Type: string|null

The SVG icon of the provider.

Methods

getShareUrl(url, text, params)

Returns: string|null

The share URL unique to each provider.

getShareButton(options)

Returns: verbb\socialshare\models\ShareButton|null

Returns the Share Button.

renderShareButton(options)

Returns: Twig\Markup|null

Returns the rendered HTML for the Share Button.

getButton(options)

Returns: verbb\socialshare\models\Button|null

Returns the Button.

renderButton(options)

Returns: Twig\Markup|null

Returns the rendered HTML for the Button.