function TipPluginInterface::getSelector

Same name and namespace in other branches
  1. 10 core/modules/tour/src/TipPluginInterface.php \Drupal\tour\TipPluginInterface::getSelector()

Returns the selector the tour tip will attach to.

This typically maps to the Shepherd Step options `attachTo.element` property.

Return value

null|string A selector string, or null for an unattached tip.

See also

https://shepherdjs.dev/docs/Step.html

1 method overrides TipPluginInterface::getSelector()
TipPluginBase::getSelector in core/modules/tour/src/TipPluginBase.php
Returns the selector the tour tip will attach to.

File

core/modules/tour/src/TipPluginInterface.php, line 61

Class

TipPluginInterface
Defines an interface for tour items.

Namespace

Drupal\tour

Code

public function getSelector() : ?string;

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.