Skip to content

fix: handle z-index as unitless property #667

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

Jump to bottom
Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: handle z-index as unitless property #667

wants to merge 1 commit into from

Conversation

kirandash
Copy link

Description

Current behavior:

When setting z-index values in styles, a warning appears stating "Expected style 'zIndex: 1px' to be unitless". This warning is incorrect since z-index should be handled as a unitless property. While z-index has no effect in SVG (as elements are painted in document order), the warning itself needs to be fixed for better developer experience.

Changes in this PR:

  • Added special case handling for zIndex property
  • Added clear warning message explaining that z-index is not supported in SVG
  • Improved developer experience by providing more accurate feedback about SVG limitations

Closes #660

Test plan

Before

The floating warning appears in console when setting z-index:

style={{
  zIndex: 1
}}

Shows warning: "Expected style 'zIndex: 1px' to be unitless"

image

After

  1. Set z-index in styles
  2. Verify the correct warning appears: "z-index is not supported in SVG. Elements are painted in the order they appear in the document."
  3. Test with different z-index values
  4. Verify the warning is clear and helpful for developers

image

@kirandash
fix: handle z-index as unitless property
4947759 
The warning "Expected style 'zIndex: 1px' to be unitless" appears when
setting z-index values. While z-index has no effect in SVG (as elements
are painted in document order), the warning itself is incorrect since
z-index should be handled as a unitless property.

Added zIndex to handleSpecialCase to properly handle it before unit
processing and provide a clear warning about SVG limitations.

Fixes vercel#660
@kirandash kirandash requested a review from shuding as a code owner April 1, 2025 16:53
@vercel Vercel
Copy link

vercel bot commented Apr 1, 2025 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
satori-playground ✅ Ready (Inspect) Visit Preview 💬 Add feedback Apr 1, 2025 4:54pm

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@shuding shuding Awaiting requested review from shuding shuding is a code owner

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Expected style "zIndex: 1px" to be unitless
1 participant
@kirandash