Skip to content

Commit d461dc6

Browse files
Fix HTML web component usage example in Readme (#104) (#105)
1 parent 78f812b commit d461dc6

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -70,21 +70,21 @@ To use the components in HTML (as so-called 'Web Components'), simply include th
7070
<script src="https://cdn.jsdelivr.net/npm/@openeo/vue-components@2/assets/openeo.min.js"></script>
7171
```
7272

73-
All components can be used as HTML tags in kebab-case. Also, ALL parameters must be converted to kebab-case!
74-
For example, the component [`BillingPlans`](#billingplans) can be used as `<billing-plans></billing-plans>`.
73+
All components can be used as HTML tags in kebab-case, prefixed with `openeo-`. Also, ALL parameters must be converted to kebab-case too!
74+
For example, the component [`BillingPlans`](#billingplans) can be used as `<openeo-billing-plans></openeo-billing-plans>`.
7575
Props can be passed as HTML attributes if the value is a scalar.
7676
For arrays and objects, you have to specify them as child `script` tags with the attributes `prop="..."` and `type="application/json"`.
7777

7878
For example, the [`Capabilities`](#capabilities) component can be used as follows:
7979
```html
80-
<capabilities url="https://example.com/api">
80+
<openeo-capabilities url="https://example.com/api">
8181
<script prop="capabilities" type="application/json">
8282
{
8383
"api_version": "1.0.0",
8484
...
8585
}
8686
</script>
87-
</capabilities>
87+
</openeo-capabilities>
8888
```
8989

9090
The components are async web components, which means only the components you are actually using are requested. This keeps page loading times at a minimum.

0 commit comments

Comments
 (0)