zustand-pub
v1.0.0-beta.19
Published
Cross-Application/Cross-Framework State Management And Sharing based on zustand for React/Vue
Downloads
737
Maintainers
Readme
zustand-pub
zustand-pub
can provides cross-application and cross-framework(react/vue) state management and sharing
capabilities for these scenarios, such as iframe
, micro-frontend
, modularization
, componentization
, multiple technology stacks exist at the same time
, and gradual migration of project frameworks
.
Why do you need zustand-pub ?
- Applications/Components can
mutually call/modify state
andtrigger component rendering
, if in iframe, you can discard the hard-to-maintainpostMessage + addeventlistener + action
, if in micro-frontend, you don’t need it anymoreeventCenter + action
, just callaction
directly to modify the state。 Data Persistence Caching Scheme
based on external state storage, application/component/iframe/micro-frontend,etc.state can be cached
.- Usually, when we refer to the global
store
in business components, it will lead to the problem that the anthor application cannot be reused, which reduces the reusability of the component. However, based onzustand-pub
, such problems will no longer exist, reusability and development efficiency exist at the same time. - In the past, the store of
modular management
was reused in different library (applications), the state could not be updated synchronously, but the state of the store based onzustand-pub
module management could be updated synchronously, which improved the store development process. Feasibility of logic reuse and R&D efficiency. - In some iframe / micro-frontend scenarios, page rendering is slow due to
too many http requests
, based on this solution,sub-application status pre-request
can be performed to optimize user experience. - Based on devtools, you can
debug/trace stores between multiple applications at the same time
, which can greatly reduce the difficulty of debugging when communicating between applications. - If you are using zustand or zustand-vue, it will be very convenient to use zustand-pub.
Official Document 中文文档
:::note
Iframe Demo Source
Micro-FrontEnd Demo Source
:::
Install
npm install zustand-pub # or yarn add zustand-pub
Usage
Step 1: Initialize state isolation container pubStore
(Scene A)
import PubStore from 'zustand-pub'
const pubStore = new PubStore('key')
Step 2: Fill the isolation container pubStore
with data platformStore
(Scene A)
// vue
import create from "zustand-vue";
//react
// import create from "zustand";
interface IState {
appInfo: {
name: string
}
}
interface IAction {
setAppName: (val: string) => void
}
const platformStore = pubStore.defineStore<IState & IAction>('platformStore', (set) => ({
appInfo: { name: '' },
setAppName(val: string) {
set({
appInfo: {
name: val
}
})
}
}))
const usePlatformStore = create(platformStore)
return value usePlatformStore
is hook
,in scenario A, you can get the corresponding state through state selector
// vue3
<template>
<div>{name}</div>
</template>
<script>
const name = usePlatformStore((state) => state.appInfo.name);
const setAppName = usePlatformStore((state) => state.setAppName);
export default {
name: "AppA",
data(){
return {
name
}
},
methods:{
setAppName
}
}
</script>
// react
// function AppA() {
// const name = usePlatformStore((state) => state.appInfo.name);
// const setAppName = usePlatformStore((state) => state.setAppName);
// return <div>{name}</div>
// }
Step 3: Get the platformStore
under the isolated container pubStore
and bind the Component (Scene B)
// vue3
<template>
<div>{name}</div>
</template>
<script setup lang="ts">
interface IState {
appInfo: {
name: string
}
}
interface IAction {
setAppName: (val: string) => void
}
import PubStore from "zustand-pub";
import create from "zustand-vue";
const pubStore = new PubStore('key')
const store = pubStore.getStore<IState & IAction>("platformStore");
const usePlatformStore = create(store || {});
const name = usePlatformStore((state) => state.appInfo.name);
const setAppName = usePlatformStore((state) => state.setAppName);
</script>
// react
// import PubStore from "zustand-pub";
// import create from "zustand";
// const pubStore = new PubStore('key')
// const store = pubStore.getStore<IState & IAction>("platformStore");
// const usePlatformStore = create(store || {});
// function AppB() {
// const name = usePlatformStore((state) => state.appInfo.name);
// const setAppName = usePlatformStore((state) => state.setAppName);
// return <div>{name}</div>
// }
:::info The Usage of React to bind Component
The Usage of Vue to bind Component :::
API
PubStore(str)
Used to create state isolation containers, the data key
inside different isolation containers can have the same name and do not affect each other
:::info
In the same application, key
is unchanged and the pubStore
is returned unchanged
:::
const pubStore = new PubStore()
defineStore(key,fn)
Used to fill data into isolated containers
:::info
In the same application, key
is unchanged and the defined store
will be merged in the order of loading
that is defineStore(key,()=>({a:1,c:1})) defineStore(key,()=>({b:2,c:2}))
works like defineStore(key,()=>({a:1,b:2,c:1}))
:::
Parameter | Desc | Type --- | --- | --- key | data unique identifier | string fn | callback | (set, get) => Object
interface IStore {
...
}
// usePlatformStore is `hook`, and the corresponding state can be obtained through state `selector`
const usePlatformStore = pubStore.defineStore<IStore>('platformStore', (set, get) => ({}))
getStore(key)
Used to fetch data from isolated containers
Parameter | Desc | Type --- | --- | --- key | data unique identifier | string
const platformStore = pubStore.getStore("platformStore");
Return value platformStore
can be used to create hook
import create from "zustand";
//vue
// import create from "zustand-vue";
const usePlatformStore = create(platformStore || {});