ViewsBootstrapCarousel.php in Views Bootstrap 8.4

Namespace

Drupal\views_bootstrap\Plugin\views\style

File

src/Plugin/views/style/ViewsBootstrapCarousel.php

<?php

namespace Drupal\views_bootstrap\Plugin\views\style;

use Drupal\Core\Form\FormStateInterface;
use Drupal\views\Plugin\views\style\StylePluginBase;

/**
 * Style plugin to render each item as a row in a Bootstrap Carousel.
 *
 * @ingroup views_style_plugins
 *
 * @ViewsStyle(
 *   id = "views_bootstrap_carousel",
 *   title = @Translation("Bootstrap Carousel"),
 *   help = @Translation("Displays rows in a Bootstrap Carousel."),
 *   theme = "views_bootstrap_carousel",
 *   theme_file = "../views_bootstrap.theme.inc",
 *   display_types = {"normal"}
 * )
 */
class ViewsBootstrapCarousel extends StylePluginBase {

  /**
   * Does the style plugin for itself support to add fields to it's output.
   *
   * @var bool
   */
  protected $usesFields = TRUE;

  /**
   * Definition.
   */
  protected function defineOptions() {
    $options = parent::defineOptions();

    // General carousel settings.
    $options['interval'] = [
      'default' => 5000,
    ];
    $options['keyboard'] = [
      'default' => TRUE,
    ];
    $options['ride'] = [
      'default' => TRUE,
    ];
    $options['navigation'] = [
      'default' => TRUE,
    ];
    $options['indicators'] = [
      'default' => TRUE,
    ];
    $options['pause'] = [
      'default' => TRUE,
    ];
    $options['wrap'] = [
      'default' => TRUE,
    ];
    $options['effect'] = [
      'default' => 'slide',
    ];
    $options['use_caption'] = [
      'default' => TRUE,
    ];

    // Fields to use in carousel.
    $options['image'] = [
      'default' => '',
    ];
    $options['title'] = [
      'default' => '',
    ];
    $options['description'] = [
      'default' => '',
    ];
    return $options;
  }

  /**
   * Render the given style.
   */
  public function buildOptionsForm(&$form, FormStateInterface $form_state) {
    parent::buildOptionsForm($form, $form_state);
    $fields = [
      '' => $this
        ->t('<None>'),
    ];
    $fields += $this->displayHandler
      ->getFieldLabels(TRUE);
    $form['interval'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Interval'),
      '#description' => $this
        ->t('The amount of time to delay between automatically cycling an item. If false, carousel will not automatically cycle.'),
      '#default_value' => $this->options['interval'],
    ];
    $form['keyboard'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Keyboard'),
      '#description' => $this
        ->t('Whether the carousel should react to keyboard events.'),
      '#default_value' => $this->options['keyboard'],
    ];
    $form['ride'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Ride (Autoplay)'),
      '#description' => $this
        ->t('Autoplays the carousel on load.'),
      '#default_value' => $this->options['ride'],
    ];
    $form['navigation'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Show navigation'),
      '#default_value' => $this->options['navigation'],
    ];
    $form['indicators'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Show indicators'),
      '#default_value' => $this->options['indicators'],
    ];
    $form['pause'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Pause on hover'),
      '#description' => $this
        ->t('Pauses the cycling of the carousel on mouseenter and resumes the cycling of the carousel on mouseleave.'),
      '#default_value' => $this->options['pause'],
    ];
    $form['use_caption'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Add captions to your slides for add title and description over the image.'),
      '#description' => $this
        ->t('<a href=":docs">See Bootstrap documentation</a>', [
        ':docs' => 'https://getbootstrap.com/docs/4.0/components/carousel/#with-captions',
      ]),
      '#default_value' => $this->options['use_caption'],
    ];
    $form['wrap'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Wrap'),
      '#description' => $this
        ->t('The carousel should cycle continuously or have hard stops.'),
      '#default_value' => $this->options['wrap'],
    ];
    $form['effect'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Effect'),
      '#description' => $this
        ->t('Transition effect (since bootstrap 4.1). <a href=":docs">See Bootstrap documentation</a>', [
        ':docs' => 'https://getbootstrap.com/docs/4.1/components/carousel/#crossfade',
      ]),
      '#options' => [
        '' => $this
          ->t('No effect'),
        'slide' => $this
          ->t('Slide'),
        'slide carousel-fade' => $this
          ->t('Fade'),
      ],
      '#default_value' => $this->options['effect'],
    ];
    $form['image'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Image'),
      '#options' => $fields,
      '#default_value' => $this->options['image'],
    ];
    $form['title'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Title'),
      '#options' => $fields,
      '#default_value' => $this->options['title'],
    ];
    $form['description'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Description'),
      '#options' => $fields,
      '#default_value' => $this->options['description'],
    ];
  }

}

Classes

Name	Description
ViewsBootstrapCarousel	Style plugin to render each item as a row in a Bootstrap Carousel.