com.vaadin.annotations.HtmlImport Maven / Gradle / Ivy
/*
* Copyright (C) 2000-2024 Vaadin Ltd
*
* This program is available under Vaadin Commercial License and Service Terms.
*
* See for the full
* license.
*/
package com.vaadin.annotations;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Repeatable;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import com.vaadin.server.ClientConnector;
/**
* If this annotation is present on a {@link ClientConnector} class, the
* framework ensures the referenced HTML imports are loaded before the init
* method for the corresponding client-side connector is invoked.
*
*
* Note that not all browsers yet support HTML imports. If a polyfill is needed
* to load HTML imports, it must be loaded before HTML Imports can be loaded.
* There is no automatic loading of any polyfill.
*
*
*
* - Relative URLs are mapped to APP/PUBLISHED/[url] which are by default
* served from the classpath relative to the class where the annotation is
* defined.
*
- Absolute URLs including protocol and host are used as is on the
* client-side.
*
*
*
* Note that you should (almost) always use URLs starting with
* {@literal frontend://} so that the framework can resolve the files to either
* {@literal VAADIN/frontend/es5} or {@literal VAADIN/frontend/es6} depending on
* if the browser supports ES6 classes (most browers) or not (IE11 and Safari
* <= 9). Polymer elements rely on importing dependencies using relative paths
* {@literal ../../other-element/other-element.html}, which will not work if
* they are installed in different locations.
*
*
*
* HTML imports are added to the page after any {@code @JavaScript} dependencies
* added at the same time.
*
*
*
* Example:
* @HtmlImport("frontend://paper-slider/paper-slider.html") on the
* class com.example.MyConnector would load the file
* {@literal http://host.com/VAADIN/frontend/es[56]/paper-slider/paper-slider.html}
* before the {@code init()} method of the client side connector is invoked.
*
*
* @author Vaadin Ltd
* @since 8.0
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Documented
@Repeatable(InternalContainerAnnotationForHtml.class)
public @interface HtmlImport {
/**
* HTML file URL(s) to load before using the annotated
* {@link ClientConnector} in the browser.
*
* @return html file URL(s) to load
*/
String[] value();
}