PHP Класс macgyer\yii2materializecss\widgets\Nav

php echo Nav::widget([ 'items' => [ [ 'label' => 'Home', 'url' => ['site/index'], 'linkOptions' => [...], ], [ 'label' => 'Dropdown', 'items' => [ ['label' => 'Level 1 - Dropdown A', 'url' => '#'], ['label' => 'Level 1 - Dropdown B', 'url' => '#'], ], ], [ 'label' => 'Login', 'url' => ['site/login'], 'visible' => Yii::$app->user->isGuest ], ], ]);
См. также: http://materializecss.com/navbar.html
Автор: Christoph Erdmann ([email protected])
Наследование: extends macgyer\yii2materializecss\lib\BaseWidget
Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
$activateItems whether to automatically activate items according to whether their route setting matches the currently requested route.
$activateParents whether to activate parent menu items when one of the corresponding child menu items is active.
$dropDownCaret this property allows you to customize the HTML which is used to generate the drop down caret symbol, which is displayed next to the button text to indicate the drop down functionality. Defaults to null which means arrow_drop_down will be used. To disable the caret, set this property to be an empty string.
$encodeLabels whether the nav items labels should be HTML-encoded.
$items list of items in the nav widget. Each array element represents a single menu item which can be either a string or an array with the following structure: - label: string, required, the nav item label. - url: optional, the item's URL. Defaults to "#". - visible: boolean, optional, whether this menu item is visible. Defaults to true. - linkOptions: array, optional, the HTML attributes of the item's link. - options: array, optional, the HTML attributes of the item container (LI). - active: boolean, optional, whether the item should be on active state or not. - dropDownOptions: array, optional, the HTML options that will passed to the Dropdown widget. - items: array|string, optional, the configuration array for creating a Dropdown widget, or a string representing the dropdown menu. Note that Bootstrap does not support sub-dropdown menus. - encode: boolean, optional, whether the label will be HTML-encoded. If set, supersedes the $encodeLabels option for only this item. If a menu item is a string, it will be rendered directly without HTML encoding.
$params the parameters used to determine if a menu item is active or not. If not set, it will use $_GET.
$route the route used to determine if a menu item is active or not. If not set, it will use the route of the current request.

Открытые методы

Метод Описание
init ( ) Initializes the widget.
renderItem ( string | array $item ) : string Renders a widget's item.
renderItems ( ) Renders widget items.
run ( ) Renders the widget.

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

Метод Описание
isChildActive ( array $items, boolean &$active ) : array Check to see if a child item is active optionally activating the parent.
isItemActive ( array $item ) : boolean Checks whether a menu item is active.
renderDropdown ( array $items, array $parentItem, string $targetId ) : string Renders the given items as a dropdown.

Описание методов

init() публичный Метод

Initializes the widget.
public init ( )

isChildActive() защищенный Метод

Check to see if a child item is active optionally activating the parent.
protected isChildActive ( array $items, boolean &$active ) : array
$items array @see items
$active boolean should the parent be active too
Результат array @see items

isItemActive() защищенный Метод

This is done by checking if [[route]] and [[params]] match that specified in the url option of the menu item. When the url option of a menu item is specified in terms of an array, its first element is treated as the route for the item and the rest of the elements are the associated parameters. Only when its route and parameters match [[route]] and [[params]], respectively, will a menu item be considered active.
protected isItemActive ( array $item ) : boolean
$item array the menu item to be checked
Результат boolean whether the menu item is active

renderDropdown() защищенный Метод

This method is called to create sub-menus.
См. также: http://materializecss.com/navbar.html#navbar-dropdown
С версии: 2.0.1
protected renderDropdown ( array $items, array $parentItem, string $targetId ) : string
$items array the given items. Please refer to [[Dropdown::items]] for the array structure.
$parentItem array the parent item information. Please refer to [[items]] for the structure of this array.
$targetId string the dropdown id
Результат string the rendering result.

renderItem() публичный Метод

Renders a widget's item.
public renderItem ( string | array $item ) : string
$item string | array the item to render.
Результат string the rendering result.

renderItems() публичный Метод

Renders widget items.
public renderItems ( )

run() публичный Метод

Renders the widget.
public run ( )

Описание свойств

$activateItems публичное свойство

whether to automatically activate items according to whether their route setting matches the currently requested route.
См. также: isItemActive
public $activateItems

$activateParents публичное свойство

whether to activate parent menu items when one of the corresponding child menu items is active.
public $activateParents

$dropDownCaret публичное свойство

this property allows you to customize the HTML which is used to generate the drop down caret symbol, which is displayed next to the button text to indicate the drop down functionality. Defaults to null which means arrow_drop_down will be used. To disable the caret, set this property to be an empty string.
См. также: http://materializecss.com/navbar.html#navbar-dropdown
public $dropDownCaret

$encodeLabels публичное свойство

whether the nav items labels should be HTML-encoded.
public $encodeLabels

$items публичное свойство

list of items in the nav widget. Each array element represents a single menu item which can be either a string or an array with the following structure: - label: string, required, the nav item label. - url: optional, the item's URL. Defaults to "#". - visible: boolean, optional, whether this menu item is visible. Defaults to true. - linkOptions: array, optional, the HTML attributes of the item's link. - options: array, optional, the HTML attributes of the item container (LI). - active: boolean, optional, whether the item should be on active state or not. - dropDownOptions: array, optional, the HTML options that will passed to the Dropdown widget. - items: array|string, optional, the configuration array for creating a Dropdown widget, or a string representing the dropdown menu. Note that Bootstrap does not support sub-dropdown menus. - encode: boolean, optional, whether the label will be HTML-encoded. If set, supersedes the $encodeLabels option for only this item. If a menu item is a string, it will be rendered directly without HTML encoding.
public $items

$params публичное свойство

the parameters used to determine if a menu item is active or not. If not set, it will use $_GET.
См. также: route
См. также: isItemActive
public $params

$route публичное свойство

the route used to determine if a menu item is active or not. If not set, it will use the route of the current request.
См. также: params
См. также: isItemActive
public $route