Initial jsaction README #55521
Closed
Initial jsaction README #55521
+272
−0
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jatraman
reviewed
Apr 25, 2024
rahatarmanahmed
force-pushed
the
readme
branch
6 times, most recently
from
9d705d2
to
59c58f8
Compare
|
I didn't end up writing a demo server since I'd need to set up some compilation for the jsaction TS files to use them. |
pullapprove
bot
added
the
requires: TGP
thePunderWoman
added
the
target: rc
| registration of event listeners from the JavaScript code for the listeners | ||
| themselves. This enables capturing user interactions before the application is | ||
| bootstrapped or hydrated as well as very fine grained lazy loading of event | ||
| handling code. It is primarily intended to use as part of a larger framework, |
There was a problem hiding this comment.
"It is typically used as a sub-component of a larger framework, rather than as a stand-alone library."
|
|
||
| ## How it works | ||
|
|
||
| The traditional way of adding an event handler is to obtain a reference to the |
There was a problem hiding this comment.
Suggested change
| The traditional way of adding an event handler is to obtain a reference to the | |
| The traditional way of adding an event listener is to obtain a reference to the |
| ## How it works | ||
|
|
||
| The traditional way of adding an event handler is to obtain a reference to the | ||
| node and add the event handler to it via `.addEventListener` (or `.onclick`-like |
There was a problem hiding this comment.
Suggested change
| node and add the event handler to it via `.addEventListener` (or `.onclick`-like | |
| node and call `.addEventListener` (or `.onclick`-like |
| <!-- | ||
| There's a window of time between when the button is rendered and the | ||
| script below reaches the client, either because there's a lot of content | ||
| streamed in-between or network lag. |
There was a problem hiding this comment.
Suggested change
| streamed in-between or network lag. | |
| streamed in-between, network lag, or the script is asynchronously via a follow-up network request rather than as part of the main document content. |
| ``` | ||
|
|
||
| A small inline script is added before any application content which registers | ||
| global event handlers for all event types that the application listens to. Any |
There was a problem hiding this comment.
Suggested change
| global event handlers for all event types that the application listens to. Any | |
| global event handlers for event types that could be delegated. Any |
| ### 4. Register your application with JSAction | ||
|
|
||
| Finally, once your application is bootstrapped and ready to handle events, | ||
| you'll need to create a Dispatcher and register it with the dormant |
There was a problem hiding this comment.
"dormant" feels like the wrong adjective, but I think we don't need a qualifier just say "with the EventContract
tbondwilkinson
approved these changes
Apr 29, 2024
AndrewKushnir
approved these changes
Apr 30, 2024
rahatarmanahmed
added
the
action: merge
|
TESTED=docs only. No TGP needed. |
|
This PR was merged into the repository by commit cda8bfa. |
AndrewKushnir
pushed a commit
that referenced
this pull request
May 1, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR Checklist
Please check if your PR fulfills the following requirements:
PR Type
What kind of change does this PR introduce?
What is the current behavior?
Issue Number: N/A
What is the new behavior?
Does this PR introduce a breaking change?
Other information