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.

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

fix: spreading style is not consistent with attribute #15323

Merged
merged 8 commits into from
Mar 5, 2025

Conversation

adiguba
Copy link
Contributor

@adiguba adiguba commented Feb 17, 2025

When we pass the style value directly, set_attribute() is used.
But with spreading, it was set by an assign on element.style.cssText (or node[prop] for custom-element).

This cause the text to be parsed/corrected by the browser, and the value of the attribute will be different.

With this fix, spreading also use set_attribute() for style.

Before submitting the PR, please make sure you do the following

  • It's really useful if your PR references an issue where it is discussed ahead of time. In many cases, features are absent for a reason. For large changes, please create an RFC: https://github.com/sveltejs/rfcs
  • Prefix your PR title with feat:, fix:, chore:, or docs:.
  • This message body should clearly illustrate what problems it solves.
  • Ideally, include a test that fails without this PR but passes with it.
  • If this PR changes code within packages/svelte/src, add a changeset (npx changeset).

Tests and linting

  • Run the tests with pnpm test and lint the project with pnpm lint

Copy link

changeset-bot bot commented Feb 17, 2025

🦋 Changeset detected

Latest commit: c3934d6

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
svelte Patch

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

Copy link
Contributor

Playground

pnpm add https://pkg.pr.new/svelte@15323

@@ -224,15 +224,17 @@ export function set_custom_element_data(node, prop, value) {
set_active_effect(null);
try {
if (
// style need set_attribute()
prop !== 'style' &&
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If that is necessary, was it reall inconsistent before? Also see my question in the related issue

@Rich-Harris
Copy link
Member

I wonder if we should go the other way, i.e. always use style.cssText? If there's a style: directive, it gets normalized anyway, meaning that this...

<script>
	let { style = 'invalid-key:0; margin:4px;;color: green ;color:blue ' } = $props();
</script>

<div {style}></div>
<div {...{style}}></div>

<div {style} style:padding={0}></div>
<div {...{style}} style:padding={0}></div>

...results in this:

<div style="invalid-key:0; margin:4px;;color: green ;color:blue "></div>
<div style="invalid-key:0; margin:4px;;color: green ;color:blue "></div>
<div style="margin: 4px; color: blue; padding: 0px;"></div>
<div style="margin: 4px; color: blue; padding: 0px;"></div>

Feels like if we're making this change for the sake of consistency, we should go all the way. In microbenchmark conditions it's slightly slower to use style.cssText but I suspect that's just because the styles are calculated lazily, meaning it would make no difference in the real world

@Rich-Harris
Copy link
Member

Ah, I see — it makes SSR/hydration more finicky, at least as far as the tests are concerned

@svelte-docs-bot
Copy link

@Rich-Harris Rich-Harris merged commit 2f685c1 into sveltejs:main Mar 5, 2025
9 checks passed
@github-actions github-actions bot mentioned this pull request Mar 5, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Spread is not consistent with attribute for style
3 participants