1. Documentation
  2. 8.x-3.x
  3. NavbarPosition.php
  4. class NavbarPosition

class NavbarPosition

The "navbar_position" theme setting.

Plugin annotation

@BootstrapSetting(
  id = "navbar_position",
  type = "select",
  title = @Translation("Navbar Position"),
  description = @Translation("Determines where the navbar is positioned on the page."),
  defaultValue = "",
  groups = {
    "components" = @Translation("Components"),
    "navbar" = @Translation("Navbar"),
  },
  empty_option = @Translation("Normal"),
  options = {
    "static-top" = @Translation("Static Top"),
    "fixed-top" = @Translation("Fixed Top"),
    "fixed-bottom" = @Translation("Fixed Bottom"),
  },
)

Hierarchy

Expanded class hierarchy of NavbarPosition

Related topics

@BootstrapSetting
Documentation for the @BootstrapSetting annotated plugin.

Namespace

Drupal\bootstrap\Plugin\Setting\Components\Navbar

Members

Contains filters are case sensitive
Name Modifiers Type Description
PluginBase::$theme protected property The currently set theme object.
PluginBase::__construct public function
SettingBase::$autoUserInterface public static property
SettingBase::access public function Indicates whether a setting is accessible. Overrides SettingInterface::access
SettingBase::alterForm public function The alter method to store the code. Overrides FormInterface::alterForm
SettingBase::alterFormElement public function The alter method to store the code. Overrides FormInterface::alterFormElement
SettingBase::autoCreateFormElement public function Indicates whether a form element should be created automatically. Overrides SettingInterface::autoCreateFormElement
SettingBase::drupalSettings public function Determines whether a theme setting should added to drupalSettings. Overrides SettingInterface::drupalSettings
SettingBase::getCacheTags public function The cache tags associated with this object. Overrides SettingInterface::getCacheTags
SettingBase::getDefaultValue public function Retrieves the setting's default value. Overrides SettingInterface::getDefaultValue
SettingBase::getDescription public function Retrieves the setting's description, if any. Overrides SettingInterface::getDescription
SettingBase::getElement Deprecated public function Overrides SettingInterface::getElement
SettingBase::getElementProperties public function Retrieves all the form properties from the setting definition.
SettingBase::getGroup Deprecated public function Overrides SettingInterface::getGroup
SettingBase::getGroupElement public function Retrieves the group form element the setting belongs to. Overrides SettingInterface::getGroupElement
SettingBase::getGroups public function Retrieves the setting's groups. Overrides SettingInterface::getGroups
SettingBase::getOptions public function Retrieves the settings options, if set. Overrides SettingInterface::getOptions
SettingBase::getSettingElement public function Retrieves the form element for the setting. Overrides SettingInterface::getSettingElement
SettingBase::getSettingValue protected function Retrieves the setting value used to populate the form.
SettingBase::getTitle public function Retrieves the setting's human-readable title. Overrides SettingInterface::getTitle
SettingBase::processDeprecatedValues public function Retrieves the value from other deprecated settings. Overrides SettingInterface::processDeprecatedValues
SettingBase::submitForm public static function Form submission handler. Overrides FormInterface::submitForm
SettingBase::submitFormElement public static function Form submission handler. Overrides FormInterface::submitFormElement
SettingBase::validateForm public static function Form validation handler. Overrides FormInterface::validateForm
SettingBase::validateFormElement public static function Form validation handler. Overrides FormInterface::validateFormElement