Skip to content

Update WebC doc #2362

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

Open
d3v1an7 wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update WebC doc #2362

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d69afb1
update WebC doc
d3v1an7 Sep 8, 2026
1f98ac1
Update src/docs/languages/webc.md
d3v1an7 Sep 8, 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
19 changes: 14 additions & 5 deletions src/_includes/webc-attribute-guide.njk
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
{% callout "info", "md-block", "Comparing WebC Attribute Data Types" -%}
1. [Attributes](#attributes-and-webcroot): HTML attribute strings.
1. [Properties](#props-(properties)): server-only private HTML attribute strings (not rendered to output).
1. [Dynamic Attributes and Properties](#dynamic-attributes-and-properties): evaluate as JavaScript (any data type, not just strings).
{% endcallout %}
#### Which one to use

Attributes and props pass values into a component and are available inside it as variables by name (camelCased). Slots pass child markup. They differ in how the value is evaluated and whether it reaches the output HTML.

| Syntax | Value | In output | Use when |
| ------------------------------------------------------- | -------------------- | --------- | ------------------------------------------------------------------------------------- |
| [Attribute](#attributes-and-webcroot) | String | Yes\* | The value belongs on an element in the output, such as `id`, `class`, or `data-*`. |
| [Prop](#props-properties) | String | No | The component needs the value but it should not appear in the HTML. |
| [Dynamic attribute](#dynamic-attributes-and-properties) | Any JavaScript value | Yes\* | The attribute value comes from page data or an expression. |
| [Dynamic prop](#dynamic-attributes-and-properties) | Any JavaScript value | No | Pass page data or a non-string value (number, object, array) into the component. |
| [Slot](#slots) | HTML | Yes\*\* | The page supplies markup, not just a value, or the component wraps arbitrary content. |

\* Rendered when the host tag is kept in the output, or when the component places them with [`webc:root`](#attributes-and-webcroot) or [`@attributes`](#attributes).<br>
\*\* Rendered where the component places its `<slot>`.
Loading