function TipPluginInterface::getLocation
Same name in other branches
- 10 core/modules/tour/src/TipPluginInterface.php \Drupal\tour\TipPluginInterface::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.
Return value
string|null The tip placement relative to the element.
See also
https://shepherdjs.dev/docs/Step.html
1 method overrides TipPluginInterface::getLocation()
- TipPluginBase::getLocation in core/
modules/ tour/ src/ TipPluginBase.php - Returns the configured placement of the tip relative to the element.
File
-
core/
modules/ tour/ src/ TipPluginInterface.php, line 88
Class
- TipPluginInterface
- Defines an interface for tour items.
Namespace
Drupal\tourCode
public function getLocation() : ?string;
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.