class Sidr in Responsive Menus 8

Defines the "sidr" plugin.

Plugin annotation


@ResponsiveMenus(
  id = "sidr",
  label = @Translation("Sidr"),
  library = "responsive_menus/sidr"
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\Core\Field\PluginSettingsBase implements DependentPluginInterface, PluginSettingsInterface
    class \Drupal\responsive_menus\ResponsiveMenusPluginBase implements ResponsiveMenusPluginInterface
    class \Drupal\responsive_menus\Plugin\ResponsiveMenus\Sidr implements ResponsiveMenusPluginInterface

Expanded class hierarchy of Sidr

File

src/Plugin/ResponsiveMenus/Sidr.php, line 18

Namespace

Drupal\responsive_menus\Plugin\ResponsiveMenus

View source

class Sidr extends ResponsiveMenusPluginBase implements ResponsiveMenusPluginInterface {

  /**
   * {@inheritdoc}
   */
  public static function getSelectorInfo() {
    return t('Anything (parent of ul preferred).  Example: Given <code>@code</code> you could use @use', [
      '@ul' => '<ul>',
      '@code' => '<div id="parent-div"> <ul class="menu"> </ul> </div>',
      '@use' => '<strong>#parent-div or .menu</strong>',
    ]);
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'responsive_menus_sidr_css_selectors' => '#main-menu',
      'responsive_menus_sidr_trigger_txt' => t('Menu'),
      'responsive_menus_sidr_menu_side' => 'left',
      'responsive_menus_sidr_menu_theme' => 'dark',
      'responsive_menus_sidr_animation_speed' => 200,
      'responsive_menus_sidr_media_size' => 768,
      'responsive_menus_sidr_displace' => 1,
      'responsive_menus_sidr_renaming' => 1,
      'responsive_menus_sidr_on_open' => '',
      'responsive_menus_sidr_on_close' => '',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $form['responsive_menus_sidr_css_selectors'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('CSS selectors for which menu to responsify'),
      '#default_value' => $this
        ->getSetting('responsive_menus_sidr_css_selectors'),
      '#description' => $this
        ->t('Enter CSS/jQuery selectors of menus to responsify.  Comma separated or 1 per line'),
    ];
    $form['responsive_menus_sidr_trigger_txt'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('Text or HTML for trigger button'),
      '#default_value' => $this
        ->getSetting('responsive_menus_sidr_trigger_txt'),
    ];
    $form['responsive_menus_sidr_menu_side'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Position of the menu (left/right)'),
      '#options' => [
        'left' => $this
          ->t('Left'),
        'right' => $this
          ->t('Right'),
      ],
      '#default_value' => $this
        ->getSetting('responsive_menus_sidr_menu_side'),
    ];
    $form['responsive_menus_sidr_menu_theme'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Theme'),
      '#options' => [
        'dark' => $this
          ->t('Dark'),
        'light' => $this
          ->t('Light'),
        'custom' => $this
          ->t('Custom'),
      ],
      '#default_value' => $this
        ->getSetting('responsive_menus_sidr_menu_theme'),
      '#description' => $this
        ->t('Select which <a href="@theme">theme</a> will be used to style the menu. If "Custom" is selected, no CSS will be added; you will need to add your own styles.', [
        '@theme' => 'http://www.berriart.com/sidr/#themes',
      ]),
    ];
    $form['responsive_menus_sidr_animation_speed'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Sidr animation speed'),
      '#size' => 5,
      '#default_value' => $this
        ->getSetting('responsive_menus_sidr_animation_speed'),
      '#description' => $this
        ->t('Speed (in milliseconds) of menu open/close. 1000 = 1 second.'),
    ];
    $form['responsive_menus_sidr_media_size'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Screen width to respond to'),
      '#size' => 5,
      '#default_value' => $this
        ->getSetting('responsive_menus_sidr_media_size'),
      '#description' => $this
        ->t('Width in pixels when we swap out responsive menu e.g. 768'),
    ];
    $form['responsive_menus_sidr_displace'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Displace body content?'),
      '#options' => [
        1 => t('Yes'),
        0 => t('No'),
      ],
      '#default_value' => $this
        ->getSetting('responsive_menus_sidr_displace'),
      '#description' => $this
        ->t('This setting controls whether the page is pushed when menu is opened.'),
    ];
    $form['responsive_menus_sidr_renaming'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Rename classes'),
      '#options' => [
        1 => $this
          ->t('Yes'),
        0 => $this
          ->t('No'),
      ],
      '#default_value' => $this
        ->getSetting('responsive_menus_sidr_renaming'),
      '#description' => $this
        ->t('Controls whether Sidr will rename classes within the the selectors specified.'),
    ];
    $form['responsive_menus_sidr_on_open'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('onOpen callback (function)'),
      //      '#description' => t('See !documentation for examples.', ['!documentation' => l(t('Sidr documentation'), 'http://www.berriart.com/sidr/#documentation')]),
      '#default_value' => $this
        ->getSetting('responsive_menus_sidr_on_open'),
    ];
    $form['responsive_menus_sidr_on_close'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('onClose callback (function)'),
      //      '#description' => t('See !documentation for examples.', ['!documentation' => l(t('Sidr documentation'), 'http://www.berriart.com/sidr/#documentation')]),
      '#default_value' => $this
        ->getSetting('responsive_menus_sidr_on_close'),
    ];

    /* Other sidr attributes not implemented:
     *
     * renaming (Boolean) Default: true
     * When filling the sidr with existing content, choose to rename or not the
     * classes and ids.
     *
     * body (String) Default: 'body' [ Version 1.1.0 an above ]
     * For doing the page movement the 'body' element is animated by default,
     * you can select another element to animate with this option.
     *
     * displace (Boolean) Default: true [ Version 1.2.0 an above ]
     * Displace the body content or not.
     */
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function getJsSettings() {
    $js_settings = [
      'selectors' => $this
        ->getSettingArray('responsive_menus_sidr_css_selectors'),
      'trigger_txt' => $this
        ->getSetting('responsive_menus_sidr_trigger_txt'),
      'side' => $this
        ->getSetting('responsive_menus_sidr_menu_side'),
      'speed' => $this
        ->getSetting('responsive_menus_sidr_animation_speed'),
      'media_size' => $this
        ->getSetting('responsive_menus_sidr_media_size'),
      'displace' => $this
        ->getSetting('responsive_menus_sidr_displace'),
      'renaming' => $this
        ->getSetting('responsive_menus_sidr_renaming'),
      'onOpen' => $this
        ->getSetting('responsive_menus_sidr_on_open'),
      'onClose' => $this
        ->getSetting('responsive_menus_sidr_on_close'),
    ];
    return $js_settings;
  }

  /**
   * Gets this plugin's configuration.
   *
   * @return array
   *   An array of this plugin's configuration.
   */
  public function getConfiguration() {

    // TODO: Implement getConfiguration() method.
  }

  /**
   * Sets the configuration for this plugin instance.
   *
   * @param array $configuration
   *   An associative array containing the plugin's configuration.
   */
  public function setConfiguration(array $configuration) {

    // TODO: Implement setConfiguration() method.
  }

  /**
   * Gets default configuration for this plugin.
   *
   * @return array
   *   An associative array with the default configuration.
   */
  public function defaultConfiguration() {

    // TODO: Implement defaultConfiguration() method.
  }

}

Members

Name	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::$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.
PluginSettingsBase::$defaultSettingsMerged	protected	property	Whether default settings have been merged into the current $settings.
PluginSettingsBase::$settings	protected	property	The plugin settings.	2
PluginSettingsBase::$thirdPartySettings	protected	property	The plugin settings injected by third party modules.
PluginSettingsBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies	6
PluginSettingsBase::getSetting	public	function	Returns the value of a setting, or its default value if absent. Overrides PluginSettingsInterface::getSetting
PluginSettingsBase::getSettings	public	function	Returns the array of settings, including defaults for missing settings. Overrides PluginSettingsInterface::getSettings
PluginSettingsBase::getThirdPartyProviders	public	function	Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
PluginSettingsBase::getThirdPartySetting	public	function	Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
PluginSettingsBase::getThirdPartySettings	public	function	Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
PluginSettingsBase::mergeDefaults	protected	function	Merges default settings values into $settings.
PluginSettingsBase::onDependencyRemoval	public	function	Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsInterface::onDependencyRemoval	3
PluginSettingsBase::setSetting	public	function	Sets the value of a setting for the plugin. Overrides PluginSettingsInterface::setSetting
PluginSettingsBase::setSettings	public	function	Sets the settings for the plugin. Overrides PluginSettingsInterface::setSettings
PluginSettingsBase::setThirdPartySetting	public	function	Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
PluginSettingsBase::unsetThirdPartySetting	public	function	Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
ResponsiveMenusPluginBase::getSettingArray	protected	function	Return array of selectors for JS settings.
ResponsiveMenusPluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct
Sidr::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration
Sidr::defaultSettings	public static	function	Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
Sidr::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
Sidr::getJsSettings	public	function	Get Drupal Javscript settings array. Overrides ResponsiveMenusPluginBase::getJsSettings
Sidr::getSelectorInfo	public static	function	Provide UI with plugins selector information. Overrides ResponsiveMenusPluginBase::getSelectorInfo
Sidr::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
Sidr::settingsForm	public	function	Form constructor. Overrides ResponsiveMenusPluginBase::settingsForm
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.

You are here

class Sidr in Responsive Menus 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation