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

feat: support SVGPath #243

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Conversation

imfenghuang
Copy link
Contributor

πŸ”— Linked issue

#241

❓ Type of change

  • πŸ“– Documentation (updates to the documentation, readme or JSDoc annotations)
  • 🐞 Bug fix (a non-breaking change that fixes an issue)
  • πŸ‘Œ Enhancement (improving an existing functionality like performance)
  • ✨ New feature (a non-breaking change that adds functionality)
  • 🧹 Chore (updates to the build process or auxiliary tools and libraries)
  • ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

πŸ“š Description

SVGPath related properties are not processed originally

  1. MotionProperties is defined includes SVGPathProperties, but does not process
  2. style supports process pathLength, pathSpacing, pathOffset
  3. pathLength always normalize to 1
  4. pathLength and pathSpacing to stroke-dasharray. stroke-dasharray = pathLength pathSpacing
    4.1 stroke-dasharray = pathLength pathSpacing. this support process dashes and gaps are two or same size, can't process that dashes and gaps of various sizes with an odd number of values, like 4,1,2 which is equivalent to [4,1,2,4,1,2]
  5. pathOffset to stroke-dashoffset
  6. tests and demo added

πŸ“ Checklist

  • I have linked an issue or discussion.
  • I have added tests (if possible).
  • I have updated the documentation accordingly.

@imfenghuang
Copy link
Contributor Author

hi @BobbieGoede can you pre-review this, and give me some advice?

Copy link

pkg-pr-new bot commented Dec 7, 2024

Open in Stackblitz

npm i https://pkg.pr.new/@vueuse/motion@243

commit: e8199eb

@BobbieGoede
Copy link
Member

Sorry again for the delays in reviewing this PR is a bit more involved and I'm contributing on several projects at the same timeπŸ˜…

My initial thoughts:

  1. I see some opportunities for perf improvements such as caching/saving the result of isSVGElement rather than checking multiple times in the same block.
  2. This handles 3 SVG path attributes, is there a (complete) list of SVG properties we would ideally have support for?
  3. The handling of the SVG attributes seems to be quite specific, from what I recall the style attributes we currently support are handled in a more generalized manner, is there a reason why SVG attributes cannot be handled in the same way as normal attributes?

Please let me know if more clarification is needed πŸ™ Contributions are always appreciated, just making sure we preserve maintainability when adding more functionality πŸ’ͺ

@imfenghuang
Copy link
Contributor Author

imfenghuang commented Dec 18, 2024

thanks a lot πŸ™
i think i was wrong πŸ˜…

i saw the code SVGPathProperties so i tried to use pathOffset pathSpacing to control the svg animation like Framer, and it didn't work, but i forgot to use strokeDasharray strokeDashoffset πŸ˜…

now i use strokeDasharray strokeDashoffset, it work well.

export interface SVGPathProperties {
  pathLength?: number
  pathOffset?: number
  pathSpacing?: number
}

but like pathLength it still not support

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants