You are here

Home » API reference » GridStack 8.2 » Bootstrap4.php

class Bootstrap4 in GridStack 8.2

Provides a GridStack Bootstrap 4 layout engine.

Plugin annotation


@GridStackEngine(
  id = "bootstrap4",
  group = "bootstrap",
  hidden = "false",
  version = "4",
  label = @Translation("Bootstrap 4")
)

Hierarchy

Expanded class hierarchy of Bootstrap4

File

src/Plugin/gridstack/engine/Bootstrap4.php, line 16

Namespace

Drupal\gridstack\Plugin\gridstack\engine
View source 
class Bootstrap4 extends BootstrapBase {

  /**
   * {@inheritdoc}
   */
  protected function baseColors() {
    $colors = parent::baseColors();
    $colors4 = [
      'secondary',
      'light',
      'dark',
    ];
    return array_merge($colors, $colors4);
  }

  /**
   * {@inheritdoc}
   */
  protected function colors() {
    $colors = parent::colors();
    $colors4 = [
      'white',
      'transparent',
    ];
    return array_merge($colors, $colors4);
  }

  /**
   * Sets the optional plugin engine classes for options, row, hard-coded.
   *
   * @inheritdoc
   */
  protected function setRowClassOptions() {
    if (!isset($this->setRowClassOptions)) {
      $gutters[] = 'no-gutters';
      $flex_direction = [
        'flex-row',
        'flex-column',
        'flex-row-reverse',
        'flex-column-reverse',
      ];
      $flex_wrap = [
        'flex-wrap',
        'flex-nowrap',
        'flex-wrap-reverse',
      ];
      $justify_content = [
        'justify-content-start',
        'justify-content-end',
        'justify-content-center',
        'justify-content-between',
        'justify-content-around',
      ];
      $align_items = [
        'align-items-start',
        'align-items-end',
        'align-items-center',
        'align-items-baseline',
        'align-items-stretch',
      ];
      $align_content = [
        'align-content-start',
        'align-content-end',
        'align-content-center',
        'align-content-between',
        'align-content-around',
        'align-content-stretch',
      ];
      $align_self = [
        'align-self-auto',
        'align-self-start',
        'align-self-end',
        'align-self-center',
        'align-self-baseline',
        'align-self-stretch',
      ];
      $this->setRowClassOptions = [
        'gutters' => $gutters,
        'flex_direction' => $flex_direction,
        'flex_wrap' => $flex_wrap,
        'justify_content' => $justify_content,
        'align_items' => $align_items,
        'align_content' => $align_content,
        'align_self' => $align_self,
      ];
    }
    return $this->setRowClassOptions;
  }

