Skip to content
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

updateStyle(): use setProperty() when css vars and dashed-properties, fixes #2989 #2991

Merged
merged 3 commits into from
Nov 18, 2024
Merged

updateStyle(): use setProperty() when css vars and dashed-properties, fixes #2989 #2991

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
abcbacc
updateStyle(): use setProperty() when css vars and dashed-properties,…
kfule Nov 15, 2024
afb2107
add a test spying on a style setter
kfule Nov 16, 2024
b4af2f6
change domMock setProperty/removeProperty to writable and simplify wr…
kfule Nov 18, 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
6 changes: 3 additions & 3 deletions render/render.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -794,7 +794,7 @@ module.exports = function() {
for (var key in style) {
var value = style[key]
if (value != null) {
if (key[0] === "-" && key[1] === "-") element.style.setProperty(key, String(value))
if (key.includes("-")) element.style.setProperty(key, String(value))
else element.style[key] = String(value)
}
}
Expand All @@ -804,14 +804,14 @@ module.exports = function() {
for (var key in style) {
var value = style[key]
if (value != null && (value = String(value)) !== String(old[key])) {
if (key[0] === "-" && key[1] === "-") element.style.setProperty(key, value)
if (key.includes("-")) element.style.setProperty(key, value)
else element.style[key] = value
}
}
// Remove style properties that no longer exist
for (var key in old) {
if (old[key] != null && style[key] == null) {
if (key[0] === "-" && key[1] === "-") element.style.removeProperty(key)
if (key.includes("-")) element.style.removeProperty(key)
else element.style[key] = ""
}
}
Expand Down
69 changes: 69 additions & 0 deletions render/tests/test-updateElement.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -257,6 +257,75 @@ o.spec("updateElement", function() {

}
})
o("use style property setter only when cameCase keys", function() {
var spySetProperty = o.spy()
var spyRemoveProperty = o.spy()
var spyDashed1 = o.spy()
var spyDashed2 = o.spy()
var spyDashed3 = o.spy()
var spyCamelCase1 = o.spy()
var spyCamelCase2 = o.spy()

render(root, m("a"))
var el = root.firstChild

el.style.setProperty = spySetProperty
el.style.removeProperty = spyRemoveProperty
Object.defineProperties(el.style, {
/* eslint-disable accessor-pairs */
"background-color": {set: spyDashed1},
"-webkit-border-radius": {set: spyDashed2},
"--foo": {set: spyDashed3},
backgroundColor: {set: spyCamelCase1},
color: {set: spyCamelCase2}
/* eslint-enable accessor-pairs */
})

// sets dashed properties
render(root, m("a", {
style: {
"background-color": "red",
"-webkit-border-radius": "10px",
"--foo": "bar"
}
}))
o(spySetProperty.callCount).equals(3)
o(spySetProperty.calls[0].args).deepEquals(["background-color", "red"])
o(spySetProperty.calls[1].args).deepEquals(["-webkit-border-radius", "10px"])
o(spySetProperty.calls[2].args).deepEquals(["--foo", "bar"])

dead-claudia marked this conversation as resolved.
Show resolved Hide resolved
// sets camelCase properties and removes dashed properties
render(root, m("a", {
style: {
backgroundColor: "green",
color: "red",
}
}))
o(spyCamelCase1.callCount).equals(1)
o(spyCamelCase2.callCount).equals(1)
o(spyCamelCase1.calls[0].args).deepEquals(["green"])
o(spyCamelCase2.calls[0].args).deepEquals(["red"])
o(spyRemoveProperty.callCount).equals(3)
o(spyRemoveProperty.calls[0].args).deepEquals(["background-color"])
o(spyRemoveProperty.calls[1].args).deepEquals(["-webkit-border-radius"])
o(spyRemoveProperty.calls[2].args).deepEquals(["--foo"])

dead-claudia marked this conversation as resolved.
Show resolved Hide resolved
// updates "color" and removes "backgroundColor"
render(root, m("a", {style: {color: "blue"}}))
o(spyCamelCase1.callCount).equals(2) // set and remove
o(spyCamelCase2.callCount).equals(2) // set and update
o(spyCamelCase1.calls[1].args).deepEquals([""])
o(spyCamelCase2.calls[1].args).deepEquals(["blue"])

// unchanged by camelCase properties
o(spySetProperty.callCount).equals(3)
o(spyRemoveProperty.callCount).equals(3)

// never calls dashed property setter
o(spyDashed1.callCount).equals(0)
o(spyDashed2.callCount).equals(0)
o(spyDashed3.callCount).equals(0)
})
o("replaces el", function() {
var vnode = m("a")
var updated = m("b")
Expand Down
18 changes: 12 additions & 6 deletions test-utils/domMock.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -284,12 +284,18 @@ module.exports = function(options) {
getPropertyValue: {value: function(key){
return style[key]
}},
removeProperty: {value: function(key){
style[key] = style[camelCase(key)] = ""
}},
setProperty: {value: function(key, value){
style[key] = style[camelCase(key)] = value
}}
removeProperty: {
writable: true,
value: function(key){
style[key] = style[camelCase(key)] = ""
}
},
setProperty: {
writable: true,
value: function(key, value){
style[key] = style[camelCase(key)] = value
}
}
})
var events = {}
var element = {
Expand Down