Skip to content

Docs: surface required delimiters for Targets' and Actions' syntax patterns #320

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
keithamus merged 2 commits into from
Jun 29, 2024
Merged

Docs: surface required delimiters for Targets' and Actions' syntax patterns #320

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
865a15c
docs: specify period as a delimiter
francisfuzz Jun 28, 2024
43a6b7f
docs: detail delimiters for actions
francisfuzz Jun 28, 2024
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
2 changes: 2 additions & 0 deletions docs/_guide/actions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,9 @@ class HelloWorldElement extends HTMLElement {
The actions syntax follows a pattern of `event:controller#method`.

- `event` must be the name of a [_DOM Event_](https://developer.mozilla.org/en-US/docs/Web/Events), e.g. `click`.
- `:` is the required delimiter between the `event` and `controller`.
- `controller` must be the name of a controller ascendant to the element.
- `#` is the required delimieter between the `controller` and `method`.
- `method` (optional) must be a _public_ _method_ attached to a controller's prototype. Static methods will not work.

If method is not supplied, it will default to `handleEvent`.
Expand Down
1 change: 1 addition & 0 deletions docs/_guide/targets.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ class HelloWorldElement extends HTMLElement {
The target syntax follows a pattern of `controller.target`.

- `controller` must be the name of a controller ascendant to the element.
- `.` is the required delimiter between `controller` and `target`.
- `target` must be the name matching that of a `@target` (or `@targets`) annotated field within the Controller code.

### Multiple Targets
Expand Down