ScrollTopCommand.php

Same filename in other branches
  1. 8.9.x core/modules/views/src/Ajax/ScrollTopCommand.php
  2. 10 core/modules/views/src/Ajax/ScrollTopCommand.php
  3. 10 core/lib/Drupal/Core/Ajax/ScrollTopCommand.php
  4. 11.x core/modules/views/src/Ajax/ScrollTopCommand.php
  5. 11.x core/lib/Drupal/Core/Ajax/ScrollTopCommand.php

Namespace

Drupal\views\Ajax

File

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

View source
<?php

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 [
            'command' => 'viewsScrollTop',
            'selector' => $this->selector,
        ];
    }

}

Classes

Title Deprecated Summary
ScrollTopCommand Provides an AJAX command for scrolling to the top of an element.

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