Git Product home page Git Product logo

micro-bridge's Introduction

micro-bridge

一个微前端多应用间通信的全局状态管理,支持值分类管理、动态监听、事件总线

Install

在所有需要通信的应用内将其加入依赖:

  yarn add micro-bridge
CDN
<body>
  <!-- ... -->
  <script src="https://cdn.jsdelivr.net/gh/fz6m/[email protected]/dist/micro-bridge.min.js"></script>
  <script>
    MicroBridge.Store.set('key', 'value')
  </script>
</body>

Usage

Store

Store 是一个含有操作全局数据方法的对象。

example
import { Store } from 'micro-bridge'

// set
Store.set('key', 'value')
// support path set
Store.set('object.key.key2', {})

// get
Store.get<string>('key')
Store.get('object.key.key2')

// get all data store
Store.getStore()

// scope data
Store.setWithScope('key', {}, 'some-scope')
Store.getWithScope<Record<string, any>>('key', 'some-scope')
methods
method description
Store.set 设定值
Store.get 获取值
Store.setWithScope 带标识符设定值(方便管理)
Store.getWithScope 带标识符获取值
Store.getScope 获取标识符下所有数据对象
Store.setScope 设定标识符下整个数据对象
Store.getStore 获取全部数据

StoreChange

StoreChange 被用于监听 Store 内数据的变化。

example
import { StoreChange } from 'micro-bridge'

StoreChange.$on((newStore) => {
  // ...
})
StoreChange.$on('path.key', (newValue, oldValue) => {
  // ...
})
methods
method description
StoreChange.$on 监听某个属性上的值变化,支持监听路径
StoreChange.$delete 删除某个监听函数
StoreChange.$destory 销毁该属性的所有监听

StoreBus

StoreBus 是一个事件总线。

example
import { StoreBus } from 'micro-bridge'

StoreBus.$emit('some-event', 'value')
StoreBus.$on('some-event', (value) => {
  // ...
})
methods
method description
StoreBus.$on 根据事件名监听某个事件
StoreBus.$emit 事件广播
StoreBus.$delete 移除某个正在监听的函数
StoreBus.$off 清空某个事件的所有监听函数

Other

注:无论在使用变化监听还是事件总线时,请留意在组件 unmount 时销毁或删除你的监听函数。

micro-bridge's People

Contributors

fz6m avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.