[lit-labs/ssr-dom-shim] shim Element.prototype.toggleAttribute method #4493
Conversation
This file contains hidden or 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
🦋 Changeset detectedLatest commit: c88c1f5 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Contributor
📊 Tachometer Benchmark ResultsSummarynop-update
render
update
update-reflect
Resultsthis-change
render
update
update-reflect
this-change, tip-of-tree, previous-release
render
update
nop-update
this-change, tip-of-tree, previous-release
render
update
this-change, tip-of-tree, previous-release
render
update
update-reflect
|
Contributor
|
The size of lit-html.js and lit-core.min.js are as expected. |
rictic
approved these changes
Jan 12, 2024
justinfagnani
requested changes
Jan 12, 2024
Comment on lines
+65
to
+73
| if (force === undefined) { | ||
| force = !this.hasAttribute(name); | ||
| } | ||
| if (force) { | ||
| this.setAttribute(name, ''); | ||
| } else { | ||
| this.removeAttribute(name); | ||
| } | ||
| return force; |
Collaborator
There was a problem hiding this comment.
This isn't quite correct, since if an attribute is already set and force is true the attribute should be left unmodified: https://dom.spec.whatwg.org/#dom-element-toggleattribute This code sets it to ''.
I think this should work, but it needs a test for that case:
Suggested change
| if (force === undefined) { | |
| force = !this.hasAttribute(name); | |
| } | |
| if (force) { | |
| this.setAttribute(name, ''); | |
| } else { | |
| this.removeAttribute(name); | |
| } | |
| return force; | |
| if (this.hasAttribute(name) { | |
| // Step 5 | |
| if (force === undefined || !force) { | |
| this.removeAttribute(name); | |
| return false; | |
| } | |
| } else { | |
| // Step 4 | |
| if (force === undefined || force) { | |
| // Step 4.1 | |
| this.setAttribute(name, ''); | |
| return true; | |
| } else { | |
| // Step 4.2 | |
| return false; | |
| } | |
| } | |
| // Step 6 | |
| return true; |
I think this handles boolean conversion correctly. ie, undefined is the real missing value and null treated as falsey.
Contributor
Author
There was a problem hiding this comment.
Exceptional catch! Thank you! Fixed in #4494
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
Fixes: #4468
This adds
Element.prototype.toggleAttribute(name, force?)to the SSR ElementShim.Test plan
Unit tested in the node environment using
uvu. Note, the package originally didn't have unit tests, so I've also set up a newtestrule.Assumptions about casing
Documenting this as I was going to implement lower-casing of attribute names until I spoke with Augustine.
Ignoring casing is by design in the shim because these shimmed APIs can be used on SVG elements where casing is preserved. I believe the justification is we preserve casing during SSR, and then the browser will lowercase the attributes if in the HTML namespace. E.g. if we SSR
<div cLaSs="example">, it'll be parsed into<div class="example">. But<svg viewBox=...>will be preserved as<svg viewBox=...>.