
Heroui Migration
- 2.8k installs
- 30.3k repo stars
- Updated August 4, 2026
- heroui-inc/heroui
heroui-migration is a HeroUI skill for upgrading v2 React apps to v3 using fetched agent migration guides.
About
The heroui-migration skill guides agents upgrading HeroUI v2 applications to v3 with breaking API changes. v3 removes HeroUIProvider, adopts compound components like Card.Header instead of flat props, switches onClick to onPress, replaces classNames with className, and consolidates packages to @heroui/react and @heroui/styles with Tailwind v4. Agents must fetch migration docs before applying changes via node scripts such as get_migration_guide.mjs, get_component_migration_guides.mjs, get_styling_migration_guide.mjs, and get_hooks_migration_guide.mjs. Full migration rewrites all components before switching dependencies, while incremental migration uses pnpm aliases so v2 and v3 coexist during gradual rollout. The workflow runs analyze imports, migrate component batches with per-component guides, switch dependencies, then apply styling updates. Preview docs live on a Vercel staging base URL overridable with HEROUI_MIGRATION_DOCS_BASE; an MCP server at migration-mcp.heroui.com offers tool-based access in Cursor.
- Always fetch migration guides before assuming v2 patterns work in v3.
- v3 uses compound components; HeroUIProvider is no longer required.
- Interactive components use onPress instead of onClick handlers.
- Full and incremental migration strategies with coexistence options.
- Scripts list guides; MCP server available for Cursor clients.
Heroui Migration by the numbers
- 2,764 all-time installs (skills.sh)
- +156 installs in the week ending Aug 5, 2026 (Skillselion tracking)
- Ranked #191 of 2,245 Frontend Development skills by installs in the Skillselion catalog
- Security screen: MEDIUM risk (skills.sh audit)
- Data as of Aug 5, 2026 (Skillselion catalog sync)
heroui-migration capabilities & compatibility
- Capabilities
- script driven migration guide fetching workflow · full versus incremental upgrade strategy selecti · per component migration guide lookup · hooks to compound component migration routing · mcp and url based documentation access patterns
- Use cases
- frontend · refactoring · ui design
npx skills add https://github.com/heroui-inc/heroui --skill heroui-migrationAdd your badge
Show developers this skill is listed on Skillselion. Paste this into your README.
| Installs | 2.8k |
|---|---|
| repo stars | ★ 30.3k |
| Security audit | 2 / 3 scanners passed |
| Last updated | August 4, 2026 |
| Repository | heroui-inc/heroui ↗ |
How do I migrate a HeroUI v2 app to v3 without missing breaking component API changes?
Migrate HeroUI v2 React apps to v3 using fetched migration guides, compound components, and full or incremental upgrade strategies.
Who is it for?
React apps on HeroUI v2 preparing for v3 compound components and Tailwind v4.
Skip if: Skip for greenfield HeroUI v3 installs without legacy v2 code to migrate.
When should I use this skill?
User mentions HeroUI migration, v2 to v3 upgrade, or HeroUIProvider removal.
What you get
Components, dependencies, and styling updated per fetched full or incremental migration guides.
- Migrated HeroUI v3 components
- Updated Tailwind v4 config
- Removed Provider and deprecated hooks
By the numbers
- Skill metadata version 2.0.0 with preview status
- HeroUI v3 removes Provider, drops v2 hooks, and requires Tailwind v4
Files
HeroUI v2 to v3 Migration Guide
This skill helps agents migrate HeroUI v2 applications to v3. HeroUI v3 introduces breaking changes: compound components, no Provider, Tailwind v4, and removed hooks.
---
Installation
curl -fsSL https://heroui.com/install | bash -s heroui-migration---
CRITICAL: Always Fetch Migration Docs Before Applying
Do NOT assume v2 patterns work in v3. Always fetch migration guides before implementing changes.
Key v2 → v3 Changes
| Feature | v2 (Migrate From) | v3 (Migrate To) |
|---|---|---|
| Provider | <HeroUIProvider> required | No Provider needed |
| Component API | Flat props: <Card title="x"> | Compound: <Card><Card.Header> |
| Event handlers | onClick | onPress |
| Styling | classNames prop | className prop |
| Hooks | useSwitch, useDisclosure, etc. | Compound components, useOverlayState |
| Packages | @heroui/system, @heroui/theme | @heroui/react, @heroui/styles |
---
Accessing Migration Documentation
For migration details, examples, and step-by-step guides, always fetch documentation:
Using Scripts
# List all available component migration guides
node scripts/list_migration_guides.mjs
# Get main migration workflow (full or incremental)
node scripts/get_migration_guide.mjs full
node scripts/get_migration_guide.mjs incremental
# Get component-specific migration guides
node scripts/get_component_migration_guides.mjs button
node scripts/get_component_migration_guides.mjs button card modal
# Get styling migration guide
node scripts/get_styling_migration_guide.mjs
# Get hooks migration guide
node scripts/get_hooks_migration_guide.mjsDirect URLs
Migration docs (preview): https://heroui-git-docs-migration-heroui.vercel.app/docs/react/migration/{filename}
Examples:
- Full migration:
.../agent-guide-full.mdx - Incremental:
.../agent-guide-incremental.mdx - Button:
.../button.mdx - Styling:
.../styling.mdx - Hooks:
.../hooks.mdx
Override base URL with HEROUI_MIGRATION_DOCS_BASE when docs are merged to production.
MCP Alternative
When using Cursor or other MCP clients, configure the Migration MCP server for tool-based access:
{
"mcpServers": {
"heroui-migration": {
"url": "https://migration-mcp.heroui.com"
}
}
}---
Migration Strategies
Full Migration
- Best for: Projects that can dedicate focused time; teams comfortable with temporarily broken code
- Migrate all component code first (project broken during migration)
- Switch dependencies to v3
- Complete styling migration
Incremental Migration
- Best for: Projects that must stay functional; large codebases migrating gradually
- Set up coexistence (pnpm aliases or component packages)
- Migrate components one-by-one
- Both v2 and v3 coexist during migration
Always fetch the agent guide before starting: node scripts/get_migration_guide.mjs full or incremental
---
Core Principles
1. Fetch first: Use scripts to get migration guides before applying changes 2. Compound components: v3 uses Card.Header, Card.Title, Button with children—not flat props 3. No Provider: Remove HeroUIProvider when migrating 4. onPress not onClick: All interactive components use onPress 5. Workflow: Analyze → Migrate components → Switch deps → Styling migration
---
Migration Workflow Summary
1. Create migration branch 2. Analyze project (HeroUI imports, component usage) 3. Fetch main guide: node scripts/get_migration_guide.mjs full 4. Migrate components in batches (fetch component guides per batch) 5. Switch dependencies to v3 6. Fetch styling guide: node scripts/get_styling_migration_guide.mjs 7. Apply styling updates
---
Preview Mode
This skill targets the staging deployment of the docs/migration branch. Once docs are merged to main and live on heroui.com, set HEROUI_MIGRATION_DOCS_BASE=https://heroui.com/docs/react/migration or update the default in scripts.
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to the Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by the Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding any notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. Please also get an approval
from the project maintainers before using the Apache License.
Copyright 2025 NextUI Inc.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
#!/usr/bin/env node
/**
* Get migration guides for HeroUI components (v2 to v3).
*
* Usage:
* node get_component_migration_guides.mjs button
* node get_component_migration_guides.mjs button card modal
*
* Output:
* MDX migration guide content for each component
*/
const DOCS_BASE =
process.env.HEROUI_MIGRATION_DOCS_BASE ||
"https://heroui-git-docs-migration-heroui.vercel.app/docs/react/migration";
const APP_PARAM = "app=migration-skills";
/**
* Convert PascalCase or mixed case to kebab-case.
*/
function toKebabCase(name) {
return name
.replace(/([a-z])([A-Z])/g, "$1-$2")
.replace(/([A-Z])([A-Z][a-z])/g, "$1-$2")
.toLowerCase()
.trim();
}
async function fetchDoc(filename) {
const url = `${DOCS_BASE}/${filename}?${APP_PARAM}`;
try {
const response = await fetch(url, {
headers: {"User-Agent": "HeroUI-Migration-Skill/1.0"},
signal: AbortSignal.timeout(30000),
});
if (!response.ok) {
throw new Error(`HTTP ${response.status}: ${response.statusText}`);
}
return await response.text();
} catch (error) {
throw new Error(error.message);
}
}
async function main() {
const args = process.argv.slice(2);
if (args.length === 0) {
console.error("Usage: node get_component_migration_guides.mjs <Component1> [Component2] ...");
console.error("Example: node get_component_migration_guides.mjs button card modal");
console.error("\nUse list_migration_guides.mjs to see all available components.");
process.exit(1);
}
const components = args.map((c) => toKebabCase(c));
console.error(`# Fetching migration guides for: ${components.join(", ")}...`);
const results = [];
for (const component of components) {
const filename = `${component}.mdx`;
try {
const content = await fetchDoc(filename);
const title = component.charAt(0).toUpperCase() + component.slice(1).replace(/-/g, " ");
results.push({
component,
content: `# ${title} Migration Guide\n\n**Component:** ${component}\n**Source:** ${DOCS_BASE}/${filename}\n\n---\n\n${content}`,
});
} catch (error) {
results.push({
component,
error: error.message,
});
}
}
const failed = results.filter((r) => r.error);
if (failed.length > 0) {
failed.forEach((r) => console.error(`# Error for ${r.component}: ${r.error}`));
}
if (results.length === 1) {
const r = results[0];
if (r.content) {
console.log(r.content);
} else {
console.log(JSON.stringify(r, null, 2));
process.exit(1);
}
} else {
const output = results
.map((r) => (r.content ? r.content : `# ${r.component} Migration Guide\n\nError: ${r.error}`))
.join("\n\n---\n\n");
console.log(output);
if (failed.length === results.length) {
process.exit(1);
}
}
}
main();
#!/usr/bin/env node
/**
* Get the hooks migration guide for HeroUI v2 to v3.
*
* Usage:
* node get_hooks_migration_guide.mjs
*
* Output:
* MDX hooks migration guide content
*/
const DOCS_BASE =
process.env.HEROUI_MIGRATION_DOCS_BASE ||
"https://heroui-git-docs-migration-heroui.vercel.app/docs/react/migration";
const APP_PARAM = "app=migration-skills";
async function fetchDoc(filename) {
const url = `${DOCS_BASE}/${filename}?${APP_PARAM}`;
try {
const response = await fetch(url, {
headers: {"User-Agent": "HeroUI-Migration-Skill/1.0"},
signal: AbortSignal.timeout(30000),
});
if (!response.ok) {
throw new Error(`HTTP ${response.status}: ${response.statusText}`);
}
return await response.text();
} catch (error) {
throw new Error(`Failed to fetch ${filename}: ${error.message}`);
}
}
async function main() {
const filename = "hooks.mdx";
console.error("# Fetching hooks migration guide...");
try {
const content = await fetchDoc(filename);
console.log(
`# HeroUI v2 to v3 Hooks Migration Guide\n\n**Source:** ${DOCS_BASE}/${filename}\n\n---\n\n${content}`,
);
} catch (error) {
console.error(`# Error: ${error.message}`);
process.exit(1);
}
}
main();
#!/usr/bin/env node
/**
* Get the main migration workflow guide (full or incremental) for HeroUI v2 to v3.
*
* Usage:
* node get_migration_guide.mjs [full|incremental]
*
* Default: full
*
* Output:
* MDX migration guide content
*/
const DOCS_BASE =
process.env.HEROUI_MIGRATION_DOCS_BASE ||
"https://heroui-git-docs-migration-heroui.vercel.app/docs/react/migration";
const APP_PARAM = "app=migration-skills";
async function fetchDoc(filename) {
const url = `${DOCS_BASE}/${filename}?${APP_PARAM}`;
try {
const response = await fetch(url, {
headers: {"User-Agent": "HeroUI-Migration-Skill/1.0"},
signal: AbortSignal.timeout(30000),
});
if (!response.ok) {
throw new Error(`HTTP ${response.status}: ${response.statusText}`);
}
return await response.text();
} catch (error) {
throw new Error(`Failed to fetch ${filename}: ${error.message}`);
}
}
async function main() {
const arg = (process.argv[2] || "full").toLowerCase();
const migrationType = arg === "incremental" ? "incremental" : "full";
const filename =
migrationType === "incremental" ? "agent-guide-incremental.mdx" : "agent-guide-full.mdx";
console.error(`# Fetching ${migrationType} migration guide...`);
try {
const content = await fetchDoc(filename);
const title =
migrationType === "incremental"
? "HeroUI v2 to v3 Agent Migration Guide - Incremental Migration"
: "HeroUI v2 to v3 Agent Migration Guide - Full Migration";
console.log(`# ${title}\n\n**Source:** ${DOCS_BASE}/${filename}\n\n---\n\n${content}`);
} catch (error) {
console.error(`# Error: ${error.message}`);
process.exit(1);
}
}
main();
#!/usr/bin/env node
/**
* Get the styling migration guide for HeroUI v2 to v3.
*
* Usage:
* node get_styling_migration_guide.mjs
*
* Output:
* MDX styling migration guide content
*/
const DOCS_BASE =
process.env.HEROUI_MIGRATION_DOCS_BASE ||
"https://heroui-git-docs-migration-heroui.vercel.app/docs/react/migration";
const APP_PARAM = "app=migration-skills";
async function fetchDoc(filename) {
const url = `${DOCS_BASE}/${filename}?${APP_PARAM}`;
try {
const response = await fetch(url, {
headers: {"User-Agent": "HeroUI-Migration-Skill/1.0"},
signal: AbortSignal.timeout(30000),
});
if (!response.ok) {
throw new Error(`HTTP ${response.status}: ${response.statusText}`);
}
return await response.text();
} catch (error) {
throw new Error(`Failed to fetch ${filename}: ${error.message}`);
}
}
async function main() {
const filename = "styling.mdx";
console.error("# Fetching styling migration guide...");
try {
const content = await fetchDoc(filename);
console.log(
`# HeroUI v2 to v3 Styling Migration Guide\n\n**Source:** ${DOCS_BASE}/${filename}\n\n---\n\n${content}`,
);
} catch (error) {
console.error(`# Error: ${error.message}`);
process.exit(1);
}
}
main();
#!/usr/bin/env node
/**
* List all available HeroUI v2 to v3 component migration guides.
*
* Usage:
* node list_migration_guides.mjs
*
* Output:
* List of component names that have migration guides
*
* Note: Keep in sync with migration-mcp list-migration-guides.ts when adding components.
*/
// Component migration guides available - must match migration-mcp list-migration-guides.ts
const AVAILABLE_COMPONENTS = [
"accordion",
"alert",
"autocomplete",
"avatar",
"breadcrumbs",
"button",
"button-group",
"card",
"checkbox",
"checkbox-group",
"chip",
"code",
"divider",
"dropdown",
"form",
"image",
"input",
"input-otp",
"kbd",
"link",
"listbox",
"modal",
"navbar",
"numberinput",
"popover",
"radio",
"radio-group",
"scroll-shadow",
"select",
"skeleton",
"slider",
"snippet",
"spacer",
"spinner",
"switch",
"tabs",
"toast",
"tooltip",
"user",
];
function main() {
const componentsList = AVAILABLE_COMPONENTS.map((name) => ` - ${name}`).join("\n");
console.log(
`# Available Component Migration Guides\n\nFound ${AVAILABLE_COMPONENTS.length} component migration guides:\n\n${componentsList}\n\nUse get_component_migration_guides.mjs with component names to fetch specific guides.\nExample: node get_component_migration_guides.mjs button card modal`,
);
}
main();
Related skills
How it compares
Pick heroui-migration for version-specific HeroUI v2→v3 breaking changes rather than generic React component renames.
FAQ
What is the biggest v3 API change?
Flat props become compound components like Card.Header, and HeroUIProvider is removed.
How do I fetch component-specific guides?
Run node scripts/get_component_migration_guides.mjs with component names such as button or modal.
When should I choose incremental migration?
When the app must stay functional during rollout; use pnpm aliases so v2 and v3 coexist.
Is Heroui Migration safe to install?
skills.sh reports 2 of 3 security scanners passed. Review the Security Audits panel on this page before installing in production.