uce/site/doc/pages/component.txt
2026-04-28 12:10:07 +00:00

43 lines
1.5 KiB
Plaintext

:sig
String component(String name, [DTree props], [Request& context])
:see
>ob
:content
Renders another `.uce` file as a component and returns the captured output as a `String`.
`component()` resolves the target file relative to the current page and also tries the `components/` prefix automatically, mirroring the shorthand used by the starter example project.
Component props are passed in `context.props`.
Because `<?= ... ?>` HTML-escapes its value, embed component markup with `<?: component(...) ?>`, `print(component(...))`, or use `component_render(...)` for direct output.
## Named Components
When `name` contains a colon, such as `components/card:BODY`, the part after the colon selects a named component handler exported from the component file through `COMPONENT:BODY(Request& context)`.
The default handler is `COMPONENT(Request& context)`.
When `name` starts with a colon, such as `:BODY`, the target resolves against the current `.uce` file so component files can call their own named handlers without repeating the file name.
## Resolution Order
- exact file name
- exact file name with `.uce`
- the same two forms under `components/`
## Example
```cpp
DTree props;
props["title"] = "Status";
<><?: component("workspace/panel", props, context) ?></>
```
## Related Concepts
- PHP: reusable template partials or helper-rendered view fragments returned as strings
- JavaScript / Node.js: component render helpers, especially patterns that return markup as a string