You are here

Home » API reference » UIkit Components 8.3 » UIkitViewSlideshow.php

class UIkitViewSlideshow in UIkit Components 8.3

Style plugin to render each item in a UIkit Slideshow component.

Plugin annotation


@ViewsStyle(
  id = "uikit_view_slideshow",
  title = @Translation("UIkit Slideshow"),
  help = @Translation("Displays rows in a UIkit Slideshow component"),
  theme = "uikit_view_slideshow",
  display_types = {"normal"}
)

Hierarchy

Expanded class hierarchy of UIkitViewSlideshow

File

uikit_views/src/Plugin/views/style/UIkitViewSlideshow.php, line 21

Namespace

Drupal\uikit_views\Plugin\views\style
View source 
class UIkitViewSlideshow extends StylePluginBase {

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

  /**
   * Does the style plugin allows to use style plugins.
   *
   * @var bool
   */
  protected $usesRowPlugin = TRUE;

  /**
   * {@inheritdoc}
   */
  protected function defineOptions() {
    $options = parent::defineOptions();
    $options['image_field'] = [
      'default' => NULL,
    ];
    $options['title_field'] = [
      'default' => NULL,
    ];
    $options['caption_field'] = [
      'default' => NULL,
    ];
    $options['thumbnav_field'] = [
      'default' => NULL,
    ];
    $options['caption_background'] = [
      'default' => NULL,
    ];
    $options['caption_transition'] = [
      'default' => NULL,
    ];
    $options['caption_position'] = [
      'default' => 'uk-position-bottom',
    ];
    $options['caption_modifier'] = [
      'default' => NULL,
    ];
    $options['caption_toggle'] = [
      'default' => FALSE,
    ];
    $options['slidenav'] = [
      'default' => TRUE,
    ];
    $options['slidenav_outside'] = [
      'default' => FALSE,
    ];
    $options['slidenav_big'] = [
      'default' => FALSE,
    ];
    $options['dotnav'] = [
      'default' => TRUE,
    ];
    $options['thumbnav'] = [
      'default' => FALSE,
    ];
    $options['light'] = [
      'default' => FALSE,
    ];
    $options['animation'] = [
      'default' => 'slide',
    ];
    $options['autoplay'] = [
      'default' => TRUE,
    ];
    $options['autoplay_interval'] = [
      'default' => 6000,
    ];
    $options['finite'] = [
      'default' => FALSE,
    ];
    $options['pause_on_hover'] = [
      'default' => TRUE,
    ];
    $options['index'] = [
      'default' => 0,
    ];
    $options['velocity'] = [
      'default' => 1,
    ];
    $options['ratio'] = [
      'default' => '16:9',
    ];
    $options['min-height'] = [
      'default' => FALSE,
    ];
    $options['max-height'] = [
      'default' => FALSE,
    ];
    return $options;
  }

