onFieldAdd

• Category: Events
• Relate: onFieldAdd
• Dependencies: @lark-base-open/js-sdk
• Last Changed: 2 weeks ago

Notice

This function needs to use in Base, please use this website as a plugin in a Base to see the demo.

Demo

Source

Show demo code

demo.vue

<script setup lang="ts">
import { onFieldAdd, useSelection } from "@qww0302/use-bitable"
import type { IEventCbCtx } from "@lark-base-open/js-sdk"
import { ref } from "vue"

const { tableId } = useSelection()
const ev = ref<IEventCbCtx>()
onFieldAdd(tableId, (e) => {
  ev.value = e
})
</script>

<template>
  <div>
    Try to add a field:
    <span v-if="ev">You have added a field, its id is {{ ev.data.fieldId }} and type is {{ ev.data.fieldType }}. </span>
    <pre>{{ JSON.stringify(ev, null, 2) }}</pre>
  </div>
</template>

Usage

Type Declarations

import { type ITable, type IEventCbCtx } from "@lark-base-open/js-sdk"
import { MaybeRefOrGetter } from "vue"
/**
 * Listen to field add event
 *
 * 监听字段增加事件
 *
 * @param table
 * @param callback
 * @returns
 */
export declare function onFieldAdd(
  table: MaybeRefOrGetter<ITable | string | null>,
  callback: (ev: IEventCbCtx<unknown>) => void,
): {
  off: () => void
  pending: import("vue").Ref<boolean>
}