useFieldMetaList

• Category: Composables
• Relate: getFieldMetaListonFieldAddonFieldDeleteonFieldModify
• Dependencies: @lark-base-open/js-sdk
• Last Changed: 20 hours 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 { useFieldMetaList, useTable, useSelection } from "@qww0302/use-bitable"
import { FieldType } from "@lark-base-open/js-sdk"

const { tableId } = useSelection()
const { table } = useTable(tableId)
const { fieldMetaList, pending } = useFieldMetaList(table, {
  types: [FieldType.Text, FieldType.Number],
})
</script>

<template>
  <div>
    <p>Pending: {{ pending }}</p>
    <div style="overflow: auto; max-height: 200px">
      <ul>
        <li v-for="(fieldMeta, index) in fieldMetaList" :key="index">
          {{ fieldMeta.name }}[{{ fieldMeta.id }}](type: {{ fieldMeta.type }})
        </li>
      </ul>
    </div>
  </div>
</template>

Usage

Type Declarations

Show Type Declarations

import { FieldType } from "@lark-base-open/js-sdk"
import type { MaybeRefOrGetter } from "vue"
import type { ITable } from "@lark-base-open/js-sdk"
interface FieldMetaListOption {
  /**
   * Field types
   */
  types?: FieldType[]
}
export declare function useFieldMetaList(
  table: MaybeRefOrGetter<ITable | null>,
  option?: FieldMetaListOption,
): {
  fieldMetaList: import("vue").ComputedRef<
    (
      | import("@lark-base-open/js-sdk").IAttachmentFieldMeta
      | import("@lark-base-open/js-sdk").IAutoNumberFieldMeta
      | import("@lark-base-open/js-sdk").IBarcodeFieldMeta
      | import("@lark-base-open/js-sdk").IButtonUserFieldMeta
      | import("@lark-base-open/js-sdk").ICheckboxFieldMeta
      | import("@lark-base-open/js-sdk").ISingleLinkFieldMeta
      | import("@lark-base-open/js-sdk").ISingleSelectFieldMeta
      | import("@lark-base-open/js-sdk").IMultiSelectFieldMeta
      | import("@lark-base-open/js-sdk").IDuplexLinkFieldMeta
      | import("@lark-base-open/js-sdk").IDateTimeFieldMeta
      | import("@lark-base-open/js-sdk").ICurrencyFieldMeta
      | import("@lark-base-open/js-sdk").IFormulaFieldMeta
      | import("@lark-base-open/js-sdk").IGroupChatFieldMeta
      | import("@lark-base-open/js-sdk").ILocationFieldMeta
      | import("@lark-base-open/js-sdk").ILookupFieldMeta
      | import("@lark-base-open/js-sdk").ICreatedTimeFieldMeta
      | import("@lark-base-open/js-sdk").IModifiedTimeFieldMeta
      | import("@lark-base-open/js-sdk").ICreatedUserFieldMeta
      | import("@lark-base-open/js-sdk").IModifiedUserFieldMeta
      | import("@lark-base-open/js-sdk").INumberFieldMeta
      | import("@lark-base-open/js-sdk").IPhoneFieldMeta
      | import("@lark-base-open/js-sdk").IProgressFieldMeta
      | import("@lark-base-open/js-sdk").IRatingFieldMeta
      | import("@lark-base-open/js-sdk").ITextFieldMeta
      | import("@lark-base-open/js-sdk").IUrlFieldMeta
      | import("@lark-base-open/js-sdk").IUserFieldMeta
      | import("@lark-base-open/js-sdk").IEmailFieldMeta
      | import("@lark-base-open/js-sdk").IObjectFieldMeta
    )[]
  >
  pending: import("vue").Ref<boolean, boolean>
}