Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x

ScrollTopCommand.php

Namespace

Drupal\Core\Ajax

File

core/lib/Drupal/Core/Ajax/ScrollTopCommand.php

View source
<?php

namespace Drupal\Core\Ajax;


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

}

Classes

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

API Navigation

  • Drupal Core 11.1.x
  • Topics
  • Classes
  • Functions
  • Constants
  • Globals
  • Files
  • Namespaces
  • Deprecated
  • Services
RSS feed
Powered by Drupal