ScrollTopCommand.php in Zircon Profile 8

Contains \Drupal\views\Ajax\ScrollTopCommand.

Namespace

Drupal\views\Ajax

File

core/modules/views/src/Ajax/ScrollTopCommand.php

<?php

/**
 * @file
 * Contains \Drupal\views\Ajax\ScrollTopCommand.
 */
namespace Drupal\views\Ajax;

use Drupal\Core\Ajax\CommandInterface;

/**
 * Provides an AJAX command for scrolling to the top of an element.
 *
 * This command is implemented in Drupal.AjaxCommands.prototype.viewsScrollTop.
 */
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;
  }

  /**
   * {@inheritdoc}
   */
  public function render() {
    return array(
      'command' => 'viewsScrollTop',
      'selector' => $this->selector,
    );
  }

}

Classes

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