Skip to content

Added ref-attribute documentation #813

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
michielvandergeest merged 2 commits into from
Oct 22, 2026
Merged

Added ref-attribute documentation #813

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
00cdd57
Added ref-attribute documentation
jfboeve Oct 21, 2026
b496385
applied changes to docs per comments
jfboeve Oct 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions docs/essentials/element_attributes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -232,6 +232,18 @@ You can also use built-in shader attributes in combination with eachother f.e;
<Element w="200" h="200" x="20" y="100" rounded="20" border="{w: 20, color:'blue'}"/>
```

### Adding a Referance

You can add a reference to an Element or Component by using the `ref` attribute.

```xml
<Element w="200" h="200" x="20" y="100" ref="myElement" />

<MyComponent ref="MyComponent">
```

With a `ref` setup you can use it the `$select` method inside the same Component where the Element is referenced in its template. For more information follow view [Utility Methods](../components/utility_methods.md#select) or for similar but more advanced built-in features view [Directives](../built-in/directives.md)

### Using shader attribute
> [!WARNING]
> This attribute does not work in combination with the built-in element shader attributes. This has to do with the complexity of shaders that makes mixing and matching quite heavy on performance.
Expand Down
Loading