Веб-компоненты. Часть 3: html шаблоны и импорты
Вступление
Приветствую коллеги. Данная статья является третьей и последней статьей в серии статей о веб-компонентах.Первые две статьи доступны по ссылкам:
Веб компоненты. Часть 1: Пользовательские элементы
Веб-компоненты. Часть 2: Теневой DOM
В данной статье речь пойдет о элементе, а также об HTML импортах.
HTML Templates элемент
Элемент представляет собой инструмент, позволяющий хранить контент на стороне клиента без его рендеринга на страницу, однако с возможностью его отображения в процессе исполнения посредством JavaScript.
Содержимое элемента при парсинге страницы обрабатывается исключительно в части валидации содержимого, но без его рендеринга (согласно спецификации, при рендеринге этот элемент ничего не представляет). Содержимое элемента можно клонировать и вставлять в документ из скриптов, что и используется как самостоятельно для шаблонизации так и при создании веб-компонентов.
Содержимое
К содержимому , как и к любому узлу, не имеющему браузерного контекста, не применимы никакие требования соответствия, кроме требований к правильности HTML и XML синтаксиса. Это означает, что в содержимом шаблона можно, например, указать элемент img не указав значение атрибутов src и alt, таким образом:
однако, вне элемента такой синтаксис валидным не является. При этом пропуск закрывающего тега
Все элементы указанные внутри тега в html коде не являются его дочерними элементами.
Бразуеры при создании элемента создают DocumentFragment чьим документом является т.н. approptiate template contents owner document, определяемый по этому алгоритму, документа в котором указан и указывает значением свойства .content созданный DocumentFragment.
То есть свойство .content у элемента template содержит DocumentFragment, и элементы, которые в html коде были указаны внутри тегов являются дочерними элементами именно этого DocumentFragment.
При этом элементу , как и любому другому, можно добавить дочерние элементы (appendChild ()), но это будет считаться нарушение модели содержимого шаблона.
Клонирование шаблона
При клонирования содержимого шаблона важно помнить, что первый аргумент в .cloneNode ([deep])
или второй в .importNode (externalNode, deep) передавать обязательно надо (согласно спецификации, если аргумент не будет передан, дальнейшее выполнение происходить не должно).
Кстати, да, не смотря на то что большинство примеров используют именно .cloneNode (), использование .importNode () тоже возможно. Разница только в том, когда документ обновится (для .cloneNode () — после вызова appendChild (); для .importNode () — после клонирования).
Show me the code ©
Использование шаблонов действительно очень простое. Я продолжу пример компоненты таб, с кодом которых я работала в примерах предыдущих статей.
Начинать я буду с того, что создам в html разметке два элемента и перенесу в них ту разметку, что была в методе .render () классов TabNavigationItem и TabContentItem (я также изменила некоторые стили, но на функциональность это не влияет):
и:
В конструкторе каждого класса я сохраню свойство template. Для TabNavigationItem это будет:
this.template = document.getElementById('tab-nav');
a для TabContentItem:
this.template = document.getElementById('tab-content');
В метод render () каждому из этих классов я добавлю следующий код, предварительно удалив запись .innerHTML:
const content = this.template.content.cloneNode(true);
this.shadowRoot.appendChild(content);
Получившийся код можно посмотреть тут
В этом примере оба шаблона указаны в html, что выглядит громозким и не есть гуд. Это плавно переводит нас к теме:
HTML импорты
Импорты представляют собой HTML документы которые подключены в качестве внешних ресурсов другим HTML документом. Система взаимоотношений между документами хорошо описана в черновике спецификации и не является предметом данной статьи.
Общая схема видна на изображении:
.
Для того чтобы реализовать импорты был добавлен новый тип в HTML link types (значения атрибута rel).
Слово import, указанное в значение атрибута rel элемента собственно и создает ссылку к импортируемому ресурсу (дефолтным типом ресурса является text/html).
У элемента может присутствовать атрибут async.
Расширения, предлагаемые черновиком спецификации предлагаются в АПИ HTMLLinkElement: добавляется свойство import, доступное только для чтения и содержащее импортируемый документ.
Свойство может содержать значение null в двух случаях: когда не представляет import или не находится в документе.
В спецификации отдельно указано что один и тот же объект должен будет возвращаться всегда.
В контексте импортов, есть так называемый мастер-документ (master document), которым является тот документ, который импортирует ресурсы одновременно не являясь при этом чьим либо импортируемым ресурсом.
ContentSecurityPolicy такого документа должна ограничивать все импорты. Так, если Content Security Header Field поставлен в значение импорта, бразер должен принудительно исполнять политику именно матер-документа к импортируемому документу.
На практике
Для компонента таб, я создаю папку templates. В ней я создам два файла, в которые я перенесу разметку компоненты.
В
файла index.html я импортирую шаблоны:
Элементам я добавляю id атрибуты, так как мне понадобится обращаться к ним из js.
Теперь в конструкторах классов TabNavigationItem и TabContentItem для получения документа шаблона мне достаточно будет найти соответствующий элемент и обратится к его свойству import, после чего поиск шаблона я буду выполнять уже в импортируемом документе:
class TabNavigationItem extends HTMLElement {
constructor() {
super();
this._target = null;
this.attachShadow({mode: 'open'});
const templateImport = document.getElementById('tab-nav').import;
this.template = templateImport.getElementById('tab-nav');
}
//...
}
class TabContentItem extends HTMLElement {
constructor() {
super();
this._target = null;
this.attachShadow({mode: 'open'});
const templateImport = document.getElementById('tab-content').import;
this.template = templateImport.getElementById('tab-content');
}
//...
}
Финальную версию можно взять тут.
О поддержке
Поддержка HTML templates: Edge c 16, Firefox c 59, Chrome c 49, Safari c 11.
С поддержкой импортов печальнее: Chrome c 49.
Потому примеры из этой статьи можно посмотреть только в последних Chrome.
Существуют полифилы:
Webcomponents
Polymer-projectПочтитать подробнее о шаблонах и импортах:
HTML спецификация
HTML5 спецификация
HTML Imports черновик спецификации
На этом все, спасибо за внимание,
Таня
