class ScrollTopCommand

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

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

Hierarchy

Expanded class hierarchy of ScrollTopCommand

1 file declares its use of ScrollTopCommand
ajax.inc in drupal/core/modules/views/includes/ajax.inc
Handles the server side AJAX interactions of Views.

File

drupal/core/modules/views/lib/Drupal/views/Ajax/ScrollTopCommand.php, line 17
Contains \Drupal\views\Ajax\ScrollTopCommand.

Namespace

Drupal\views\Ajax
View source
class ScrollTopCommand implements CommandInterface {

  /**
   * A CSS selector string.
   *
   * @var string
   */
  protected $selector;

  /**
   * Constructs a \Drupal\views\Ajax\ScrollTopCommand object.
   *
   * @param string $selector
   *   A CSS selector.
   */
  public function __construct($selector) {
    $this->selector = $selector;
  }

  /**
   * Implements \Drupal\Core\Ajax\CommandInterface::render().
   */
  public function render() {
    return array(
      'command' => 'viewsScrollTop',
      'selector' => $this->selector,
    );
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ScrollTopCommand::$selector protected property A CSS selector string.
ScrollTopCommand::render public function Implements \Drupal\Core\Ajax\CommandInterface::render(). Overrides CommandInterface::render
ScrollTopCommand::__construct public function Constructs a \Drupal\views\Ajax\ScrollTopCommand object.