Skip to content

Update Nuxt module README #3013

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

Merged
merged 2 commits into from
Jul 23, 2025
Merged
Show file tree
Hide file tree
Changes from all 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
49 changes: 38 additions & 11 deletions packages/nuxt/README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,56 @@
# `@pinia/nuxt`

> Nuxt 2 & 3 module
> Nuxt module for Pinia

## Installation
## Automatic Installation

Use `nuxi` to automatically add this module to your Nuxt project:

```shell
npm i pinia @pinia/nuxt
npx nuxi@latest module add pinia
```

## Usage
## Manual Installation

Add dependencies to your Nuxt project:

```shell
npm i pinia @pinia/nuxt
```

Add to `modules` (Nuxt 3) or `buildModules` (Nuxt 2) in `nuxt.config.js`:
Enable the `@pinia/nuxt` module in `nuxt.config.ts`:

```js
// Nuxt 2
export default {
buildModules: [['@pinia/nuxt', { disableVuex: true }]],
}
// Nuxt 3
export default defineNuxtConfig({
modules: ['@pinia/nuxt'],
})
```

Note you also need `@nuxtjs/composition-api` if you are using Nuxt 2 without Bridge. [Refer to docs for more](https://pinia.vuejs.org/ssr/nuxt.html).
## Configuring the Module

By default, this module adds `stores` folder to auto imports, in which you can organize code related to Pinia stores in one place.
> [!TIP]
> In the new directory structure introduced since Nuxt 4, this directory is `app/stores`.

You can customize this behaviour using the `pinia` property in `nuxt.config.ts`:

```js
export default defineNuxtConfig({
modules: ['@pinia/nuxt'],
// configure the module using `pinia` property
pinia: {
/**
* Automatically add stores dirs to the auto imports. This is the same as
* directly adding the dirs to the `imports.dirs` option. If you want to
* also import nested stores, you can use the glob pattern `./stores/**`
* (on Nuxt 3) or `app/stores/**` (on Nuxt 4+)
*
* @default `['stores']`
*/
storesDirs: []
}
})
```

## License

Expand Down
1 change: 1 addition & 0 deletions packages/nuxt/src/module.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ export interface ModuleOptions {
* Automatically add stores dirs to the auto imports. This is the same as
* directly adding the dirs to the `imports.dirs` option. If you want to
* also import nested stores, you can use the glob pattern `./stores/**`
* (on Nuxt 3) or `app/stores/**` (on Nuxt 4+)
*
* @default `['stores']`
*/
Expand Down