You are here

Home » API reference » GridStack 8.2 » Help.php

class Help in GridStack 8.2

Provides the help.

Plugin annotation


@GridStackStylizer(
  id = "help",
  label = @Translation("Help")
)

Hierarchy

Expanded class hierarchy of Help

File

src/Plugin/gridstack/stylizer/Help.php, line 13

Namespace

Drupal\gridstack\Plugin\gridstack\stylizer
View source 
class Help extends MediaForm {

  /**
   * Returns the help element.
   */
  protected function helpElement() {
    $element = [
      '#type' => 'details',
      '#open' => FALSE,
      '#title' => $this
        ->t('Help?'),
      '#attributes' => [
        'class' => [
          'form-wrapper--help',
        ],
      ],
      '#weight' => 60,
    ];
    $items = [];
    $items[] = $this
      ->t('Save the form first before working.');
    $items[] = $this
      ->t('Create one multi-value unlimited <code>Media</code> field containing <code>Image, Video or Remote Video</code> bundles right on this entity/ content type before using the Media Library. Then select it under <code>Global settings > Main settings</code>.');
    $items[] = $this
      ->t('Avoid <code>Viewport Height (VH 100)</code> or any fixed height, unless desired. Use <code>Min Height</code> instead.');
    $items[] = $this
      ->t('Use <code>Min Height</code> at <code>Preset classes</code> if the image/ media is collapsed.');
    $items[] = $this
      ->t('Select <code>Black (#000000)</code> to disable color.');
    $items[] = $this
      ->t('Avoid color-related options at <code>Preset classes</code> to make custom <code>Styles</code> work.');
    $items[] = $this
      ->t('The layout editor is two-dimensional. Unless for two-dimensional, it is not _always applicable to one-dimensional layouts. Understanding the principal difference should reduce confusion. Shortly, if the output is different from preview, adjust it accordingly.');
    $items[] = $this
      ->t('Unless uploading images, no need to keep saving the form. Click each <code>+ Styles</code> button to select regions without AJAX once the modal is open instead. Once done, be sure to hit <code>Update</code> button, or lose all the stylings.');
    $items[] = $this
      ->t('Anything under <code>Styles</code> requires the provided Media Library Image or Media, not blocks, for now.');
    $items[] = $this
      ->t('If a layout variant is added or changed drastically (e.g. 12 columns becomes 2 or 3), be sure to re-sync, or re-save, this modal form (hit <code>Update</code> button) _only if any display issue. The reason, some options require 12 columns like EtE, etc.');
    $items[] = $this
      ->t('If a layout variant is messed up for a reason, simply revert, or delete it.');
    $items[] = $this
      ->t('<b>Known bugs</b>: <br>- when editing a region (not the global container), it must have a red outline. If not, try re-clicking <code>+ Styles</code> button. <br>- <b>Save as New</b> is still chaotic, not generating icon, not directly saves the label. Needs re-adding label, then <b>Update icon</b> > <b>Save</b> or <b>Apply</b>.');
    $element['help'] = [
      '#theme' => 'item_list',
      '#items' => $items,
    ];
    return $element;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
Animation::animationElement protected function Provides animation form elements.
Animation::animations public static function Returns utilities settings.
Background::getBackgroundColor protected function Returns the background colors grouped by the given key, w/o text colors.
Classes::$opacity protected property The black opacity for backgrounds or colors.
Classes::afterBuildPreset public function Provides preview classes.
Classes::classElement protected function Returns common class element.
Classes::classesElement protected function
Classes::getBasePresetOptions protected function
Classes::getInternalClasses public function Returns the module feature CSS classes, not available at CSS frameworks.
Classes::getPresetOptions protected function
Classes::getPresetRowOptions protected function
Classes::rowClassesElement protected function
Color::colorElement protected function Provides extras form elements.
Color::getTextColor protected function Returns the text colors grouped by the given key.
Color::paletteElement protected function Return the color palette element.
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
Extras::afterBuildExtras public function Provides preview classes.
Extras::attach public function Provides gridstack skins and libraries. Overrides GridStackStylizerPluginBase::attach 1
Extras::defaultConfiguration public function @todo implements when having enough consistency. Overrides GridStackPluginBase::defaultConfiguration
Extras::extrasElement protected function Provides extras form elements.
Extras::isWideRegionOption protected function Checks if an option should be for 12 column wide.
Extras::options public static function Returns utilities settings.
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::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
GridStackStylizerPluginBase::$blazyEntity protected property The blazy entity service to support Media Library at Layout Builder pages.
GridStackStylizerPluginBase::getVariantUniqueId protected function Returns unique variant ID.
GridStackStylizerPluginBase::validateConfigurationForm public function 1
Help::helpElement protected function Returns the help element.
Media::$fieldName protected property The field name to store media.
Media::buildMedia public function Returns the formatted media as Blazy CSS background.
Media::create public static function Creates an instance of the plugin. Overrides GridStackStylizerPluginBase::create
Media::getFieldName public function Returns the selected field name.
Media::mediaSettings protected function Returns the data understood by Blazy for CSS background.
Media::prepareMedia protected function Returns the formatted media as Blazy output.
Media::prepareOverlay protected function Returns the media overlay.
Media::setFieldName public function Sets the field name.
MediaForm::$bundle protected property Bundle to be displayed.
MediaForm::$entity protected property The current entity.
MediaForm::$fieldDefinition protected property The field definition.
MediaForm::$fieldDefinitions protected property A list of field definitions eligible for configuration in this display.
MediaForm::$fieldSettings protected property The media field settings.
MediaForm::$responsiveImageOptions protected property The responsive image options.
MediaForm::$targetEntityType protected property Entity type to be displayed.
MediaForm::addItems public static function Updates the field state and flags the form for rebuild.
MediaForm::getEntity public function Returns the current entity.
MediaForm::getEntityData public function Return available entity data.
MediaForm::getFieldCardinality public function Returns available field media definition.
MediaForm::getFieldData protected function Returns available field media data.
MediaForm::getFieldDefinition public function Returns available field media definition.
MediaForm::getFieldDefinitions protected function Gets the definitions of the fields that are candidate for display.
MediaForm::getFieldSettings public function Returns available field media settings.
MediaForm::getFieldState protected static function Gets the field state for the widget.
MediaForm::getLayoutFieldOptions public function Returns available field media for select options.
MediaForm::getMediaData protected function Returns the media data.
MediaForm::getMediaLibraryTheme public function Returns the available admin theme to fetch the media library styling.
MediaForm::getNewMediaItems protected static function Gets newly selected media items.
MediaForm::getResponsiveImageOptions public function Returns Responsive image for select options.
MediaForm::getUserInputValues protected static function Returns user input values.
MediaForm::mediaElement protected function Returns Media Library form elements adapted from MediaLibraryWidget.
MediaForm::removeItem public static function Submit callback for remove buttons.
MediaForm::saveMediaId protected function Returns the selected media id, supports both upload and media library.
MediaForm::setEntity protected function Returns the current entity.
MediaForm::setFieldSettings protected function Sets available field media settings.
MediaForm::setFieldState protected static function Sets the field state for the widget.
MediaForm::updateWidget public static function AJAX callback to update the widget when the selection changes.
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
Range::rangeElement protected function Returns the range element.
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.
Style::getStyles public function Parses the given color strings keyed by index or .box__content or selector.
StyleBase::attributes public function Provides both CSS grid and js-driven attributes configurable via UI.
StyleBase::cssRule protected function Returns the CSS rule with a selector and sub selector if available.
StyleBase::extraAttributes protected function Modifies any attributes relevant to use backgrounds.
StyleBase::getAnimation public function Returns an animation.
StyleBase::getColor protected function Checks for valid color excluding black (#000000) by design.
StyleBase::getColors protected function Returns available colors.
StyleBase::getSelector public function Returns selectors and sub-selectors with context related to box levels.
StyleBase::getStyle public function Returns a style.
StyleBase::getVariantClass public function Returns the variant class.
StyleBase::hasColors protected function Checks if it has colors.
StyleBase::inlineStyle public function Modifies inline style to not nullify others.
StyleBase::parseAttributes protected function Parses the string attribute: role|navigation,data-something|some value.
StyleBase::parseClasses protected function Parses the given string classes.
StyleBase::parseStyles public function Builds inline styles if so required with multiple instances on a page.
StyleBase::styleElement protected function Return the style element.
Wrapper::wrapperElement protected function