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

docs: migration guide #2871

Draft
wants to merge 10 commits into
base: v3
Choose a base branch
from
Draft

Conversation

GalacticHypernova
Copy link

@GalacticHypernova GalacticHypernova commented Dec 10, 2024

πŸ”— Linked issue

❓ Type of change

  • πŸ“– Documentation (updates to the documentation or readme)
  • 🐞 Bug fix (a non-breaking change that fixes an issue)
  • πŸ‘Œ Enhancement (improving an existing functionality)
  • ✨ 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

Work in progress migration guide from Nuxt UI v2 to Nuxt UI v3. None of the phrasing is final and is likely to change as I gather everything necessary and as it gets refined

πŸ“ Checklist

  • I have linked an issue or discussion.
  • I have updated the documentation accordingly.

Copy link

pkg-pr-new bot commented Dec 10, 2024

npm i https://pkg.pr.new/@nuxt/ui@2871

commit: 09d4b64

@GalacticHypernova
Copy link
Author

@benjamincanac should I also include UI Pro changes in here or keep it a separate migration guide? If the latter, I may need a little bit of help with the module selection πŸ˜…

Copy link
Member

We can just do Nuxt UI for now and later on we'll either make another page for UI Pro or integrate it in the same page with the :module-only component.

@GalacticHypernova
Copy link
Author

Sounds good to me! I'll start testing components to see what was changed, hopefully I'll find it all

@benjamincanac benjamincanac added the v3 #1289 label Dec 16, 2024
@GalacticHypernova
Copy link
Author

GalacticHypernova commented Jan 9, 2025

Hey @benjamincanac ! Is there anything else I missed? Or was the color palette transition the last change that was yet to be added to the PR? If I missed anything please do let me know!

@benjamincanac
Copy link
Member

@GalacticHypernova I would say there are tons of things missing 😬 You didn't mention anything about the different installation, theming, Tailwind CSS v4 using css-first config instead of js file, props change, app.config.ts change, etc.

But I can continue this when I'm done with Nuxt UI Pro v3 no worries 😊

@GalacticHypernova
Copy link
Author

GalacticHypernova commented Jan 13, 2025

Oh my, you're right. I am so sorry, I indeed forgot about the props, theming, and app.config changes. I was mainly going off of what I had personally tested so I now realize that it is very likely I only encountered a small chunk. I actually just went over the recent releases and noticed some breaking changes, but I don't know which of them were from v2 to v3 and which were from earlier v3 to later v3. I'll go over it tomorrow and take care of all them. Sorry again!
Though regarding the Tailwind changes, I assume we should just link to their upgrade guide as it's technically not a change in Nuxt UI.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation v3 #1289
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants