Класс yii\bootstrap\NavBar
| Наследование | yii\bootstrap\NavBar » yii\bootstrap\Widget » yii\base\Widget » yii\base\Component » yii\base\Object |
|---|---|
| Реализует | yii\base\Configurable, yii\base\ViewContextInterface |
| Использует Трейты | yii\bootstrap\BootstrapWidgetTrait |
| Доступно с версии | 2.0 |
| Исходный код | https://github.com/yiisoft/yii2-bootstrap/blob/master/NavBar.php |
NavBar отображает компонент HTML-меню навигации.
Любое содержимое, заключенное между вызовами begin() и end() NavBar, рассматривается как содержимое меню навигации. Вы можете использовать виджеты, такие как yii\bootstrap\Nav или yii\widgets\Menu, для создания такого содержимого. Например,
use yii\bootstrap\NavBar;
use yii\bootstrap\Nav;
NavBar::begin(['brandLabel' => 'NavBar Test']);
echo Nav::widget([
'items' => [
['label' => 'Home', 'url' => ['/site/index']],
['label' => 'About', 'url' => ['/site/about']],
],
'options' => ['class' => 'navbar-nav'],
]);
NavBar::end();
См. также http://getbootstrap.com/components/#navbar.
Публичные свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $autoIdPrefix | string | Префикс для автоматически сгенерированных идентификаторов виджета. | yii\base\Widget |
| $behaviors | yii\base\Behavior[] | Список присоединённых к этому компоненту поведений. | yii\base\Component |
| $brandLabel | string|boolean | Текст бренда или false, если он не используется. | yii\bootstrap\NavBar |
| $brandOptions | array | Атрибуты HTML для ссылки бренда. | yii\bootstrap\NavBar |
| $brandUrl | array|string|boolean | URL для гиперссылки бренда. | yii\bootstrap\NavBar |
| $clientEvents | array | Обработчики событий для базового Bootstrap JS-плагина. | yii\bootstrap\BootstrapWidgetTrait |
| $clientOptions | array | Параметры для базового Bootstrap JS-плагина. | yii\bootstrap\BootstrapWidgetTrait |
| $containerOptions | array | Атрибуты HTML для тега контейнера. | yii\bootstrap\NavBar |
| $counter | integer | Счётчик, используемый для генерации $id для виджетов. | yii\base\Widget |
| $id | string | Идентификатор виджета. | yii\base\Widget |
| $innerContainerOptions | array | Атрибуты HTML внутреннего контейнера. | yii\bootstrap\NavBar |
| $options | array | Атрибуты HTML для тега контейнера виджета. | yii\bootstrap\NavBar |
| $renderInnerContainer | boolean | Указывает, нужно ли включать содержимое меню навигации во внутренний контейнер div, что по умолчанию добавляет отступы слева и справа. | yii\bootstrap\NavBar |
| $screenReaderToggleText | string | Текст для экранных читалок для кнопки переключения меню навигации. | yii\bootstrap\NavBar |
| $stack | yii\base\Widget[] | Виджеты, которые в настоящее время отображаются (не закрыты). | yii\base\Widget |
| $view | yii\web\View | Объект представления, который можно использовать для отображения представлений или файлов представлений. | yii\bootstrap\BootstrapWidgetTrait |
| $viewPath | string | Директория, содержащая файлы представления для этого виджета. | yii\base\Widget |
Публичные методы
| Метод | Описание | Определено в |
|---|---|---|
| __call() | Вызывает метод, который не является методом класса. | yii\base\Object |
| __clone() | Этот метод вызывается после создания объекта путём клонирования существующего. | yii\base\Component |
| __construct() | Конструктор. | yii\base\Object |
| __get() | Возвращает значение свойства объекта. | yii\base\Object |
| __isset() | Проверяет, установлено ли свойство, т.е. определено и не равно null. | yii\base\Object |
| __set() | Устанавливает значение свойства объекта. | yii\base\Object |
| __unset() | Устанавливает свойство объекта в null. | yii\base\Object |
| afterRun() | Этот метод вызывается сразу после выполнения виджета. | yii\base\Widget |
| attachBehavior() | Присоединяет поведение к компоненту. | yii\base\Component |
| attachBehaviors() | Присоединяет список поведений к компоненту. | yii\base\Component |
| beforeRun() | Этот метод вызывается непосредственно перед выполнением виджета. | yii\base\Widget |
| begin() | Начинает выполнение виджета. | yii\base\Widget |
| behaviors() | Возвращает список поведений, по которым должен вести себя этот компонент. | yii\base\Component |
| canGetProperty() | Возвращает значение, указывающее, можно ли прочитать свойство. | yii\base\Object |
| canSetProperty() | Возвращает значение, указывающее, можно ли установить свойство. | yii\base\Object |
| className() | Возвращает полное имя этого класса. | yii\base\Object |
| detachBehavior() | Отсоединяет поведение от компонента. | yii\base\Component |
| detachBehaviors() | Отсоединяет все поведения от компонента. | yii\base\Component |
| end() | Заканчивает выполнение виджета. | yii\base\Widget |
| ensureBehaviors() | Убеждается, что поведения, объявленные в behaviors(), присоединены к этому компоненту. | yii\base\Component |
| getBehavior() | Возвращает объект поведения с заданным именем. | yii\base\Component |
| getBehaviors() | Возвращает все поведения, присоединённые к этому компоненту. | yii\base\Component |
| getId() | Возвращает идентификатор виджета. | yii\base\Widget |
| getView() | yii\bootstrap\BootstrapWidgetTrait | |
| getViewPath() | Возвращает каталог, содержащий файлы представления для этого виджета. | yii\base\Widget |
| hasEventHandlers() | Возвращает значение, указывающее, есть ли обработчик, присоединённый к заданному событию. | yii\base\Component |
| hasMethod() | Возвращает значение, указывающее, определён ли метод. | yii\base\Object |
| hasProperty() | Возвращает значение, указывающее, определено ли свойство. | yii\base\Object |
| init() | Инициализирует виджет. | yii\bootstrap\NavBar |
| off() | Отсоединяет существующий обработчик событий от этого компонента. | yii\base\Component |
| on() | Присоединяет обработчик событий к событию. | yii\base\Component |
| render() | Отображает представление. | yii\base\Widget |
| renderFile() | Отображает файл представления. | yii\base\Widget |
| run() | Отображает виджет. | yii\bootstrap\NavBar |
| setId() | Устанавливает идентификатор виджета. | yii\base\Widget |
| setView() | Устанавливает объект представления, который будет использоваться этим виджетом. | yii\base\Widget |
| trigger() | Вызывает событие. | yii\base\Component |
| widget() | Создаёт экземпляр виджета и выполняет его. | yii\base\Widget |
Защищённые методы
| Метод | Описание | Определено в |
|---|---|---|
| registerClientEvents() | Регистрирует обработчики событий JavaScript, перечисленные в $clientEvents. | yii\bootstrap\BootstrapWidgetTrait |
| registerPlugin() | Регистрирует определённый плагин Bootstrap и связанные с ним события. | yii\bootstrap\BootstrapWidgetTrait |
| renderToggleButton() | Отображает переключатель раскрывающегося элемента. | yii\bootstrap\NavBar |
События
| Событие | Тип | Описание | Определено в |
|---|---|---|---|
| EVENT_AFTER_RUN | yii\base\WidgetEvent | Событие, генерируемое сразу после выполнения виджета. (доступно начиная с версии 2.0.11) | yii\base\Widget |
| EVENT_BEFORE_RUN | yii\base\WidgetEvent | Событие, генерируемое непосредственно перед выполнением виджета. (доступно начиная с версии 2.0.11) | yii\base\Widget |
| EVENT_INIT | yii\base\Event | Событие, которое срабатывает, когда виджет инициализируется через init(). (доступно начиная с версии 2.0.11) | yii\base\Widget |
Подробное описание свойств
$brandLabel общественное свойство
Текст бренда или false, если он не используется. Обратите внимание, что это не кодируется в HTML.
См. также http://getbootstrap.com/components/#navbar.
public string|boolean $brandLabel = false
$brandOptions общественное свойство
Атрибуты HTML ссылки бренда.
См. также yii\helpers\Html::renderTagAttributes() для получения подробностей о том, как отображаются атрибуты.
public array $brandOptions = []
$brandUrl общественное свойство
URL для гиперссылки бренда. Этот параметр будет обработан yii\helpers\Url::to() и будет использован для атрибута «href» ссылки бренда. Значение по умолчанию — false, что означает, что будет использован yii\web\Application::$homeUrl. Можно установить его в null, если вы хотите, чтобы ссылка отсутствовала.
public array|string|boolean $brandUrl = false
$containerOptions общественное свойство
Атрибуты тега контейнера HTML. Признаны следующие специальные опции:
- tag: строка, по умолчанию "div", имя тега контейнера.
См. также yii\helpers\Html::renderTagAttributes() для получения подробной информации о том, как рендерятся атрибуты.
public array $containerOptions = []
$innerContainerOptions общедоступное свойство
Атрибуты HTML внутреннего контейнера.
См. также yii\helpers\Html::renderTagAttributes() для получения подробной информации о том, как рендерятся атрибуты.
public array $innerContainerOptions = []
$options общедоступное свойство
Атрибуты HTML для тега контейнера виджета. Признаны следующие специальные опции:
- tag: строка, по умолчанию "nav", имя тега контейнера.
См. также yii\helpers\Html::renderTagAttributes() для получения подробной информации о том, как рендерятся атрибуты.
public array $options = []
$renderInnerContainer общедоступное свойство
Нужно ли включать содержимое навигационной панели в внутренний контейнер div, который по умолчанию добавляет левые и правые отступы. Установите это значение в false для навигационной панели со 100%-ной шириной.
public boolean $renderInnerContainer = true
$screenReaderToggleText общедоступное свойство
Текст для чтения экраном для кнопки переключения навигационной панели.
public string $screenReaderToggleText = 'Toggle navigation'
Подробное описание методов
init() общедоступный метод
Инициализирует виджет.
| public void init ( ) |
|---|
renderToggleButton() защищённый метод
Отображает кнопку переключения выпадающего меню.
| protected string renderToggleButton ( ) | ||
|---|---|---|
| return | string |
Рендеринг кнопки переключения. |
run() общедоступный метод
Отображает виджет.
| public void run ( ) |
|---|
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-bootstrap-navbar.html