Skip to content

Commit cf7038a

Browse files
committed
Resource registry: Document the * depends value.
1 parent 76359f2 commit cf7038a

File tree

1 file changed

+23
-19
lines changed

1 file changed

+23
-19
lines changed

docs/classic-ui/static-resources.md

Lines changed: 23 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,6 @@ If you were to hard-code these resources in templates with `<link>` or `<script>
2222
For some additional implementation information, see {doc}`theming/create-add-on`.
2323
```
2424

25-
2625
(classic-ui-static-resources-registering-label)=
2726

2827
## Registering JavaScript and CSS
@@ -71,37 +70,37 @@ You can also register both a JavaScript file and a CSS file in the same bundle.
7170
</registry>
7271
```
7372

74-
7573
(classic-ui-static-resources-available-attributeslabel)=
7674

7775
## Available attributes
7876

7977
The following attributes are available for registering a static resource.
8078

8179
`enabled`
82-
: Boolean.
83-
Whether the bundle is enabled or not.
84-
If it is disabled, the bundle will not be loaded.
80+
: Boolean.
81+
Whether the bundle is enabled or not.
82+
If it is disabled, the bundle will not be loaded.
8583

8684
`jscompilation`
87-
: String.
88-
The path to the compiled JavaScript file.
85+
: String.
86+
The path to the compiled JavaScript file.
8987

9088
`csscompilation`
91-
: String.
92-
The path to the compiled CSS file.
89+
: String.
90+
The path to the compiled CSS file.
9391

9492
`depends`
95-
: String.
96-
A comma-separated list of bundles that this bundle depends on.
97-
For a single dependency, do not insert commas.
93+
: String.
94+
A comma-separated list of bundles that this bundle depends on.
95+
For a single dependency, do not insert commas.
9896

9997
When a bundle depends on another one, its `<script>` or `<link>` tag is rendered after the bundle it depends on.
10098

10199
If the bundle's dependencies do not exist, then the bundle will not render.
102100

103101
The `depends` attribute may be assigned the value of `all`, making this bundle render last, after all other bundles.
104102
The `all` value lets you load CSS files after the automatically added theme resources and override CSS declarations from your own custom CSS files.
103+
`*` is an alias for `all`, so you can also use that.
105104

106105
If you set multiple bundles to `all`, then these bundles will render in alphabetical order by its name.
107106

@@ -115,13 +114,18 @@ The following attributes are available for registering a static resource.
115114
`depends` value of `all`.
116115
```
117116

117+
```{versionadded} Plone 6.2.0a2
118+
`depends` value of `*`.
119+
Note: The `*` value was present in Plone < 6.
120+
```
121+
118122
`load_async`
119-
: Boolean.
120-
Whether the bundle should be loaded asynchronously or not.
121-
*Only JavaScript*
123+
: Boolean.
124+
Whether the bundle should be loaded asynchronously or not.
125+
_Only JavaScript_
122126

123127
`load_defer`
124-
: Boolean.
125-
Whether the bundle should be loaded deferred or not.
126-
If you use `load_async`, this attribute has no effect.
127-
*Only JavaScript*
128+
: Boolean.
129+
Whether the bundle should be loaded deferred or not.
130+
If you use `load_async`, this attribute has no effect.
131+
_Only JavaScript_

0 commit comments

Comments
 (0)