Add documentation explaining some architectural concepts #7033
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
radium-v
requested changes
Oct 30, 2024
Comment on lines
49
to
53
| During the `ViewTemplate.create` step, the following happens for each string: | ||
| - Factories with unique IDs are created for each tag template literal argument (or `TemplateValue`) which matches with the corresponding string | ||
| - A binding is created from the `TemplateValue` | ||
|
|
||
| A resulting string using `createHTML` function is created using the `HTMLDirective`, the previous string from the `html` tag template which determines the aspect if one exists, these aspects are the `@`, `:`, or other binding aspect attached to attributes. The `createHTML` returns a `Markup` attribute using the factory that has a unique ID. This is all concatenated as a string and passed to a new `ViewTemplate` with all the factories (empty until one is assigned) that act as a dictionary with the unique IDs as the key to look up each factory once it has been created. |
There was a problem hiding this comment.
This section could use some rework.
There was a problem hiding this comment.
Rewrote this for hopefully more clarity, let me know if that makes sense!
Co-authored-by: John Kreitlow <863023+radium-v@users.noreply.github.com>
Co-authored-by: John Kreitlow <863023+radium-v@users.noreply.github.com>
Co-authored-by: John Kreitlow <863023+radium-v@users.noreply.github.com>
Co-authored-by: John Kreitlow <863023+radium-v@users.noreply.github.com>
…ial explaination of FASTElement
Co-authored-by: John Kreitlow <863023+radium-v@users.noreply.github.com>
Co-authored-by: John Kreitlow <863023+radium-v@users.noreply.github.com>
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.
Pull Request
📖 Description
This PR adds documentation on the internals of
FASTElementand it's lifecycle events. This is meant to serve as a general overview for contributors looking to understand the architecture of FAST custom elements.✅ Checklist
General
$ npm run change