Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/vuejs/vuex

🗃️ Centralized State Management for Vue.js.
https://github.com/vuejs/vuex

javascript state-management time-travel vue vuex

Last synced: 6 days ago
JSON representation

🗃️ Centralized State Management for Vue.js.

Awesome Lists containing this project

README 

        
# Vuex



[![npm](https://img.shields.io/npm/v/vuex.svg)](https://npmjs.com/package/vuex)

[![ci status](https://github.com/vuejs/vuex/actions/workflows/ci.yml/badge.svg)](https://github.com/vuejs/vuex/actions/workflows/ci.yml)



---



**Pinia is now the new default**



The official state management library for Vue has changed to [Pinia](https://pinia.vuejs.org). Pinia has almost the exact same or enhanced API as Vuex 5, described in [Vuex 5 RFC](https://github.com/vuejs/rfcs/pull/271). You could simply consider Pinia as Vuex 5 with a different name. Pinia also works with Vue 2.x as well.



Vuex 3 and 4 will still be maintained. However, it's unlikely to add new functionalities to it. Vuex and Pinia can be installed in the same project. If you're migrating existing Vuex app to Pinia, it might be a suitable option. However, if you're planning to start a new project, we highly recommend using Pinia instead.



---



Vuex is a state management pattern + library for Vue.js applications. It serves as a centralized store for all the components in an application, with rules ensuring that the state can only be mutated in a predictable fashion. It also integrates with Vue's official [devtools extension](https://github.com/vuejs/vue-devtools) to provide advanced features such as zero-config time-travel debugging and state snapshot export / import.



Learn more about Vuex at "[What is Vuex?](https://vuex.vuejs.org/)", or get started by looking into [full documentation](http://vuex.vuejs.org/).



## Documentation



To check out docs, visit [vuex.vuejs.org](https://vuex.vuejs.org/).



## Examples



You may find example applications built with Vuex under the `examples` directory.



Running the examples:



```bash

$ npm install

$ npm run dev # serve examples at localhost:8080

```



## Questions



For questions and support please use the [Discord chat server](https://chat.vuejs.org) or [the official forum](http://forum.vuejs.org). The issue list of this repo is **exclusively** for bug reports and feature requests.



## Issues



Please make sure to read the [Issue Reporting Checklist](https://github.com/vuejs/vuex/blob/main/.github/contributing.md#issue-reporting-guidelines) before opening an issue. Issues not conforming to the guidelines may be closed immediately.



## Changelog



Detailed changes for each release are documented in the [release notes](https://github.com/vuejs/vuex/releases).



## Stay In Touch



For latest releases and announcements, follow on Twitter: [@vuejs](https://twitter.com/vuejs).



## Contribution



Please make sure to read the [Contributing Guide](https://github.com/vuejs/vuex/blob/main/.github/contributing.md) before making a pull request.



## License



[MIT](http://opensource.org/licenses/MIT)



Copyright (c) 2015-present Evan You