You are here

Home » API reference » Toc.js 8 » TocJsBlock.php

class TocJsBlock in Toc.js 8

Same name and namespace in other branches
  1. 2.0.x src/Plugin/Block/TocJsBlock.php \Drupal\toc_js\Plugin\Block\TocJsBlock

Provides a 'SocialSimpleBlock' block.

Plugin annotation


@Block(
 id = "toc_js_block",
 admin_label = @Translation("Toc.js block"),
)

Hierarchy

Expanded class hierarchy of TocJsBlock

File

src/Plugin/Block/TocJsBlock.php, line 22

Namespace

Drupal\toc_js\Plugin\Block
View source 
class TocJsBlock extends BlockBase implements ContainerFactoryPluginInterface {

  /**
   * Drupal\Core\Routing\CurrentRouteMatch definition.
   *
   * @var \Drupal\Core\Routing\CurrentRouteMatch
   */
  protected $currentRouteMatch;

  /**
   * Constructs a new SocialSimpleBlock object.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param string $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Routing\CurrentRouteMatch $current_route_match
   *   The current route match.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, CurrentRouteMatch $current_route_match) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->currentRouteMatch = $current_route_match;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('current_route_match'));
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'title' => $this
        ->t('Table of content'),
      'selectors' => 'h2, h3',
      'selectors_minimum' => 0,
      'container' => '.node',
      'prefix' => 'toc',
      'list_type' => 'ul',
      'back_to_top' => 0,
      'back_to_top_label' => $this
        ->t('Back to top'),
      'smooth_scrolling' => 1,
      'scroll_to_offset' => 100,
      'highlight_on_scroll' => 1,
      'highlight_offset' => 100,
      'sticky' => 0,
      'sticky_offset' => 0,
      'sticky_stop' => '',
      'sticky_stop_padding' => 0,
    ] + parent::defaultConfiguration();
  }

  /**
   * {@inheritdoc}
   */
  public function blockForm($form, FormStateInterface $form_state) {
    $form['title'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Title'),
      '#description' => $this
        ->t('the title to use for the table of contents.'),
      '#default_value' => $this->configuration['title'],
    ];
    $form['selectors'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Selectors'),
      '#description' => $this
        ->t('Elements to use as headings. Each element separated by comma.'),
      '#default_value' => $this->configuration['selectors'],
    ];
    $form['selectors_minimum'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Minimum elements'),
      '#description' => $this
        ->t('Set a minimum of elements to display the toc. Set 0 to always display the TOC.'),
      '#default_value' => $this->configuration['selectors_minimum'],
    ];
    $form['container'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Container'),
      '#description' => $this
        ->t('Element to find all selectors in.'),
      '#default_value' => $this->configuration['container'],
    ];
    $form['prefix'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Prefix'),
      '#description' => $this
        ->t('Prefix for anchor tags and class names.'),
      '#default_value' => $this->configuration['prefix'],
    ];
    $form['list_type'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('List type'),
      '#description' => $this
        ->t('Select the list type to use.'),
      '#default_value' => $this->configuration['prefix'],
      '#options' => [
        'ul' => $this
          ->t('Unordered HTML list (ul)'),
        'ol' => $this
          ->t('Ordered HTML list (ol)'),
      ],
    ];
    $form['back_to_top'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Back to top'),
      '#description' => $this
        ->t('Add a back to top link on heading.'),
      '#default_value' => $this->configuration['back_to_top'],
    ];
    $form['back_to_top_label'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Back to top label'),
      '#description' => $this
        ->t('The back to top link label.'),
      '#default_value' => $this->configuration['back_to_top_label'],
      '#states' => [
        'visible' => [
          ':input[name="settings[back_to_top]"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $form['smooth_scrolling'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Smooth scrolling'),
      '#description' => $this
        ->t('Enable or disable smooth scrolling on click.'),
      '#default_value' => $this->configuration['smooth_scrolling'],
    ];
    $form['scroll_to_offset'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('ScrollTo offset'),
      '#description' => $this
        ->t('Offset to trigger with smooth scrolling enabled.'),
      '#default_value' => $this->configuration['scroll_to_offset'],
      '#states' => [
        'visible' => [
          ':input[name="settings[smooth_scrolling]"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $form['highlight_on_scroll'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('highlight On Scroll'),
      '#description' => $this
        ->t('Add class to heading that is currently in focus.'),
      '#default_value' => $this->configuration['highlight_on_scroll'],
    ];
    $form['highlight_offset'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Highlight offset'),
      '#description' => $this
        ->t('Offset to trigger the next headline.'),
      '#default_value' => $this->configuration['highlight_offset'],
      '#states' => [
        'visible' => [
          ':input[name="settings[highlight_on_scroll]"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $form['sticky'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Sticky'),
      '#description' => $this
        ->t('Stick the toc on window scroll.'),
      '#default_value' => $this->configuration['sticky'],
    ];
    $form['sticky_offset'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Sticky offset'),
      '#description' => $this
        ->t('The offset (in px) to apply when the toc is sticky.'),
      '#default_value' => $this->configuration['sticky_offset'],
      '#states' => [
        'visible' => [
          ':input[name="settings[sticky]"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $form['sticky_stop'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Sticky stop'),
      '#description' => $this
        ->t('Selector to use as a sticky stop. Leave empty if you don\'t need a stop for the sticky toc.'),
      '#default_value' => $this->configuration['sticky_stop'],
      '#states' => [
        'visible' => [
          ':input[name="settings[sticky]"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $form['sticky_stop_padding'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Sticky Stop padding (px)'),
      '#description' => $this
        ->t('The padding to apply before the sticky stop (in pixels).'),
      '#default_value' => $this->configuration['sticky_stop_padding'],
      '#states' => [
        'visible' => [
          ':input[name="settings[sticky]"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function blockSubmit($form, FormStateInterface $form_state) {
    $this->configuration['title'] = $form_state
      ->getValue('title');
    $this->configuration['selectors'] = $form_state
      ->getValue('selectors');
    $this->configuration['selectors_minimum'] = $form_state
      ->getValue('selectors_minimum');
    $this->configuration['container'] = $form_state
      ->getValue('container');
    $this->configuration['prefix'] = $form_state
      ->getValue('prefix');
    $this->configuration['list_type'] = $form_state
      ->getValue('list_type');
    $this->configuration['back_to_top'] = $form_state
      ->getValue('back_to_top');
    $this->configuration['back_to_top_label'] = $form_state
      ->getValue('back_to_top_label');
    $this->configuration['smooth_scrolling'] = $form_state
      ->getValue('smooth_scrolling');
    $this->configuration['scroll_to_offset'] = $form_state
      ->getValue('scroll_to_offset');
    $this->configuration['highlight_on_scroll'] = $form_state
      ->getValue('highlight_on_scroll');
    $this->configuration['highlight_offset'] = $form_state
      ->getValue('highlight_offset');
    $this->configuration['sticky'] = $form_state
      ->getValue('sticky');
    $this->configuration['sticky_offset'] = $form_state
      ->getValue('sticky_offset');
    $this->configuration['sticky_stop'] = $form_state
      ->getValue('sticky_stop');
    $this->configuration['sticky_stop_padding'] = $form_state
      ->getValue('sticky_stop_padding');
  }

  /**
   * {@inheritdoc}
   */
  public function build() {
    $build = [];
    $toc_js_settings = $this->configuration;

    // toc-js class is used to initialize the toc.
    $attributes = new Attribute([
      'class' => [
        'toc-js',
      ],
    ]);
    $attributes
      ->setAttribute('id', 'toc-js-block-' . Html::cleanCssIdentifier($this->pluginId));
    $title_attributes = new Attribute([
      'class' => [
        'toc-title',
        'h2',
      ],
    ]);
    if ($this->configuration['sticky']) {
      $attributes
        ->addClass('sticky');
    }
    foreach ($toc_js_settings as $name => $setting) {
      if ($name == 'toc_js_active' || $name == 'title') {
        continue;
      }
      $data_name = 'data-' . Html::cleanCssIdentifier($name);
      $attributes
        ->setAttribute($data_name, $setting);
    }

    // Provide some entity context if available.
    $entity = NULL;
    if ($node = $this->currentRouteMatch
      ->getParameter('node')) {
      $entity = $node;
    }
    elseif ($taxonomy_term = $this->currentRouteMatch
      ->getParameter('taxonomy_term')) {
      $entity = $taxonomy_term;
    }
    $build['toc_js'] = [
      '#theme' => 'toc_js',
      '#title' => $this->configuration['title'],
      '#tag' => 'div',
      '#title_attributes' => $title_attributes,
      '#attributes' => $attributes,
      '#entity' => $entity,
      '#attached' => [
        'library' => [
          'toc_js/toc',
        ],
      ],
    ];
    return $build;
  }

  /**
   * {@inheritdoc}
   */
  public function getCacheTags() {

    /** @var \Drupal\node\NodeInterface $node */
    if ($node = $this->currentRouteMatch
      ->getParameter('node')) {
      return Cache::mergeTags(parent::getCacheTags(), $node
        ->getCacheTags());
    }
    elseif ($taxonomy_term = $this->currentRouteMatch
      ->getParameter('taxonomy_term')) {
      return Cache::mergeTags(parent::getCacheTags(), $taxonomy_term
        ->getCacheTags());
    }
    else {
      return parent::getCacheTags();
    }
  }

  /**
   * {@inheritdoc}
   */
  public function getCacheContexts() {
    return Cache::mergeContexts(parent::getCacheContexts(), [
      'url.path',
    ]);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
BlockPluginInterface::BLOCK_LABEL_VISIBLE constant Indicates the block label (title) should be displayed to end users.
BlockPluginTrait::$transliteration protected property The transliteration service.
BlockPluginTrait::access public function
BlockPluginTrait::baseConfigurationDefaults protected function Returns generic default configuration for block plugins.
BlockPluginTrait::blockAccess protected function Indicates whether the block should be shown. 16
BlockPluginTrait::blockValidate public function 3
BlockPluginTrait::buildConfigurationForm public function Creates a generic configuration form for all block types. Individual block plugins can add elements to this form by overriding BlockBase::blockForm(). Most block plugins should not override this method unless they need to alter the generic form elements. 2
BlockPluginTrait::calculateDependencies public function
BlockPluginTrait::getConfiguration public function 1
BlockPluginTrait::getMachineNameSuggestion public function 1
BlockPluginTrait::getPreviewFallbackString public function 3
BlockPluginTrait::label public function
BlockPluginTrait::setConfiguration public function
BlockPluginTrait::setConfigurationValue public function
BlockPluginTrait::setTransliteration public function Sets the transliteration service.
BlockPluginTrait::submitConfigurationForm public function Most block plugins should not override this method. To add submission handling for a specific block type, override BlockBase::blockSubmit().
BlockPluginTrait::transliteration protected function Wraps the transliteration service.
BlockPluginTrait::validateConfigurationForm public function Most block plugins should not override this method. To add validation for a specific block type, override BlockBase::blockValidate(). 1
ContextAwarePluginAssignmentTrait::addContextAssignmentElement protected function Builds a form element for assigning a context to a given slot.
ContextAwarePluginAssignmentTrait::contextHandler protected function Wraps the context handler.
ContextAwarePluginBase::$context protected property The data objects representing the context of this plugin.
ContextAwarePluginBase::$contexts Deprecated private property Data objects representing the contexts passed in the plugin configuration.
ContextAwarePluginBase::createContextFromConfiguration protected function Overrides ContextAwarePluginBase::createContextFromConfiguration
ContextAwarePluginBase::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge 7
ContextAwarePluginBase::getContext public function This code is identical to the Component in order to pick up a different Context class. Overrides ContextAwarePluginBase::getContext
ContextAwarePluginBase::getContextDefinition public function Overrides ContextAwarePluginBase::getContextDefinition
ContextAwarePluginBase::getContextDefinitions public function Overrides ContextAwarePluginBase::getContextDefinitions
ContextAwarePluginBase::getContextMapping public function Gets a mapping of the expected assignment names to their context names. Overrides ContextAwarePluginInterface::getContextMapping
ContextAwarePluginBase::getContexts public function Gets the defined contexts. Overrides ContextAwarePluginInterface::getContexts
ContextAwarePluginBase::getContextValue public function Gets the value for a defined context. Overrides ContextAwarePluginInterface::getContextValue
ContextAwarePluginBase::getContextValues public function Gets the values for all defined contexts. Overrides ContextAwarePluginInterface::getContextValues
ContextAwarePluginBase::setContext public function Set a context on this plugin. Overrides ContextAwarePluginBase::setContext
ContextAwarePluginBase::setContextMapping public function Sets a mapping of the expected assignment names to their context names. Overrides ContextAwarePluginInterface::setContextMapping
ContextAwarePluginBase::setContextValue public function Sets the value for a defined context. Overrides ContextAwarePluginBase::setContextValue
ContextAwarePluginBase::validateContexts public function Validates the set values for the defined contexts. Overrides ContextAwarePluginInterface::validateContexts
ContextAwarePluginBase::__get public function Implements magic __get() method.
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
PluginWithFormsTrait::getFormClass public function
PluginWithFormsTrait::hasFormClass public function
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
TocJsBlock::$currentRouteMatch protected property Drupal\Core\Routing\CurrentRouteMatch definition.
TocJsBlock::blockForm public function Overrides BlockPluginTrait::blockForm
TocJsBlock::blockSubmit public function Overrides BlockPluginTrait::blockSubmit
TocJsBlock::build public function Builds and returns the renderable array for this block plugin. Overrides BlockPluginInterface::build
TocJsBlock::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
TocJsBlock::defaultConfiguration public function Overrides BlockPluginTrait::defaultConfiguration
TocJsBlock::getCacheContexts public function The cache contexts associated with this object. Overrides ContextAwarePluginBase::getCacheContexts
TocJsBlock::getCacheTags public function The cache tags associated with this object. Overrides ContextAwarePluginBase::getCacheTags
TocJsBlock::__construct public function Constructs a new SocialSimpleBlock object. Overrides BlockPluginTrait::__construct
TypedDataTrait::$typedDataManager protected property The typed data manager used for creating the data types.
TypedDataTrait::getTypedDataManager public function Gets the typed data manager. 2
TypedDataTrait::setTypedDataManager public function Sets the typed data manager. 2