You are here

Home » API reference » GridStack 8.2 » Bootstrap3.php

class Bootstrap3 in GridStack 8.2

Provides a GridStack Bootstrap 3 layout engine.

Plugin annotation


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

Hierarchy

Expanded class hierarchy of Bootstrap3

File

src/Plugin/gridstack/engine/Bootstrap3.php, line 19

Namespace

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

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    $instance = parent::create($container, $configuration, $plugin_id, $plugin_definition);
    $sizes = $instance->sizes ?: GridStackDefault::breakpoints();
    array_pop($sizes);
    $instance->sizes = $instance
      ->setSizes($sizes);
    return $instance;
  }

  /**
   * {@inheritdoc}
   */
  protected function getVersionClasses() {
    $classes = parent::getVersionClasses();
    foreach (array_keys($this->sizes) as $size) {
      $hidden[] = "hidden-{$size}";
      $visible[] = "visible-{$size}";
    }
    $classes['hidden'] = $hidden;
    $classes['visible'] = $visible;
    return $classes;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
Bootstrap3::create public static function Creates an instance of the plugin. Overrides GridStackEnginePluginBase::create
Bootstrap3::getVersionClasses protected function Returns the module feature CSS classes, not available at CSS frameworks. Overrides GridStackEnginePluginBase::getVersionClasses
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::baseColors protected function Returns the base colors. 1
BootstrapBase::colors protected function Returns the colors. 1
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::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::setRowClassOptions protected function Sets the optional plugin engine classes for options, row, hard-coded. 1
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.