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 16 commits into
base: v3
Choose a base branch
from
Draft
Changes from 2 commits
Commits
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
31 changes: 31 additions & 0 deletions docs/content/1.getting-started/8.migration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
title: Migration
description: 'Migration guide from Nuxt UI v2.x to Nuxt UI v3.x'
---

Nuxt UI v3 has had many changes from Nuxt UI v2. While most of the functionality was kept, some breaking changes are inevitable in a major release.

Below is a comprehensive migration guide to help you transition to Nuxt UI v3 quickly and efficiently.

### Renamed components
The following changes require you to simply change the names in your projects. No further modifications are needed:

1. `UDivider` was renamed to `USeparator`.
2. `UDropdown` was renamed to `UDropdownMenu`.
3. The panel slot in `UPopup` (`<template #panel>`) was renamed to `content` (`<template #content>`).
GalacticHypernova marked this conversation as resolved.
Show resolved Hide resolved

### Changed components
The following changes require you to change some functionality in the projects:

1. `UAvatar` can no longer be the trigger in `UDropdownMenu`. You can use a `UButton` with the `avatar` prop in stead:
```diff
// v2
<UDropdown>
- <UAvatar :src="profilePicture"/>
</UDropdown>

// v3
<UDropdownMenu>
+ <UButton :avatar="{src: profilePicture}" />
</UDropdownMenu>
```
GalacticHypernova marked this conversation as resolved.
Show resolved Hide resolved
Loading