Add component docs #181
Merged
Add component docs #181
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
Signed-off-by: macdonst <[email protected]>
|
|
||
| </doc-code> | ||
|
|
||
| Once added the `MorphdomMixin` will handle updating the DOM whenever an `observedAttributes` is modified. The `<attribute name>Changed` methods are no longer necessary. Instead on an attribute change the `render` method will be re-run and the output will be compared against the current DOM. Only the modified DOM nodes will be updated. |
There was a problem hiding this comment.
I will work on a Morphdom doc that should be linked to here in a callout.
There was a problem hiding this comment.
We could optionally make a mention about how Morphdom does a String based diff on an the actual HTML element and not a virtual DOM diff so every element you want diffed needs to have a string change or unique id.
There was a problem hiding this comment.
Do you think I should put that in the callout below or part of the paragraph?
There was a problem hiding this comment.
Wouldn't hurt to put it something in the paragraph as well
kristoferjoseph
requested changes
Nov 16, 2023
|
|
||
| ### Lists | ||
|
|
||
| When working with lists of data in the DOM it is highly advisable to add a unique attribute to the list item like an `id` or `key`. This will assist `morphdom` in determining what items have changed in the list. |
There was a problem hiding this comment.
See above comment. It may help to call out string based diff vs vdom diffing in this callout.
colepeters
reviewed
Nov 16, 2023
colepeters
reviewed
Nov 16, 2023
colepeters
reviewed
Nov 16, 2023
colepeters
reviewed
Nov 16, 2023
Signed-off-by: macdonst <[email protected]>
|
@kristoferjoseph new changes pushed. |
kristoferjoseph
approved these changes
Nov 17, 2023
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.
Adds component docs to enhance.dev.
I left
docs/conventions/browserunchanged but I can update that file as well if it makes sense.