Класс yii\widgets\Breadcrumbs

Breadcrumbs отображает список ссылок, указывающих на положение текущей страницы в иерархии всего сайта.

Например, хлебные крошки, такие как "Главная / Статья / Редактировать", означают, что пользователь просматривает страницу редактирования статьи "Статья". Он может нажать на "Статья", чтобы перейти на эту страницу, или нажать на "Главная", чтобы вернуться на главную страницу.

Для использования Breadcrumbs необходимо настроить свойство $links, которое указывает на отображаемые ссылки. Например,

// $this is the view object currently being used
echo Breadcrumbs::widget([
    'itemTemplate' => "<li><i>{link}</i></li>\n", // template for all links
    'links' => [
        [
            'label' => 'Post Category',
            'url' => ['post-category/view', 'id' => 10],
            'template' => "<li><b>{link}</b></li>\n", // template for this link only
        ],
        ['label' => 'Sample Post', 'url' => ['post/edit', 'id' => 1]],
        'Edit',
    ],
]);

Поскольку хлебные крошки обычно отображаются на почти каждой странице сайта, вы можете поместить их в макет представления. Вы можете использовать параметр представления (например, $this->params['breadcrumbs']) для настройки ссылок в разных представлениях. В представлении макета вы можете присвоить этот параметр представления свойству $links следующим образом:

// $this is the view object currently being used
echo Breadcrumbs::widget([
    'links' => isset($this->params['breadcrumbs']) ? $this->params['breadcrumbs'] : [],
]);

Публичные свойства

Публичные методы

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

События

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

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

Шаблон, используемый для рендеринга каждого активного элемента в хлебных ссылках. Токен {link} будет заменён фактической HTML-ссылкой для каждого активного элемента.

public string $activeItemTemplate = "<li class=\"active\">{link}</li>\n"

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

Нужно ли кодировать метки ссылок в HTML.

public boolean $encodeLabels = true

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

Первая гиперссылка в хлебных ссылках (называемая домашней ссылкой). Обратитесь к $links для формата ссылки. Если это свойство не задано, по умолчанию это ссылка, ведущая на yii\web\Application::$homeUrl с меткой «Главная». Если это свойство равно false, домашняя ссылка не будет отображаться.

public array $homeLink = null

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

Шаблон, используемый для рендеринга каждого неактивного элемента в хлебных ссылках. Токен {link} будет заменён фактической HTML-ссылкой для каждого неактивного элемента.

public string $itemTemplate = "<li>{link}</li>\n"

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

Список ссылок, которые должны отображаться в хлебных ссылках. Если это свойство пустое, виджет ничего не отобразит. Каждый элемент массива представляет собой отдельную ссылку в хлебных ссылках со следующей структурой:

[
    'label' => 'label of the link',  // required
    'url' => 'url of the link',      // optional, will be processed by Url::to()
    'template' => 'own template of the item', // optional, if not set $this->itemTemplate will be used
]

Если ссылка активна, вам нужно указать только «label», и вместо написания ['label' => $label], вы можете просто использовать $label.

С версии 2.0.1 любые дополнительные элементы массива для каждого ссылки будут обрабатываться как атрибуты тега гиперссылки. Например, следующее описание ссылки сгенерирует гиперссылку с CSS классом external:

[
    'label' => 'demo',
    'url' => 'http://example.com',
    'class' => 'external',
]

С версии 2.0.3 каждая отдельная ссылка может переопределить глобальный параметр $encodeLabels следующим образом:

[
    'label' => '<strong>Hello!</strong>',
    'encode' => false,
]

public array $links = []

$options общественное свойство

Атрибуты HTML для тега контейнера хлебных крошек.

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

public array $options = ['class' => 'breadcrumb']

$tag общественное свойство

Имя тега контейнера хлебных крошек.

public string $tag = 'ul'

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