TourTipPluginInterface
interface TourTipPluginInterface implements TipPluginInterface (View source)
Defines an interface for tour items.
Methods
Returns the selector the tour tip will attach to.
Returns the body content of the tooltip.
Returns the configured placement of the tip relative to the element.
Details
string
id()
Returns id of the tip.
string
getLabel()
Returns label of the tip.
string
getWeight()
Returns weight of the tip.
array
getAttributes()
deprecated
deprecated
Returns an array of attributes for the tip wrapper.
string
get($key)
Used for returning values by key.
set($key, $value)
Used for returning values by key.
array
getOutput()
deprecated
deprecated
Returns a renderable array.
string|null
getSelector()
Returns the selector the tour tip will attach to.
This typically maps to the Shepherd Step options attachTo.element
property.
array
getBody()
Returns the body content of the tooltip.
This typically maps to the Shepherd Step options text property.
string|null
getLocation()
Returns the configured placement of the tip relative to the element.
If null, the tip will automatically determine the best position based on the element's position in the viewport.
This typically maps to the Shepherd Step options attachTo.on property.