useData

• Category: Composables
• Relate: getDatasetData
• Dependencies: @lark-base-open/js-sdk
• Last Changed: yesterday

提示

该函数需要在一个多维表格中使用，请将本文档作为一个插件在多维表格上使用以查看演示。

WARNING

该函数是对多维表格的 getData 和 setData API的封装，但当前多维表格暂未支持这两个 API，因此该函数暂时无法使用。

演示

Source

显示演示代码

demo.vue

<script setup lang="ts">
import { useData } from "@qww0302/use-bitable"
import { ref } from "vue"

const { data } = useData()
const i = ref("test")
// const data = ref()

const click = () => {
  data.value = i.value

}

</script>

<template>
  <div>
    <input v-model="i">
    <button @click="click">
      click
    </button>
    <p>{{ data }}</p>
  </div>
</template>

用法

类型声明

import { MaybeRefOrGetter, type Ref } from "vue"
export interface Serializer<T = unknown, R = unknown> {
  read: (raw: R) => T
  write: (data: T) => R
}
/**
 * useData options
 *
 * useData 配置项
 */
interface useDataOptions<T = unknown, R = unknown> {
  /**
   * Serialization
   *
   * 序列化
   */
  serializer?: Serializer<T, R>
  /**
   * Whether to shallowly watch for changes
   *
   * 是否浅层监听变化
   *
   * @default false
   */
  shallow?: boolean
}
/**
 * Reactive Bitable data
 *
 * 响应式的 Bitable 数据
 *
 * @param options
 * @returns
 */
export declare function useData<T = unknown, R = T>(
  key: MaybeRefOrGetter<string>,
  defaults?: T,
  options?: useDataOptions<T, R>,
): {
  data: Ref<T, T>
  pending: Ref<boolean, boolean>
}