Skip to content


Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?

Latest commit


Git stats


Failed to load latest commit information.
Latest commit message
Commit time

๐Ÿ“ฎ vue-state-store (vss)

Simple state management system that full supports for typescript.

๐Ÿ“ฌ Distributed state management module system for Vue. [Pub & Sub model based]

๐ŸŒŽ Global

The following multilingual documents are provided. (need pull request help)

๐Ÿ“” Table of Contents

๐Ÿ˜Š Easy use! & Powerful application!

vue-state-store (vss) is a module that is intended to completely replace the vuex modules that were popular with the vue. The purpose of this module is to make state management very easy by using 200% efficiency of typescript.

๐Ÿ’ก Advantages compared to vuex

  • Low running curve - Use simple publishing & subscription model
  • Supports Typescript Intellisense - Status & Actions & Mutation & When using variables within Templates
  • Auto-Bind function - Easy vue template binding.
  • Pure typescript class based definition - no need to use mix-in
  • A unified action structure - Flexible use with no distinction between action and motion.
  • Allow flexible state use - If you omit Mutation, you can use it as Getters.

๐Ÿ’ฌ Installation

(Vue2, Vue3, Nuxt is supported. Automatic binding function in Composition API : .bind(')' is supported.)

npm i vue-state-store

๐Ÿ”ฎ Devtools Apply

vue-state-store supports vue-devtools. (You can see information about the state stores created through vue-state-store on the vuex tab.)

View Related Content

๐Ÿ“ฌ Pub & Sub Model Description

vue-state-store uses publish & subscription design patterns.

vue-state-store is a storage that exists in the memory where values are stored. The .subscribe (callback) function allows you to receive changed values in a callback when values in the storage change, and you can update the values in the storage through .set (newValue) and .update((data) => data).

๐Ÿ˜Ž Basic Usage

vue-state-store is an easy way to manage both state and actions and mutations through a function or class.

๐Ÿ“ฎ Primitive Type Pub & Sub

Primitive type means five basic types (number, string, boolean, null, undefined).

The .subscribe() function, when the execution, gives a function as a return value, which can interrupt the storage subscription at any time. So I write that value name of "unsubscribe".

๐Ÿ“ฎ Object Type Pub & Sub

If you look below, you can see that there is little difference between the top and the usage.

In store(value), the value can be a primary type or object.

๐Ÿ“ฎ Create state & embedded action

vue-state-store can define embedded actions by inheriting classes.

In vue-state-store, the distinction between action and motion is not required.

  • By creating any function in the class, you can configure Embedded action.
  • Any function that transforms a state without being embedded in the class is called Outside Action.

๐Ÿ“ฎ Binding within the Vue template

vue-state-store can easily bind the repository to the vue template tag, and the bound store continues to support Typescript Intellisense within the template tag. Typescript Intellisense is also supported when using embedded actions into the storage within the script tag.

  • The embedded action can be called just by calling the state through import.
  • The 'bind() function automatically binds the storage into the template.
    • It is recommended to put '$' in front of the existing storage name as a naming rule, as shown in return { $vote: vote.bind() } .
    • The .bind() function is recommended to be used within the setup function of @vue/composition-api.

๐Ÿš€ Advanced Usage

Explain the advanced ways to use it. (This does not raise the learning curve.)

โณ Asynchronous-tic Usage

The function .update() and '.set()' return Promise.

  • await allows certain logic to run after the update job completes when you update the storage values.

  • You can also define callbacks to async that are passed to the update function.

๐Ÿ’ก Vscode Intellisense Usage

To use both vscode and typescript at the same time and need some Intellisense support, you can obtain the module below.

In order to receive support for intellisense in the template after installing vetur, the following option should be added to the vscode setting.

"vetur.experimental.templateInterpolationService": true

๐Ÿ“ฎ (Advanced) State Use Function Design Pattern

vue-state-store provides examples of design patterns of functions that begin with use~ similar to React Hooks to make the most of the composition API.

State Use Function refers to the use of a function that is preceded by the word use (if there is a state called useTodo inside the component and receives the status store as a result).

This allows you to use the life cycle of the component in the state store.

If you use the accessor(.set() and .update()) to modify the state, it can be very cumbersome to create complex logic, unlike when you modify the existing general variables.

vue-state-store allows for convenient change of state by directly accessing bindings within the store without the use of such an accessor. This design pattern is only a simple example of configuring the status usage function when using the Composition API (not necessarily), If you need to modify the state in a complex way, or If you need to create multiple compute objects.

Even if you modify a bound value, the changes are automatically distributed to the callbacks you are subscribing to each time the value changes.

If you refer to the value of a bound store in a callback wrapped in computed , the callback will occur again whenever the value of that store changes. This reduces the fatigue of re-calculating each function as it is called, thus improving performance when using a state.

To define Vue's lifecycle or computed, you must create one isolated function, such as useTodo, and must be call within the component.

As shown above, you can use it within the template tag immediately after using useToto(). (Of course Typescript Intellisense is still supported.)

๐Ÿ“ฎ (Advanced) Declare-Define-Inject-Use Design Pattern

Please check the design pattern on a separate page.

View Description

๐Ÿค” Q&A

Questions can also be asked through the Github Issue section.

๐Ÿงฒ Q. Doesn't have a $store with all the state stores like vuex?

A. No, it's not. It's a non-recommended design pattern.

it's recommended that you import and use only a few stores after creating any index.ts file, , such as import { vote } from '~/store. vue-state-store has a distributed structure and can only refer to each other individually if each storage is required.

vue-state-store consists of vue completely independent (until it is used within the vue template tag through the .bind() function).

๐Ÿ‘€ Q. Will the changed value be rendered again if the .bind() value is changed?

A. Yes, the storage values changed through the ref of vue are reflected in the DOM through template tags in real time.

๐Ÿ“ก Q. Is the .bind() value work two way binding?

A. Yes, the binding value changes as the storage value changes, and the storage value changes as the binding value changes.

๐Ÿ“” License

Copyright (c) 2020 AhaOfficial

MIT Licensed