  /**
   * {@inheritdoc}
   */
  protected function getVersionClasses() {
    $classes = parent::getVersionClasses();
    $gradient = [];
    foreach ($this
      ->baseColors() as $type) {
      $gradient[] = "bg-gradient-{$type}";
    }
    $rounded = [
      'rounded',
      'rounded-0',
    ];
    foreach ([
      'bottom',
      'circle',
      'left',
      'lg',
      'pill',
      'right',
      'sm',
      'top',
    ] as $key) {
      $rounded[] = 'rounded-' . $key;
    }
    $shadow = [
      'shadow',
    ];
    foreach ([
      'lg',
      'none',
      'sm',
    ] as $key) {
      $shadow[] = 'shadow-' . $key;
    }
    $classes['gradient'] = $gradient;
    $classes['rounded'] = $rounded;
    $classes['shadow'] = $shadow;
    $classes['text_color'][] = 'text-black-50';
    $classes['text_color'][] = 'text-white-50';
    $classes['utility'][] = 'text-monospace';
    $classes['visibility'][] = 'invisible';
    $classes['visibility'][] = 'visible';
    return $classes;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
Bootstrap4::baseColors protected function Returns the base colors. Overrides BootstrapBase::baseColors
Bootstrap4::colors protected function Returns the colors. Overrides BootstrapBase::colors
Bootstrap4::getVersionClasses protected function Returns the module feature CSS classes, not available at CSS frameworks. Overrides GridStackEnginePluginBase::getVersionClasses
Bootstrap4::setRowClassOptions protected function Sets the optional plugin engine classes for options, row, hard-coded. Overrides GridStackEnginePluginBase::setRowClassOptions
BootstrapBase::$containerClasses protected property The container classes, actually refers to row classes, not the outmost. Overrides GridStackEnginePluginBase::$containerClasses
BootstrapBase::$nestedContainerClasses protected property The nested container classes. Overrides GridStackEnginePluginBase::$nestedContainerClasses
BootstrapBase::itemAttributes protected function Modifies the .box attributes. Overrides GridStackEnginePluginBase::itemAttributes
BootstrapBase::setClassOptions protected function Sets the gridstack engine classes. Overrides GridStackEnginePluginBase::setClassOptions
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
GridBase::$colors protected property The colors.
GridBase::$setClassOptions protected property The class options.
GridBase::$setRowClassOptions protected property The row class options.
GridBase::containerAttributes public function Returns the .gridstack container attributes. Overrides GridStackEnginePluginBase::containerAttributes
GridBase::optimizeClasses protected function Optimize grid widths to remove similar widths.
GridBase::previewOptions public function Returns options which make sense for preview at Layout Builder page. Overrides GridStackEnginePluginBase::previewOptions
GridBase::unique protected function Returns attempted optimized column widths per chunck.
GridStackEnginePluginBase::$classOptions protected property The layout CSS classes for options.
GridStackEnginePluginBase::$colClass protected property The prefix class dependent on framework/ versions: col, cell, columns, etc. 1
GridStackEnginePluginBase::$colPrefix protected property The last prefix dependent on framework/ versions: col-, large, etc. 1
GridStackEnginePluginBase::$itemClasses protected property The item classes, .box.
GridStackEnginePluginBase::$itemContentClasses protected property The item content classes, .box__content.
GridStackEnginePluginBase::$regions protected property The admin regions.
GridStackEnginePluginBase::$rowClassOptions protected property The layout CSS row classes for options.
GridStackEnginePluginBase::$sizes protected property The layout sizes.
GridStackEnginePluginBase::$styles protected property The above-fold CSS inline styles as recommended by lighthouse.
GridStackEnginePluginBase::$stylizer protected property The stylizer service.
GridStackEnginePluginBase::attach public function Provides gridstack skins and libraries. 1
GridStackEnginePluginBase::attributes protected function Provides both CSS grid and js-driven attributes configurable via UI.
GridStackEnginePluginBase::build public function Alters GridStack build. Overrides GridStackEnginePluginInterface::build 1
GridStackEnginePluginBase::buildItem protected function Returns an individual item.
GridStackEnginePluginBase::buildItems public function Builds GridStack boxes to support nested grids for Bootstrap/ Foundation. Overrides GridStackEnginePluginInterface::buildItems
GridStackEnginePluginBase::buildNestedItems protected function Provides nested items if so configured.
GridStackEnginePluginBase::classOptions public function Returns the layout engine classes for select options. Overrides GridStackEnginePluginInterface::classOptions
GridStackEnginePluginBase::containerClasses public function 5
GridStackEnginePluginBase::contentAttributes protected function Provides the .gridstack__inner container attributes.
GridStackEnginePluginBase::create public static function Creates an instance of the plugin. Overrides GridStackPluginBase::create 2
GridStackEnginePluginBase::getIconBreakpoint public function Return the icon breakpoint to generate icon from.
GridStackEnginePluginBase::getSmallestBreakpoint public function Returns the smallest breakpoint, xs or sm.
GridStackEnginePluginBase::itemContentAttributes protected function Modifies the .box__content attributes. 1
GridStackEnginePluginBase::modifyItem protected function Modifies item content and attributes.
GridStackEnginePluginBase::modifyNestedItem protected function Modifies nested item contents and attributes.
GridStackEnginePluginBase::nestedContainerAttributes protected function Returns the .gridstack nested container attributes.
GridStackEnginePluginBase::prepare private function Prepares the settings, selector and active styles.
GridStackEnginePluginBase::rowClassOptions public function
GridStackEnginePluginBase::setContainerClasses protected function Sets the optional plugin engine container classes, configurable.
GridStackEnginePluginBase::setSizes protected function Sets the sizes.
GridStackEnginePluginBase::setStyles protected function Sets the styles, might be string, or array.
GridStackEnginePluginBase::sizes public function
GridStackEnginePluginBase::styles public function
GridStackPluginBase::$breakpoints protected property The layout breakpoints.
GridStackPluginBase::$cellHeight protected property The optionset cell height.
GridStackPluginBase::$columns protected property The breakpoint columns.
GridStackPluginBase::$currentUser protected property The current user.
GridStackPluginBase::$manager protected property The gridstack manager service.
GridStackPluginBase::$minWidth protected property The optionset min-width.
GridStackPluginBase::$optionset protected property The gridstack optionset.
GridStackPluginBase::$verticalMargin protected property The optionset vertical margin.
GridStackPluginBase::config protected function Returns gridstack config shortcut.
GridStackPluginBase::defaultConfiguration public function Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration 1
GridStackPluginBase::get public function
GridStackPluginBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
GridStackPluginBase::getOptionset public function
GridStackPluginBase::getSetting public function
GridStackPluginBase::label public function Returns the plugin label. Overrides GridStackPluginInterface::label
GridStackPluginBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
GridStackPluginBase::setOptionset public function Sets the optionset.
GridStackPluginBase::setSetting public function
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.
PluginBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. 92
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.