Класс yii\widgets\Menu

Menu отображает многоуровневое меню с использованием вложенных HTML списков.

Основным свойством Menu является $items, которое определяет возможные пункты меню. Элемент меню может содержать подпункты, определяющие подменю под этим элементом.

Menu проверяет текущий маршрут и параметры запроса, чтобы переключать определенные пункты меню в активное состояние.

Обратите внимание, что Menu только отображает HTML-теги меню. Он не выполняет стилизацию. Вы отвечаете за предоставление CSS-стилей, чтобы это выглядело как настоящее меню.

Следующий пример демонстрирует использование Menu:

echo Menu::widget([
    'items' => [
        // Important: you need to specify url as 'controller/action',
        // not just as 'controller' even if default action is used.
        ['label' => 'Home', 'url' => ['site/index']],
        // 'Products' menu item will be selected as long as the route is 'product/index'
        ['label' => 'Products', 'url' => ['product/index'], 'items' => [
            ['label' => 'New Arrivals', 'url' => ['product/index', 'tag' => 'new']],
            ['label' => 'Most Popular', 'url' => ['product/index', 'tag' => 'popular']],
        ]],
        ['label' => 'Login', 'url' => ['site/login'], 'visible' => Yii::$app->user->isGuest],
    ],
]);

Общественные свойства

Общественные методы

Защищённые методы

События

Подробное описание свойств

$activateItems общедоступное свойство

Автоматически активировать элементы в зависимости от соответствия их параметра маршрута текущему запрошенному маршруту.

См. также isItemActive().

public boolean $activateItems = true

$activateParents общедоступное свойство

Активировать родительские элементы меню, когда один из соответствующих дочерних элементов меню активен. У активированных родительских элементов меню также будут добавлены CSS-классы, добавленные к $activeCssClass.

public boolean $activateParents = false

$activeCssClass общедоступное свойство

CSS-класс, который будет добавлен к активному элементу меню.

public string $activeCssClass = 'active'

$encodeLabels общедоступное свойство

Необходимо ли кодировать метки элементов меню в HTML.

public boolean $encodeLabels = true

$firstItemCssClass общедоступное свойство

Класс CSS, который будет назначен первому элементу в главном меню или каждому подменю. По умолчанию равен null, что означает, что такой класс CSS не будет назначен.

public string $firstItemCssClass = null

$hideEmptyItems свойство public

Указывает, нужно ли скрывать пустые элементы меню. Пустым элементом меню является элемент, у которого url опция не установлена и который не имеет видимых дочерних элементов меню.

public boolean $hideEmptyItems = true

$itemOptions свойство public

Список HTML-атрибутов, общих для всех элементов меню $items. Если отдельный элемент меню указывает свои options, они будут объединены с этим свойством перед использованием для генерации HTML-атрибутов для тега элемента меню. Признаются следующие специальные опции:

• tag: строка, по умолчанию "li", имя тега тегов-контейнеров элемента. Установите в false, чтобы отключить тег контейнера. См. также yii\helpers\Html::tag().

См. также yii\helpers\Html::renderTagAttributes() для получения подробной информации о том, как атрибуты выводятся.

public array $itemOptions = []

$items свойство public

Список элементов меню. Каждый элемент меню должен быть массивом следующей структуры:

• label: строка, необязательно, задает метку элемента меню. Когда $encodeLabels имеет значение true, метка будет закодирована в HTML. Если метка не указана, будет использована пустая строка.
• encode: boolean, необязательно, нужно ли кодировать метку этого элемента в HTML. Этот параметр переопределит глобальный параметр $encodeLabels.
• url: строка или массив, необязательно, указывает URL элемента меню. Он будет обработан с помощью yii\helpers\Url::to(). Если он установлен, фактическое содержимое элемента меню будет сгенерировано с использованием $linkTemplate; в противном случае будет использован $labelTemplate.
• visible: boolean, необязательно, отображается ли этот элемент меню. По умолчанию true.
• items: массив, необязательно, задает элементы подменю. Его формат аналогичен родительским элементам.
• active: boolean или Closure, необязательно, активен ли этот элемент меню (в данный момент выбран). При использовании замыкания его сигнатура должна быть function ($item, $hasActiveChild, $isItemActive, $widget). Замыкание должно возвращать true если элемент должен быть помечен как active, в противном случае - false. Если элемент меню активен, его класс CSS будет дополнен $activeCssClass. Если этот параметр не установлен, элемент меню будет автоматически активирован при запуске текущего запроса url. Для получения более подробной информации, пожалуйста, обратитесь к isItemActive().
• template: строка, необязательно, шаблон, используемый для рендеринга содержимого этого элемента меню. Токен {url} будет заменен на URL, связанный с этим элементом меню, а токен {label} - на метку элемента меню. Если эта опция не установлена, будет использоваться $linkTemplate или $labelTemplate.
• submenuTemplate: строка, необязательно, шаблон, используемый для рендеринга списка подменю. Токен {items} будет заменен на отрендеренные элементы подменю. Если эта опция не установлена, будет использоваться $submenuTemplate.
• options: массив, необязательно, HTML-атрибуты для тега контейнера меню.

public array $items = []

$labelTemplate свойство public

Шаблон, используемый для рендеринга тела меню, которое НЕ является ссылкой. В этом шаблоне токен {label} будет заменён на метку элемента меню. Это свойство будет переопределено опцией template, заданной в отдельных элементах меню через $items.

public string $labelTemplate = '{label}'

$lastItemCssClass свойство public

Класс CSS, который будет назначен последнему элементу в главном меню или каждом подменю. По умолчанию равен null, что означает, что такой класс CSS не будет назначен.

public string $lastItemCssClass = null

$linkTemplate свойство public

Шаблон, используемый для рендеринга тела меню, которое является ссылкой. В этом шаблоне токен {url} будет заменён соответствующим URL-адресом ссылки; а {label} будет заменён текстом ссылки. Это свойство будет переопределено опцией template, заданной в отдельных элементах меню через $items.

public string $linkTemplate = '<a href="{url}">{label}</a>'

$options свойство public

HTML-атрибуты для тега контейнера меню. Признаются следующие специальные опции:

• tag: строка, по умолчанию "ul", имя тега тегов-контейнеров элемента. Установите в false, чтобы отключить тег контейнера. См. также yii\helpers\Html::tag().

См. также yii\helpers\Html::renderTagAttributes() для получения подробной информации о том, как атрибуты выводятся.

public array $options = []

$params свойство public

Параметры, используемые для определения, является ли элемент меню активным или нет. Если не задано, будет использовано $_GET.

См. также:

• $route
• isItemActive()

public array $params = null

$route свойство public

Маршрут, используемый для определения, является ли элемент меню активным или нет. Если не задано, будет использован маршрут текущего запроса.

См. также:

• $params
• isItemActive()

public string $route = null

$submenuTemplate свойство public

Шаблон, используемый для рендеринга списка подменю. В этом шаблоне токен {items} будет заменён отрендеренными элементами подменю.

public string $submenuTemplate = "\n<ul>\n{items}\n</ul>\n"

Подробное описание методов