README

`@cohook/vue3`

Vue3 轻量级、渐进式数据缓存和跨组件通信方案

🎯 案例🎯
Counter

✨特性

支持数据缓存和共享
支持数据状态化，自动跟踪变化并更新，精准定位作用区间
读写分离，自定义Action去处理数据，灵活化组装实现逻辑复用
轻量，API简单化，类型提示友好
数据不可变
支持插件化拓展功能

📦 安装

yarn add @cohook/vue3

npm i @cohook/vue3

⚡快速开始

1. 定义一个Container

import createContainer from "@cohook/vue3"

const container = createContainer(0)

2. 定义Action

const inc = () => container.commit((draft) => void (draft.current += 1)
const dec = () => container.commit((draft) => void (draft.current -= 1)

3. 数据状态化和修改

<template>
  <div>
    <span>Hello,template: {{Math.random()}}</span>
    <span>count: {{accessor()}}</span>
    <button @click="inc">+</button>
    <button @click="dec">-</button>
  </div>
</template>

<script>
export default {
  data() {
    return {
      accessor: container.useMapDataToAccessor()
    }
  },
  methods: {
    inc,
    dec
  }
}
</script>

💡API

`createContainer(initialData [, option])`

createContainer作为容器工厂函数，接收初始数据initialData和可选的插件和共享等配置option 👉，返回一个容器对象container。

`container`

`container.getData()`

用于获取当前的容器数据，就像是一个内置的action，可在任何地方使用。

`container.useMapDataToAccessor(...overloads)`

用于将数据状态化，被状态化后的数据会自动跟踪变化并更新。

const accessor = container.useMapDataToAccessor()
- 不带参数，直接将data状态化(返回状态存取器)，
- 容器内任意数据变化时直接更新
const derivedAccessor = container.useMapDataToAccessor(mapStateFn)
- mapStateFn以data作为参数，可自定义返回的需要状态化(返回派生状态存取器)的数据
- 容器内对应状态化数据变化时才会更新，精准定位更新区间

`container.commit(updater)`

commit 接受一个函数updater（immer中的produce的第二个参数保持一致）作为参数，用来创建修改数据的Action，可灵活组合容器对象提供的方法来组装Action。

const dec = () => {
  const count = container.getData()
  if(count < 0) return
  container.commit((draft) => void (draft.current -= 1)
}

Usage no npm install needed!

README

@cohook/vue3

✨特性