Skip to content

Commit 53ef29b

Browse files
committed
chore: rename package to @sfxcode/nuxt-ui-formkit and update references
1 parent fd8bbb9 commit 53ef29b

7 files changed

Lines changed: 117 additions & 117 deletions

File tree

.github/copilot-instructions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# GitHub Copilot Instructions for formkit-nuxt-ui
1+
# GitHub Copilot Instructions for nuxt-ui-formkit
22

33
## Project Overview
44
This is a Nuxt module that integrates FormKit with Nuxt UI components. The module provides seamless integration between FormKit form handling and Nuxt UI's design system.

CHANGELOG.md

Lines changed: 91 additions & 91 deletions
Large diffs are not rendered by default.

README.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,11 @@
1212
FormKit Nuxt UI bridges the gap between [FormKit](https://formkit.com/)'s powerful form management and [Nuxt UI](https://ui.nuxt.com/)'s beautiful component library, providing a complete solution for building forms in Nuxt applications.
1313

1414
- [ Release Notes](/CHANGELOG.md)
15-
- [🏀  Live Playground](https://github.com/sfxcode/formkit-nuxt-ui/tree/main/playground)
15+
- [🏀  Live Playground](https://github.com/sfxcode/nuxt-ui-formkit/tree/main/playground)
1616
- [📖  FormKit Documentation](https://formkit.com/)
1717
- [🎨  Nuxt UI Documentation](https://ui.nuxt.com/)
1818

19-
<img src="./formkit-nuxt-ui.png" alt="FormKit Nuxt UI Screenshot" width="70%" />
19+
<img src="nuxt-ui-formkit.png" alt="FormKit Nuxt UI Screenshot" width="70%" />
2020

2121
## Features
2222

@@ -74,13 +74,13 @@ Install the module to your Nuxt application:
7474

7575
```bash
7676
# Using pnpm (recommended)
77-
pnpm add @sfxcode/formkit-nuxt-ui
77+
pnpm add @sfxcode/nuxt-ui-formkit
7878

7979
# Using npm
80-
npm install @sfxcode/formkit-nuxt-ui
80+
npm install @sfxcode/nuxt-ui-formkit
8181

8282
# Using yarn
83-
yarn add @sfxcode/formkit-nuxt-ui
83+
yarn add @sfxcode/nuxt-ui-formkit
8484
```
8585

8686
Add the module to your `nuxt.config.ts`:
@@ -89,7 +89,7 @@ Add the module to your `nuxt.config.ts`:
8989
export default defineNuxtConfig({
9090
modules: [
9191
'@nuxt/ui',
92-
'@sfxcode/formkit-nuxt-ui'
92+
'@sfxcode/nuxt-ui-formkit'
9393
]
9494
})
9595
```
@@ -314,8 +314,8 @@ The playground includes comprehensive examples for all components:
314314

315315
```bash
316316
# Clone the repository
317-
git clone https://github.com/sfxcode/formkit-nuxt-ui.git
318-
cd formkit-nuxt-ui
317+
git clone https://github.com/sfxcode/nuxt-ui-formkit.git
318+
cd nuxt-ui-formkit
319319

320320
# Install dependencies (using pnpm)
321321
pnpm install
@@ -360,7 +360,7 @@ External Nuxt modules and applications can import FormKit definitions programmat
360360
### Import All Definitions
361361

362362
```typescript
363-
import { nuxtUIInputs, nuxtUIOutputs } from '@sfxcode/formkit-nuxt-ui/formkit'
363+
import { nuxtUIInputs, nuxtUIOutputs } from '@sfxcode/nuxt-ui-formkit/formkit'
364364

365365
// Use in FormKit config
366366
export default defineFormKitConfig({
@@ -378,7 +378,7 @@ import {
378378
nuxtUICheckboxDefinition,
379379
nuxtUIInputDefinition,
380380
nuxtUISelectDefinition
381-
} from '@sfxcode/formkit-nuxt-ui/definitions'
381+
} from '@sfxcode/nuxt-ui-formkit/definitions'
382382

383383
export default defineFormKitConfig({
384384
inputs: {
@@ -391,8 +391,8 @@ export default defineFormKitConfig({
391391

392392
### Available Import Paths
393393

394-
- `@sfxcode/formkit-nuxt-ui/formkit` - All definitions + type augmentation
395-
- `@sfxcode/formkit-nuxt-ui/definitions` - Definition objects only
394+
- `@sfxcode/nuxt-ui-formkit/formkit` - All definitions + type augmentation
395+
- `@sfxcode/nuxt-ui-formkit/definitions` - Definition objects only
396396

397397
For detailed usage examples, see [EXTERNAL_USAGE.md](./EXTERNAL_USAGE.md).
398398

@@ -417,14 +417,14 @@ Contributions are welcome! Please feel free to submit a Pull Request.
417417
- [Nuxt](https://nuxt.com/) - The Intuitive Vue Framework
418418

419419
<!-- Badges -->
420-
[npm-version-src]: https://img.shields.io/npm/v/@sfxcode/formkit-nuxt-ui/latest.svg?style=flat&colorA=020420&colorB=00DC82
421-
[npm-version-href]: https://npmjs.com/package/@sfxcode/formkit-nuxt-ui
420+
[npm-version-src]: https://img.shields.io/npm/v/@sfxcode/nuxt-ui-formkit/latest.svg?style=flat&colorA=020420&colorB=00DC82
421+
[npm-version-href]: https://npmjs.com/package/@sfxcode/nuxt-ui-formkit
422422

423-
[npm-downloads-src]: https://img.shields.io/npm/dm/@sfxcode/formkit-nuxt-ui.svg?style=flat&colorA=020420&colorB=00DC82
424-
[npm-downloads-href]: https://npm.chart.dev/@sfxcode/formkit-nuxt-ui
423+
[npm-downloads-src]: https://img.shields.io/npm/dm/@sfxcode/nuxt-ui-formkit.svg?style=flat&colorA=020420&colorB=00DC82
424+
[npm-downloads-href]: https://npm.chart.dev/@sfxcode/nuxt-ui-formkit
425425

426-
[license-src]: https://img.shields.io/npm/l/@sfxcode/formkit-nuxt-ui.svg?style=flat&colorA=020420&colorB=00DC82
427-
[license-href]: https://npmjs.com/package/@sfxcode/formkit-nuxt-ui
426+
[license-src]: https://img.shields.io/npm/l/@sfxcode/nuxt-ui-formkit.svg?style=flat&colorA=020420&colorB=00DC82
427+
[license-href]: https://npmjs.com/package/@sfxcode/nuxt-ui-formkit
428428

429429
[nuxt-src]: https://img.shields.io/badge/Nuxt-020420?logo=nuxt
430430
[nuxt-href]: https://nuxt.com
File renamed without changes.

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,10 @@
1313
}
1414
],
1515
"license": "MIT",
16-
"homepage": "https://github.com/sfxcode/formkit-nuxt-ui",
16+
"homepage": "https://github.com/sfxcode/nuxt-ui-formkit",
1717
"repository": {
1818
"type": "git",
19-
"url": "git+https://github.com/sfxcode/formkit-nuxt-ui.git"
19+
"url": "git+https://github.com/sfxcode/nuxt-ui-formkit.git"
2020
},
2121
"keywords": [
2222
"nuxt",

playground/app/app.vue

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -199,7 +199,7 @@ const items = ref<NavigationMenuItem[]>([
199199
<UColorModeButton />
200200

201201
<UButton
202-
to="https://github.com/sfxcode/formkit-nuxt-ui"
202+
to="https://github.com/sfxcode/nuxt-ui-formkit"
203203
target="_blank"
204204
icon="i-simple-icons-github"
205205
aria-label="GitHub"
@@ -224,7 +224,7 @@ const items = ref<NavigationMenuItem[]>([
224224

225225
<template #right>
226226
<UButton
227-
to="https://github.com/sfxcode/formkit-nuxt-ui"
227+
to="https://github.com/sfxcode/nuxt-ui-formkit"
228228
target="_blank"
229229
icon="i-simple-icons-github"
230230
aria-label="GitHub"

src/module.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ export type ModuleOptions = Record<string, never>
55

66
export default defineNuxtModule<ModuleOptions>({
77
meta: {
8-
name: 'formkit-nuxt-ui',
9-
configKey: 'formkitNuxtUi',
8+
name: 'nuxt-ui-formkit',
9+
configKey: 'nuxtUiFormkit',
1010
compatibility: {
1111
nuxt: '>=4.0.0',
1212
},
@@ -21,7 +21,7 @@ export default defineNuxtModule<ModuleOptions>({
2121

2222
addImportsDir(resolver.resolve('./runtime/composables'))
2323

24-
const NPM_PCK_FORMKIT_NUXT_UI = '@sfxcode/formkit-nuxt-ui'
24+
const NPM_PCK_FORMKIT_NUXT_UI = '@sfxcode/nuxt-ui-formkit'
2525

2626
const componentNames = ['FUDataView', 'FUDataEdit', 'FUDataDebug']
2727
componentNames.forEach(name =>

0 commit comments

Comments
 (0)