  /**
   * {@inheritdoc}
   */
  public function buildOptionsForm(&$form, FormStateInterface $form_state) {
    parent::buildOptionsForm($form, $form_state);
    if (isset($form['grouping'])) {
      unset($form['grouping']);
      $form['field_mapping'] = [
        '#type' => 'details',
        '#title' => $this
          ->t('Field mapping for images'),
        '#open' => TRUE,
      ];
      $form['image_field'] = [
        '#type' => 'select',
        '#title' => $this
          ->t('Image field'),
        '#empty_option' => '- None -',
        '#required' => TRUE,
        '#options' => $this->displayHandler
          ->getFieldLabels(),
        '#default_value' => $this->options['image_field'],
        '#description' => $this
          ->t('Select the field to use as the slide image.'),
        '#fieldset' => 'field_mapping',
      ];
      $form['title_field'] = [
        '#type' => 'select',
        '#title' => $this
          ->t('Caption Title'),
        '#empty_option' => '- None -',
        '#options' => $this->displayHandler
          ->getFieldLabels(),
        '#default_value' => $this->options['title_field'],
        '#description' => $this
          ->t('Select the field to use as the slide title.'),
        '#fieldset' => 'field_mapping',
      ];
      $form['caption_field'] = [
        '#type' => 'select',
        '#title' => $this
          ->t('Caption text'),
        '#empty_option' => '- None -',
        '#options' => $this->displayHandler
          ->getFieldLabels(),
        '#default_value' => $this->options['caption_field'],
        '#description' => $this
          ->t('Select the field to use as the slide caption'),
        '#fieldset' => 'field_mapping',
      ];
      $form['thumbnav_field'] = [
        '#type' => 'select',
        '#title' => $this
          ->t('Thumbnav field'),
        '#empty_option' => '- None -',
        '#options' => $this->displayHandler
          ->getFieldLabels(),
        '#default_value' => $this->options['thumbnav_field'],
        '#description' => $this
          ->t('Select the image field to use as thumbnav navigation in slider'),
        '#fieldset' => 'field_mapping',
      ];
      $form['slider_options'] = [
        '#type' => 'details',
        '#title' => $this
          ->t('Slideshow options'),
        '#open' => TRUE,
      ];
      $form['animation'] = [
        '#title' => t('Slideshow animation mode'),
        '#type' => 'select',
        '#default_value' => $this->options['animation'],
        '#options' => array(
          'slide' => $this
            ->t('slide'),
          'fade' => $this
            ->t('fade'),
          'scale' => $this
            ->t('scale'),
          'pull' => $this
            ->t('pull'),
          'push' => $this
            ->t('push'),
        ),
        '#fieldset' => 'slider_options',
      ];
      $form['autoplay'] = [
        '#title' => $this
          ->t('Slideshow autoplays'),
        '#type' => 'checkbox',
        '#default_value' => $this->options['autoplay'],
        '#fieldset' => 'slider_options',
      ];
      $form['autoplay_interval'] = [
        '#title' => $this
          ->t('The delay between switching slides in autoplay mode'),
        '#type' => 'number',
        '#default_value' => $this->options['autoplay_interval'],
        '#min' => 3000,
        '#step' => 1000,
        '#fieldset' => 'slider_options',
      ];
      $form['finite'] = [
        '#title' => $this
          ->t('Disable infinite sliding'),
        '#type' => 'checkbox',
        '#default_value' => $this->options['finite'],
        '#fieldset' => 'slider_options',
      ];
      $form['pause_on_hover'] = [
        '#title' => $this
          ->t('Pause autoplay mode on hover'),
        '#type' => 'checkbox',
        '#default_value' => $this->options['pause_on_hover'],
        '#fieldset' => 'slider_options',
      ];
      $form['index'] = [
        '#title' => $this
          ->t('Slideshow item to show. 0 based index'),
        '#type' => 'number',
        '#default_value' => $this->options['index'],
        '#fieldset' => 'slider_options',
      ];
      $form['velocity'] = [
        '#title' => $this
          ->t('The animation velocity (pixel/ms)'),
        '#type' => 'number',
        '#default_value' => $this->options['velocity'],
        '#fieldset' => 'slider_options',
      ];
      $form['ratio'] = [
        '#title' => $this
          ->t('The ratio. (let this field blank to prevent height adjustment)'),
        '#type' => 'textfield',
        '#default_value' => $this->options['ratio'],
        '#fieldset' => 'slider_options',
      ];
      $form['min_height'] = [
        '#title' => $this
          ->t('The minimum height (let this field blank to respect ratio)'),
        '#type' => 'number',
        '#default_value' => $this->options['min_height'],
        '#fieldset' => 'slider_options',
      ];
      $form['max_height'] = [
        '#title' => $this
          ->t('The maximum height (let this field blank to respect ratio)'),
        '#type' => 'number',
        '#default_value' => $this->options['max_height'],
        '#fieldset' => 'slider_options',
      ];
      $form['caption_background'] = [
        '#type' => 'select',
        '#title' => $this
          ->t('Overlay background for legend'),
        '#empty_option' => $this
          ->t('-None-'),
        '#options' => [
          'uk-overlay-default' => $this
            ->t('default'),
          'uk-overlay-primary' => $this
            ->t('Primary'),
          'uk-overlay-secondary' => $this
            ->t('Secondary'),
        ],
        '#default_value' => $this->options['caption_background'],
        '#fieldset' => 'slider_options',
      ];
      $form['caption_transition'] = [
        '#type' => 'select',
        '#title' => $this
          ->t('Caption transition'),
        '#empty_option' => $this
          ->t('-None-'),
        '#default_value' => $this->options['caption_transition'],
        '#options' => [
          'uk-transition-fade' => $this
            ->t('fade'),
          'uk-transition-slide-top' => $this
            ->t('slide from the top'),
          'uk-transition-slide-bottom' => $this
            ->t('slide from the bottom'),
          'uk-transition-slide-left' => $this
            ->t('slide from the left'),
          'uk-transition-slide-right' => $this
            ->t('slide from the right '),
          'uk-transition-slide-top-small' => $this
            ->t('slide from the top with a smaller distance'),
          'uk-transition-slide-bottom-small' => $this
            ->t('slide from the bottom with a smaller distance'),
          'uk-transition-slide-left-small' => $this
            ->t('slide from the left with a smaller distance'),
          'uk-transition-slide-right-small' => $this
            ->t('slide from the right with a smaller distance'),
          'uk-transition-slide-top-medium' => $this
            ->t('slide from the top  with a medium distance'),
          'uk-transition-slide-bottom-medium' => $this
            ->t('slide from the bottom  with a medium distance'),
          'uk-transition-slide-left-medium' => $this
            ->t('slide from the left  with a medium distance'),
          'uk-transition-slide-right-medium' => $this
            ->t('slide from the right  with a medium distance'),
        ],
        '#description' => $this
          ->t('Transition effect for the caption'),
        '#fieldset' => 'slider_options',
      ];
      $form['caption_position'] = [
        '#type' => 'select',
        '#title' => $this
          ->t('Caption position'),
        '#default_value' => $this->options['caption_position'],
        '#options' => [
          'uk-position-top' => $this
            ->t('Position element at the top'),
          'uk-position-top-left' => $this
            ->t('Position element at the top left'),
          'uk-position-top-center' => $this
            ->t('Position element at the top center'),
          'uk-position-top-right' => $this
            ->t('Position element at the top right'),
          'uk-position-center' => $this
            ->t('Position element vertically centered in the middle'),
          'uk-position-center-left' => $this
            ->t('Position element vertically centered on the left'),
          'uk-position-center-right' => $this
            ->t('Position element vertically centered on the right'),
          'uk-position-bottom' => $this
            ->t('Position element at the bottom'),
          'uk-position-bottom-left' => $this
            ->t('Position element at the bottom left'),
          'uk-position-bottom-center' => $this
            ->t('Position element at the bottom center'),
          'uk-position-bottom-right' => $this
            ->t('Position element at the bottom right'),
          'uk-position-left' => $this
            ->t('Position element at the left'),
          'uk-position-right' => $this
            ->t('Position element at the right'),
          'uk-position-cover' => $this
            ->t('Position element to cover its container'),
        ],
        '#description' => $this
          ->t('Position for the caption'),
        '#fieldset' => 'slider_options',
      ];
      $form['caption_modifier'] = [
        '#type' => 'select',
        '#title' => $this
          ->t("Caption margin (modifier)"),
        '#empty_option' => $this
          ->t('-None-'),
        '#default_value' => $this->options['caption_modifier'],
        '#options' => [
          'uk-position-small' => $this
            ->t('Small'),
          'uk-position-medium' => $this
            ->t('Medium'),
          'uk-position-large' => $this
            ->t('Large'),
        ],
        '#description' => $this
          ->t('Apply a margin to positioned caption'),
        '#fieldset' => 'slider_options',
      ];
      $form['caption_toggle'] = [
        '#title' => $this
          ->t('Display Legend only on hover'),
        '#type' => 'checkbox',
        '#default_value' => $this->options['caption_toggle'],
        '#fieldset' => 'slider_options',
      ];
      $form['slidenav'] = [
        '#title' => $this
          ->t('Display slidenav buttons (next/previous)'),
        '#type' => 'checkbox',
        '#default_value' => $this->options['slidenav'],
        '#fieldset' => 'slider_options',
      ];
      $form['slidenav_outside'] = [
        '#title' => $this
          ->t('Display slidenav buttons outside slider'),
        '#type' => 'checkbox',
        '#default_value' => $this->options['slidenav_outside'],
        '#fieldset' => 'slider_options',
      ];
      $form['slidenav_big'] = [
        '#title' => $this
          ->t('increase the size of the slidenav icons'),
        '#type' => 'checkbox',
        '#default_value' => $this->options['slidenav_big'],
        '#fieldset' => 'slider_options',
      ];
      $form['dotnav'] = [
        '#title' => $this
          ->t('Display dotnav buttons (pager)'),
        '#type' => 'checkbox',
        '#default_value' => $this->options['slidenav'],
        '#fieldset' => 'slider_options',
      ];
      $form['thumbnav'] = [
        '#title' => $this
          ->t('Display thumbnav'),
        '#type' => 'checkbox',
        '#default_value' => $this->options['thumbnav'],
        '#fieldset' => 'slider_options',
      ];
      $form['light'] = [
        '#title' => $this
          ->t('Inverse component'),
        '#type' => 'checkbox',
        '#default_value' => $this->options['light'],
        '#description' => $this
          ->t('Add the .uk-light class to improve the visibility of objects on dark backgrounds in a light style. '),
        '#fieldset' => 'slider_options',
      ];
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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::$definition public property Plugins's definition
PluginBase::$displayHandler public property The display object this plugin is for.
PluginBase::$options public property Options for this plugin will be held here.
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::$renderer protected property Stores the render API renderer. 3
PluginBase::$view public property The top object of a view. 1
PluginBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies 14
PluginBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 62
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::doFilterByDefinedOptions protected function Do the work to filter out stored options depending on the defined options.
PluginBase::filterByDefinedOptions public function Filter out stored options depending on the defined options. Overrides ViewsPluginInterface::filterByDefinedOptions
PluginBase::getAvailableGlobalTokens public function Returns an array of available token replacements. Overrides ViewsPluginInterface::getAvailableGlobalTokens
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::getProvider public function Returns the plugin provider. Overrides ViewsPluginInterface::getProvider
PluginBase::getRenderer protected function Returns the render API renderer. 1
PluginBase::globalTokenForm public function Adds elements for available core tokens to a form. Overrides ViewsPluginInterface::globalTokenForm
PluginBase::globalTokenReplace public function Returns a string with any core tokens replaced. Overrides ViewsPluginInterface::globalTokenReplace
PluginBase::INCLUDE_ENTITY constant Include entity row languages when listing languages.
PluginBase::INCLUDE_NEGOTIATED constant Include negotiated languages when listing languages.
PluginBase::isConfigurable public function Determines if the plugin is configurable.
PluginBase::listLanguages protected function Makes an array of languages, optionally including special languages.
PluginBase::pluginTitle public function Return the human readable name of the display. Overrides ViewsPluginInterface::pluginTitle
PluginBase::preRenderAddFieldsetMarkup public static function Moves form elements into fieldsets for presentation purposes. Overrides ViewsPluginInterface::preRenderAddFieldsetMarkup
PluginBase::preRenderFlattenData public static function Flattens the structure of form elements. Overrides ViewsPluginInterface::preRenderFlattenData
PluginBase::queryLanguageSubstitutions public static function Returns substitutions for Views queries for languages.
PluginBase::setOptionDefaults protected function Fills up the options of the plugin with defaults.
PluginBase::submitOptionsForm public function Handle any special handling on the validate form. Overrides ViewsPluginInterface::submitOptionsForm 16
PluginBase::summaryTitle public function Returns the summary of the settings in the display. Overrides ViewsPluginInterface::summaryTitle 6
PluginBase::themeFunctions public function Provide a full list of possible theme templates used by this style. Overrides ViewsPluginInterface::themeFunctions 1
PluginBase::unpackOptions public function Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away. Overrides ViewsPluginInterface::unpackOptions
PluginBase::usesOptions public function Returns the usesOptions property. Overrides ViewsPluginInterface::usesOptions 8
PluginBase::viewsTokenReplace protected function Replaces Views' tokens in a given string. The resulting string will be sanitized with Xss::filterAdmin. 1
PluginBase::VIEWS_QUERY_LANGUAGE_SITE_DEFAULT constant Query string to indicate the site default language.
PluginBase::__construct public function Constructs a PluginBase object. Overrides PluginBase::__construct
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.
StylePluginBase::$defaultFieldLabels protected property Should field labels be enabled by default. 1
StylePluginBase::$groupingTheme protected property The theme function used to render the grouping set.
StylePluginBase::$rendered_fields protected property Stores the rendered field values, keyed by the row index and field name.
StylePluginBase::$rowTokens protected property Store all available tokens row rows.
StylePluginBase::$usesGrouping protected property Does the style plugin support grouping of rows. 3
StylePluginBase::$usesOptions protected property Denotes whether the plugin has an additional options form. Overrides PluginBase::$usesOptions
StylePluginBase::$usesRowClass protected property Does the style plugin support custom css class for the rows. 3
StylePluginBase::buildSort public function Called by the view builder to see if this style handler wants to interfere with the sorts. If so it should build; if it returns any non-TRUE value, normal sorting will NOT be added to the query. 1
StylePluginBase::buildSortPost public function Called by the view builder to let the style build a second set of sorts that will come after any other sorts in the view. 1
StylePluginBase::defaultFieldLabels public function Return TRUE if this style enables field labels by default. 1
StylePluginBase::destroy public function Clears a plugin. Overrides PluginBase::destroy
StylePluginBase::elementPreRenderRow public function #pre_render callback for view row field rendering.
StylePluginBase::evenEmpty public function Should the output of the style plugin be rendered even if it's a empty view. 2
StylePluginBase::getField public function Gets a rendered field.
StylePluginBase::getFieldValue public function Get the raw field value.
StylePluginBase::getRowClass public function Return the token replaced row class for the specified row.
StylePluginBase::init public function Overrides \Drupal\views\Plugin\views\PluginBase::init(). Overrides PluginBase::init
StylePluginBase::preRender public function Allow the style to do stuff before each row is rendered.
StylePluginBase::query public function Add anything to the query that we might need to. Overrides PluginBase::query 1
StylePluginBase::render public function Render the display in this style. 7
StylePluginBase::renderFields protected function Renders all of the fields for a given style and store them on the object.
StylePluginBase::renderGrouping public function Group records as needed for rendering.
StylePluginBase::renderGroupingSets public function Render the grouping sets.
StylePluginBase::renderRowGroup protected function Renders a group of rows of the grouped view.
StylePluginBase::tokenizeValue public function Take a value and apply token replacement logic to it.
StylePluginBase::trustedCallbacks public static function Lists the trusted callbacks provided by the implementing class. Overrides PluginBase::trustedCallbacks
StylePluginBase::usesFields public function Return TRUE if this style also uses fields. 3
StylePluginBase::usesGrouping public function Returns the usesGrouping property. 3
StylePluginBase::usesRowClass public function Returns the usesRowClass property. 3
StylePluginBase::usesRowPlugin public function Returns the usesRowPlugin property. 10
StylePluginBase::usesTokens public function Return TRUE if this style uses tokens.
StylePluginBase::validate public function Validate that the plugin is correct and can be saved. Overrides PluginBase::validate
StylePluginBase::validateOptionsForm public function Validate the options form. Overrides PluginBase::validateOptionsForm
StylePluginBase::wizardForm public function Provide a form in the views wizard if this style is selected.
StylePluginBase::wizardSubmit public function Alter the options of a display before they are added to the view. 1
TrustedCallbackInterface::THROW_EXCEPTION constant Untrusted callbacks throw exceptions.
TrustedCallbackInterface::TRIGGER_SILENCED_DEPRECATION constant Untrusted callbacks trigger silenced E_USER_DEPRECATION errors.
TrustedCallbackInterface::TRIGGER_WARNING constant Untrusted callbacks trigger E_USER_WARNING errors.
UIkitViewSlideshow::$usesFields protected property Does the style plugin for itself support to add fields to it's output. Overrides StylePluginBase::$usesFields
UIkitViewSlideshow::$usesRowPlugin protected property Does the style plugin allows to use style plugins. Overrides StylePluginBase::$usesRowPlugin
UIkitViewSlideshow::buildOptionsForm public function Provide a form to edit options for this plugin. Overrides StylePluginBase::buildOptionsForm
UIkitViewSlideshow::defineOptions protected function Information about options for all kinds of purposes will be held here. Overrides StylePluginBase::defineOptions