pinia README

The project's README from github.com/vuejs/pinia. As one markdown file: README.md.

Pinia logo


npm package build status


Pinia

Intuitive, type safe and flexible Store for Vue

The latest version of pinia works with Vue 3. See the branch v2 for a version that works with Vue 2.

Pinia is the most similar English pronunciation of the word pineapple in Spanish: piña. A pineapple is in reality a group of individual flowers that join together to create a multiple fruit. Similar to stores, each one is born individually, but they are all connected at the end. It's also a delicious tropical fruit indigenous to South America.

👉 Demo with Vue 3 on StackBlitz

👉 Demo with Nuxt 3 on StackBlitz

Help me keep working on this project 💚

Gold Sponsors

CodeRabbit

Silver Sponsors

VueMastery Controla SendCloud

Bronze Sponsors

RTVision Storyblok

FAQ

A few notes about the project and possible questions:

Q: Is Pinia the successor of Vuex?

A: Yes

Q: What about dynamic modules?

A: Dynamic modules are not type safe, so instead we allow creating different stores that can be imported anywhere

Installation

# or pnpm or yarn
npm install pinia @vue/devtools-api

Usage

Install the plugin

Create a pinia (the root store) and pass it to app:

// Vue 3
import { createApp } from 'vue'
import { createPinia } from 'pinia'
import App from './App.vue'

const pinia = createPinia()
const app = createApp(App)

app.use(pinia)
app.mount('#app')

For more detailed instructions, including Nuxt configuration, check the Documentation.

Create a Store

You can create as many stores as you want, and they should each exist in different files:

import { defineStore } from 'pinia'

// main is the name of the store. It is unique across your application
// and will appear in devtools
export const useMainStore = defineStore('main', {
  // a function that returns a fresh state
  state: () => ({
    counter: 0,
    name: 'Eduardo',
  }),
  // optional getters
  getters: {
    // getters receive the state as first parameter
    doubleCounter: (state) => state.counter * 2,
    // use getters in other getters
    doubleCounterPlusOne(): number {
      return this.doubleCounter + 1
    },
  },
  // optional actions
  actions: {
    reset() {
      // `this` is the store instance
      this.counter = 0
    },
  },
})

defineStore returns a function that has to be called to get access to the store:

import { useMainStore } from '@/stores/main'
import { storeToRefs } from 'pinia'

export default defineComponent({
  setup() {
    const main = useMainStore()

    // extract specific store properties
    const { counter, doubleCounter } = storeToRefs(main)

    return {
      // gives access to the whole store in the template
      main,
      // gives access only to specific state or getter
      counter,
      doubleCounter,
    }
  },
})

Documentation

To learn more about Pinia, check its documentation.

License

MIT

pinia (vuejs/pinia)

Searching Database…

14.7K ·GitHub
Pinia
Что это такое?Pinia — это библиотека для управления состоянием (хранилище, store) во Vue, построенная на composition API Vue 3, которая обеспечивает типобезопасность и поддержку DevTools.
Это фреймворк или библиотека?Это библиотека, которую вы подключаете к приложению на Vue, а не самостоятельный фреймворк.
Как подключить это к проекту?Установите пакет, создайте экземпляр pinia (корневое хранилище) и передайте его вашему приложению Vue, а затем определяйте хранилища с помощью defineStore в отдельных файлах.
Мне обязательно нужен Vue 3?Да, эта версия Pinia рассчитана на Vue 3; для Vue 2 есть отдельная ветка v2.
Поддерживаются ли динамические модули в стиле Vuex?Нет, динамические модули не поддерживаются, так как они не типобезопасны; вместо них вы создаёте отдельные хранилища, которые можно импортировать где угодно.
Pinia предназначена для замены Vuex?Да, в README указано, что Pinia позиционируется как преемник Vuex.
Работает ли Pinia с Nuxt?Да, есть специальный модуль для Nuxt и демо, работающее на Nuxt 3, а также документация по настройке Nuxt.
Можно ли создать несколько хранилищ?Да, можно создать сколько угодно хранилищ; обычно каждое из них находится в своём файле, и доступ к нему получают через функцию, которую возвращает defineStore.
Поддерживает ли Pinia SSR?Да, SSR — одна из перечисленных возможностей и тем проекта наряду с поддержкой composition-api.
Почему она называется Pinia?Pinia — это наиболее близкое английское произношение испанского слова «piña» (ананас). Название выбрано как метафора: как цветки ананаса растут отдельно, но соединены вместе, так и каждое хранилище создаётся отдельно, но все они связаны между собой.
What are similar projects?vueuse, nuxt, vue, nuqs, vuex, iview, vant, next-auth
Which topics is it in?store, nuxt, vuex, ssr, state-management, nextjs, vue, npm, frontend, library, typescript, javascript
Creator
vuejs
Size
10 MB
Stars
14.7K
Updated
CommitOct 14Release@pinia/[email protected]Oct 14
Age
6y
Commits · 90 Days