class ScrollTopCommand

Provides an AJAX command for scrolling to the top of an element.

This command is implemented in Drupal.AjaxCommands.prototype.scrollTop.

Hierarchy

Expanded class hierarchy of ScrollTopCommand

2 files declare their use of ScrollTopCommand
ScrollTopCommand.php in core/modules/views/src/Ajax/ScrollTopCommand.php
ViewAjaxController.php in core/modules/views/src/Controller/ViewAjaxController.php

File

View on git.drupalcode.org

core/lib/Drupal/Core/Ajax/ScrollTopCommand.php, line 10

Namespace

Drupal\Core\Ajax
View source 
class ScrollTopCommand implements CommandInterface {
  
  /**
   * A CSS selector string.
   *
   * @var string
   */
  protected $selector;
  
  /**
   * Constructs a \Drupal\Core\Ajax\ScrollTopCommand object.
   *
   * @param string $selector
   *   A CSS selector.
   */
  public function __construct($selector) {
    $this->selector = $selector;
  }
  
  /**
   * {@inheritdoc}
   */
  public function render() : array {
    return [
      'command' => 'scrollTop',
      'selector' => $this->selector,
    ];
  }

}

Members

Title Modifiers Object type Summary Overriden Title
ScrollTopCommand::$selector protected property A CSS selector string.
ScrollTopCommand::render public function Return an array to be run through json_encode and sent to the client. Overrides CommandInterface::render
ScrollTopCommand::__construct public function Constructs a \Drupal\Core\Ajax\ScrollTopCommand object.

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