class ResponsiveMenusSimple in Responsive Menus 8

Defines the "responsive_menus_simple" plugin.

Plugin annotation


@ResponsiveMenus(
  id = "responsive_menus_simple",
  label = @Translation("Simple expanding"),
  library = "responsive_menus/responsive_menus_simple"
)

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\ResponsiveMenusSimple implements ResponsiveMenusPluginInterface

Expanded class hierarchy of ResponsiveMenusSimple

File

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

Namespace

Drupal\responsive_menus\Plugin\ResponsiveMenus

View source

class ResponsiveMenusSimple extends ResponsiveMenusPluginBase implements ResponsiveMenusPluginInterface {

  /**
   * {@inheritdoc}
   */
  public static function getSelectorInfo() {
    return t('Anything.  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_simple_absolute' => 1,
      'responsive_menus_disable_mouse_events' => 0,
      'responsive_menus_remove_attributes' => 1,
      'responsive_menus_css_selectors' => '#main-menu',
      'responsive_menus_simple_text' => '☰ Menu',
      'responsive_menus_media_size' => 768,
      'responsive_menus_media_unit' => 'px',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $form['responsive_menus_simple_absolute'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Use absolute positioning?'),
      '#default_value' => $this
        ->getSetting('responsive_menus_simple_absolute'),
      '#description' => $this
        ->t('Using absolute, the menu will open over the page rather than pushing it down.'),
    ];
    $form['responsive_menus_disable_mouse_events'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Disable other mouse events?'),
      '#default_value' => $this
        ->getSetting('responsive_menus_disable_mouse_events'),
      '#description' => $this
        ->t('Disable things like drop-down menus on hover.'),
    ];
    $form['responsive_menus_remove_attributes'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Remove other classes & IDs when responded?'),
      '#default_value' => $this
        ->getSetting('responsive_menus_remove_attributes'),
      '#description' => $this
        ->t('Helps to ensure styling of menu.'),
    ];
    $form['responsive_menus_css_selectors'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('Selectors for which menus to responsify'),
      '#default_value' => $this
        ->getSetting('responsive_menus_css_selectors'),
      '#description' => $this
        ->t('Enter CSS/jQuery selectors of menus to responsify.  Comma separated or 1 per line'),
    ];
    $form['responsive_menus_simple_text'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('Text or HTML for the menu toggle button'),
      '#default_value' => $this
        ->getSetting('responsive_menus_simple_text'),
    ];
    $form['responsive_menus_media_size'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Screen width to respond to'),
      '#size' => 5,
      '#default_value' => $this
        ->getSetting('responsive_menus_media_size'),
      '#description' => $this
        ->t('Width when we swap out responsive menu e.g. 768'),
    ];
    $form['responsive_menus_media_unit'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Width unit'),
      '#default_value' => $this
        ->getSetting('responsive_menus_media_unit'),
      '#options' => [
        'px' => 'px',
        'em' => 'em',
      ],
      '#description' => $this
        ->t('Unit for the width above'),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function getJsSettings() {
    $js_settings = [
      'toggler_text' => $this
        ->getSetting('responsive_menus_simple_text'),
      'selectors' => $this
        ->getSettingArray('responsive_menus_css_selectors'),
      'media_size' => $this
        ->getSetting('responsive_menus_media_size'),
      'media_unit' => $this
        ->getSetting('responsive_menus_media_unit'),
      'absolute' => $this
        ->getSetting('responsive_menus_simple_absolute'),
      'disable_mouse_events' => $this
        ->getSetting('responsive_menus_disable_mouse_events'),
      'remove_attributes' => $this
        ->getSetting('responsive_menus_remove_attributes'),
    ];
    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
ResponsiveMenusSimple::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration
ResponsiveMenusSimple::defaultSettings	public static	function	Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
ResponsiveMenusSimple::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
ResponsiveMenusSimple::getJsSettings	public	function	Get Drupal Javscript settings array. Overrides ResponsiveMenusPluginBase::getJsSettings
ResponsiveMenusSimple::getSelectorInfo	public static	function	Provide UI with plugins selector information. Overrides ResponsiveMenusPluginBase::getSelectorInfo
ResponsiveMenusSimple::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
ResponsiveMenusSimple::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 ResponsiveMenusSimple in Responsive Menus 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation