class AddCssCommand in Drupal 9

An AJAX command for adding css to the page via ajax.

This command is implemented by Drupal.AjaxCommands.prototype.add_css() defined in misc/ajax.js.

Hierarchy

• class \Drupal\Core\Ajax\AddCssCommand implements CommandInterface

See also

misc/ajax.js

Related topics

Ajax API

Overview for Drupal's Ajax API.

3 files declare their use of AddCssCommand

AjaxCommandsTest.php in core/tests/Drupal/Tests/Core/Ajax/AjaxCommandsTest.php

ajax_forms_test.module in core/modules/system/tests/modules/ajax_forms_test/ajax_forms_test.module

Simpletest mock module for Ajax forms testing.

FrameworkTest.php in core/modules/system/tests/src/Functional/Ajax/FrameworkTest.php

File

core/lib/Drupal/Core/Ajax/AddCssCommand.php, line 15

Namespace

Drupal\Core\Ajax

class AddCssCommand implements CommandInterface {

  /**
   * A string that contains the styles to be added to the page.
   *
   * It should include the wrapping style tag.
   *
   * @var string
   */
  protected $styles;

  /**
   * Constructs an AddCssCommand.
   *
   * @param string $styles
   *   A string that contains the styles to be added to the page, including the
   *   wrapping <style> tag.
   */
  public function __construct($styles) {
    $this->styles = $styles;
  }

  /**
   * Implements Drupal\Core\Ajax\CommandInterface:render().
   */
  public function render() {
    return [
      'command' => 'add_css',
      'data' => $this->styles,
    ];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AddCssCommand::$styles	protected	property	A string that contains the styles to be added to the page.
AddCssCommand::render	public	function	Implements Drupal\Core\Ajax\CommandInterface:render(). Overrides CommandInterface::render
AddCssCommand::__construct	public	function	Constructs an AddCssCommand.