Importing Assets
资产注释提供了一种声明性的方法,以静态方式在应用程序中嵌入外部和内联资源,如JavaScript和CSS。这些注释通过确保依赖项在适当的执行阶段加载,简化了资源管理,减少了手动配置,增强了可维护性。
导入 JavaScript 文件
支持声明性 JavaScript 包含,通过@JavaScript注释,启用自动依赖项加载。该注释可以在组件级别和应用程序级别应用。
@JavaScript("ws://js/app.js")
@JavaScript("https://cdn.example.com/library.js")
该注释接受要在应用程序中加载的相对路径或完整路径。这将作为<script>标签插入到DOM中。此外,注释支持以下属性:
| 属性 | 类型 | 描述 | 默认值 |
|---|---|---|---|
top | Boolean | 指定脚本是否应插入到顶级窗口 | false |
attributes | Object | 要应用于脚本的一组属性。 | {} |
示例:
@JavaScript(value = "ws://my-component.js",
attributes = {@Attribute(name = "type", value = "module")})
文件仅在声明注释的组件附加到容器时加载。如果多个组件加载同一文件,则文件仅插入一次。
注入 JavaScript
在某些情况下,您可能希望直接将JavaScript代码注入到DOM中,而不是提供JavaScript路径。InlineJavaScript注释允许您注入JavaScript内容。
@InlineJavaScript("alert('我是一段内联脚本!');")
@JavaScript("context://js/app.js")
| 属性 | 类型 | 描述 | 默认值 |
|---|---|---|---|
top | Boolean | 指定脚本是否应插入到顶级窗口 | false |
attributes | Object | 要应用于脚本的属性 | {} |
id | String | 用于确保单次注入的唯一资源ID | "" |
可以使用InlineJavaScript多次注入脚本,除非使用id属性分配特定ID。
导入 CSS 文件
支持声明性 CSS 包含,通过@StyleSheet注释,启用自动依赖项加载。该注释可以在组件级别和应用程序级别应用。
@StyleSheet("ws://css/app.css")
@StyleSheet("https://cdn.example.com/library.css")
| 属性 | 类型 | 描述 | 默认值 |
|---|---|---|---|
top | Boolean | 指定样式表是否应插入到顶级窗口 | false |
attributes | Object | 要应用于样式表的属性 | {} |
示例:
@StyleSheet(value = "ws://my-component.css",
attributes = {@Attribute(name = "media", value = "screen")})
文件仅在声明注释的组件附加到容器时加载。每个文件仅加载一次。
注入 CSS
InlineStyleSheet注释允许您在组件级别和应用程序级别直接将CSS内容注入到网页中。
@InlineStyleSheet("body { background-color: lightblue; }")
@InlineStyleSheet(value = "h1 { color: red; }", id = "headingStyles", once = true)
| 属性 | 类型 | 描述 | 默认值 |
|---|---|---|---|
top | Boolean | 指定样式表是否应注入到页面的顶级窗口。 | false |
attributes | Object | 一组属性,应用于样式元素。 | {} |
id | String | 唯一的资源ID。如果多个资源具有相同的ID,则会将它们打包在一个样式元素中。 | "" |
once | Boolean | 确定样式表是否应仅注入到页面一次,无论多个组件实例如何。 | true |
为了在为组件编写内联CSS时获得更好的语法高亮,您可以使用webforJ VS Code扩展: Java HTML CSS 语法高亮。
运行时动态资产
通过在运行时的程序性注入JavaScript和CSS,可以实现动态资源管理。您可以根据运行时上下文加载或注入资源。
加载和注入 JavaScript
使用Page API动态加载或注入 JavaScript。这样,您可以从URL加载脚本或将内联脚本直接注入到DOM中。
Page page = Page.getCurrent();
// 加载 JavaScript 文件
page.addJavaScript("ws://js/app.js");
page.addJavaScript("https://cdn.example.com/library.js");
// 注入内联 JavaScript
page.addInlineJavaScript("console.log('运行时注入');");
page.addInlineJavaScript("alert('此脚本作为内联运行');");
| 参数 | 描述 |
|---|---|
script | 要注入的URL或内联脚本内容。以context://开头的URL解析为应用程序的根资源文件夹。 |
top | 确定脚本是否应注入到页面的顶部。 |
attributes | 要为脚本设置的属性映射。 |
加载和注入 CSS
使用Page API动态加载或注入CSS。这样,您可以从URL加载样式表或将内联样式直接注入到DOM中。
Page page = Page.getCurrent();
// 加载 CSS 文件
page.addStyleSheet("ws://css/app.css");
page.addStyleSheet("https://cdn.example.com/library.css");
// 注入内联 CSS
page.addInlineStyleSheet("body { background-color: lightblue; }");
page.addInlineStyleSheet("h1 { font-size: 24px; color: navy; }");
| 参数 | 描述 |
|---|---|
stylesheet | 要注入的URL或内联样式表内容。以context://开头的URL解析为应用程序的根资源文件夹。 |
top | 确定样式表是否应注入到页面的顶部。 |
attributes | 要为样式表设置的属性映射。 |