You are here

interface TourTipPluginInterface in Drupal 10

Same name and namespace in other branches
  1. 9 core/modules/tour/src/TourTipPluginInterface.php \Drupal\tour\TourTipPluginInterface

Defines an interface for tour items.

@todo move all methods to TipPluginInterface and deprecate this interface in https://drupal.org/i/3276336

Hierarchy

Expanded class hierarchy of TourTipPluginInterface

All classes that implement TourTipPluginInterface

See also

\Drupal\tour\Annotation\Tip

\Drupal\tour\TipPluginBase

\Drupal\tour\TipPluginManager

Plugin API

1 file declares its use of TourTipPluginInterface
TipPluginText.php in core/modules/tour/src/Plugin/tour/tip/TipPluginText.php

File

core/modules/tour/src/TourTipPluginInterface.php, line 16

Namespace

Drupal\tour
View source
interface TourTipPluginInterface extends TipPluginInterface {

  /**
   * Returns the selector the tour tip will attach to.
   *
   * This typically maps to the Shepherd Step options `attachTo.element`
   * property.
   *
   * @return null|string
   *   A selector string, or null for an unattached tip.
   *
   * @see https://shepherdjs.dev/docs/Step.html
   */
  public function getSelector() : ?string;

  /**
   * Returns the body content of the tooltip.
   *
   * This typically maps to the Shepherd Step options `text` property.
   *
   * @return array
   *   A render array.
   *
   * @see https://shepherdjs.dev/docs/Step.html
   */
  public function getBody() : array;

  /**
   * 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 string|null
   *   The tip placement relative to the element.
   *
   * @see https://shepherdjs.dev/docs/Step.html
   */
  public function getLocation() : ?string;

}

Members

Namesort descending Modifiers Type Description Overrides
TipPluginInterface::get public function Used for returning values by key.
TipPluginInterface::getLabel public function Returns label of the tip.
TipPluginInterface::getWeight public function Returns weight of the tip.
TipPluginInterface::id public function Returns id of the tip.
TipPluginInterface::set public function Used for returning values by key.
TourTipPluginInterface::getBody public function Returns the body content of the tooltip. 1
TourTipPluginInterface::getLocation public function Returns the configured placement of the tip relative to the element.
TourTipPluginInterface::getSelector public function Returns the selector the tour tip will attach to.