---
metadata:
  - name: generator
    content: Diplodoc Platform v5.39.1
alternate:
  - https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/examples/cases/list_box_layout.md
  - https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/examples/cases/list_box_layout.md
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/llms.txt

# Произвольный макет выпадающего списка

<iframe id="LIVE-EXAMPLE" style="width:100%;height: 400px;border-radius: 8px;border: 1px solid rgba(92, 94, 102, 0.14);" frameBorder="0" src="https://yastatic.net/s3/front-maps-static/maps-front-jsapi-v2-1/examples/2/out/s3-cases/ru/list_box_layout/index.html" allow="fullscreen"></iframe>

<a target="_blank" rel="noopener noreferrer" style="display: inline-block;margin-top: 10px;cursor: pointer;border-radius: 4px;padding: 9px 12px;background: #151515;color: white;text-decoration: none;font-weight: 500" href="https://codesandbox.io/p/sandbox/4xqv4v?file=index.html">Open in CodeSandbox</a>

<div id="references">
    <a href="https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ready">ready</a>, <a href="https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Map">Map</a>,
    <a href="https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/control.ListBox">control.ListBox</a>, <a href="https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/templateLayoutFactory">templateLayoutFactory</a>,
    <a href="https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/control.ListBoxItem">control.ListBoxItem</a>
</div>
<p>
    <a href="https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/dg/concepts/layouts">Макеты</a> объектов можно
    создавать с помощью фабрики <a href="https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/templateLayoutFactory">templateLayoutFactory</a>,
    используя текстовые шаблоны.
</p>
<p>
    В данном примере создается пользовательский макет
    <a href="https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/control.ListBox">выпадающего списка</a>.
    Макет элемента управления строится на основе его данных, состояния и опций.
    Макет автоматически перестраивается при изменении значений полей,
    состояния или опций, которые используются в его текстовом шаблоне.
</p>
<p>
    Выпадающий список по умолчанию реагирует на клик по своему макету и меняет
    значение поля state.get('expanded').
</p>
<p>
    События макета, на которые реагирует выпадающий список, описаны в интерфейсах
    <a href="https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IExpandableControlLayout">IExpandableControlLayout</a> и <a href="https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IGroupControlLayout">IGroupControlLayout</a>.
</p>
<p>
    Выпадающий список является групповым элементом управления, поэтому его макет
    должен генерировать события и реализовывать методы, описанные в <a href="https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IGroupControlLayout">IGroupControlLayout</a>.
</p>
<p>
    Через опции можно задавать настройки как самого выпадающего списка, так и настройки
    для его дочерних элементов. Для этого опции дочерних элементов нужно указывать
    с префиксом 'item'.
</p>

{% list tabs %}

-   index.html

    ```html
    <!DOCTYPE html>

    <html>
        <head>
            <title>Произвольный макет выпадающего списка</title>
            <meta
                http-equiv="Content-Type"
                content="text/html; charset=utf-8"
            />
            <!--
            Укажите свой API-ключ. Тестовый ключ НЕ БУДЕТ работать на других сайтах.
            Получить ключ можно в Кабинете разработчика: https://developer.tech.yandex.ru/keys/
        -->
            
            
            
            <link
                href="https://yandex.st/bootstrap/2.2.2/css/bootstrap.min.css"
                rel="stylesheet"
            />
            
        </head>

        <body>
            <div id="map"></div>
        </body>
    </html>
    ```

-   list_box_layout.js

    ```js
    ymaps.ready(init);

    function init() {
        var myMap = new ymaps.Map("map", {
                center: [55.751574, 37.573856],
                zoom: 9,
                controls: [],
            }),
            // Создадим собственный макет выпадающего списка.
            ListBoxLayout = ymaps.templateLayoutFactory.createClass(
                "<button id='my-listbox-header' class='btn btn-success dropdown-toggle' data-toggle='dropdown'>" +
                    "{{data.title}} <span class='caret'></span>" +
                    "</button>" +
                    // Этот элемент будет служить контейнером для элементов списка.
                    // В зависимости от того, свернут или развернут список, этот контейнер будет
                    // скрываться или показываться вместе с дочерними элементами.
                    "<ul id='my-listbox'" +
                    " class='dropdown-menu' role='menu' aria-labelledby='dropdownMenu'" +
                    " style='display: {% if state.expanded %}block{% else %}none{% endif %};'></ul>",
                {
                    build: function () {
                        // Вызываем метод build родительского класса перед выполнением
                        // дополнительных действий.
                        ListBoxLayout.superclass.build.call(this);

                        this.childContainerElement = $("#my-listbox").get(0);
                        // Генерируем специальное событие, оповещающее элемент управления
                        // о смене контейнера дочерних элементов.
                        this.events.fire("childcontainerchange", {
                            newChildContainerElement:
                                this.childContainerElement,
                            oldChildContainerElement: null,
                        });
                    },

                    // Переопределяем интерфейсный метод, возвращающий ссылку на
                    // контейнер дочерних элементов.
                    getChildContainerElement: function () {
                        return this.childContainerElement;
                    },

                    clear: function () {
                        // Заставим элемент управления перед очисткой макета
                        // откреплять дочерние элементы от родительского.
                        // Это защитит нас от неожиданных ошибок,
                        // связанных с уничтожением dom-элементов в ранних версиях ie.
                        this.events.fire("childcontainerchange", {
                            newChildContainerElement: null,
                            oldChildContainerElement:
                                this.childContainerElement,
                        });
                        this.childContainerElement = null;
                        // Вызываем метод clear родительского класса после выполнения
                        // дополнительных действий.
                        ListBoxLayout.superclass.clear.call(this);
                    },
                }
            ),
            // Также создадим макет для отдельного элемента списка.
            ListBoxItemLayout = ymaps.templateLayoutFactory.createClass(
                "<li><a>{{data.content}}</a></li>"
            ),
            // Создадим 2 пункта выпадающего списка
            listBoxItems = [
                new ymaps.control.ListBoxItem({
                    data: {
                        content: "Москва",
                        center: [55.751574, 37.573856],
                        zoom: 9,
                    },
                }),
                new ymaps.control.ListBoxItem({
                    data: {
                        content: "Омск",
                        center: [54.990215, 73.365535],
                        zoom: 9,
                    },
                }),
            ],
            // Теперь создадим список, содержащий 2 пункта.
            listBox = new ymaps.control.ListBox({
                items: listBoxItems,
                data: {
                    title: "Выберите пункт",
                },
                options: {
                    // С помощью опций можно задать как макет непосредственно для списка,
                    layout: ListBoxLayout,
                    // так и макет для дочерних элементов списка. Для задания опций дочерних
                    // элементов через родительский элемент необходимо добавлять префикс
                    // 'item' к названиям опций.
                    itemLayout: ListBoxItemLayout,
                },
            });

        listBox.events.add("click", function (e) {
            // Получаем ссылку на объект, по которому кликнули.
            // События элементов списка пропагируются
            // и их можно слушать на родительском элементе.
            var item = e.get("target");
            // Клик на заголовке выпадающего списка обрабатывать не надо.
            if (item != listBox) {
                myMap.setCenter(item.data.get("center"), item.data.get("zoom"));
            }
        });

        myMap.controls.add(listBox, { float: "left" });
    }
    ```

{% endlist %}
