Annotation Interface JsModule
Component
class. For adding multiple JavaScript Module files for a single component,
you can use this annotation multiple times.
The JavaScript module files should be located:
- inside
frontend
directory in your root project folder in case of WAR project - inside
META-INF/resources/frontend
directory (inside a project resources folder) in case of JAR project (if you are using Maven this issrc/main/resources/META-INF/resources/frontend
directory).
It is guaranteed that dependencies will be loaded only once. The files loaded
will be in the same order as the annotations were on the class. However,
loading order is only guaranteed on a class level; Annotations from different
classes may appear in different order, grouped by the annotated class. Also,
files identified by @JsModule
will be loaded before
JavaScript
and
CssImport
.
NOTE: Currently all frontend resources are bundled together into one big
bundle. This means, that JavaScript files loaded by one class will be present
on a view constructed by another class. For example, if there are two classes
RootRoute
annotated with @Route("")
, and another class
RouteA
annotated with @Route("route-a")
and
@JsModule("./src/jsmodule.js")
, the jsmodule.js
will be run
on the root route as well.
- Since:
- 2.0
- Author:
- Vaadin Ltd
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic @interface
Internal annotation to enable use of multipleJsModule
annotations. -
Required Element Summary
-
Element Details
-
value
String valueJavaScript module to load before using the annotatedComponent
in the browser.NOTE: In the case of using JsModule with LitTemplate, the value needs to point to a real file as it will be copied to the templates folder under target folder. An exported alias from the package will not work.
- Returns:
- a JavaScript module identifier
-