Base JS SDK

https://lark-base-team.github.io/js-sdk-docs/zh/
Admin
Base JS SDK provides documentation and tools to help developers easily create and integrate plugins...
Tokens:99,423
Snippets:1,090
Trust Score:8.3
Update:4 months ago
Show doc for...
Tokens:
Raw
### Get Theme Example

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/bridge

Example of retrieving the current theme and logging it to the console.

```typescript
const theme = await bitable.bridge.getTheme();
// 'LIGHT'
```

```typescript
const theme = await bitable.bridge.getTheme();
// 'LIGHT'
```

--------------------------------

### Example: Get List of All Fields

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/table

Shows how to obtain a list of all fields in a table, with an example of specifying the expected field type.

```typescript
const fieldList = await table.getFieldList();
```

--------------------------------

### Example: Get Attachment Fields

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/table

Example of how to use `getFieldListByType` to get all attachment fields.

```typescript
// 获取 table 下所有的附件字段
const attachmentFieldList = await table.getFieldListByType<IAttachmentField>(FieldType.Attachment);
```

```typescript
// 获取 table 下所有的附件字段
const attachmentFieldList = await table.getFieldListByType<IAttachmentField>(FieldType.Attachment);
```

--------------------------------

### Example: Get Table Metadata

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/table

Demonstrates how to call the `getMeta` method to fetch table metadata.

```typescript
const meta = await table.getMeta();
```

--------------------------------

### Get Plugin Data Examples

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/bridge

Illustrates retrieving string, number, and object data previously stored with setData.

```typescript
await bitable.bridge.getData('test_key1') // 'hello world'
await bitable.bridge.getData('test_key2') // 1
await bitable.bridge.getData('test_key3') // { key: 'value' }
```

```typescript
await bitable.bridge.getData('test_key1') // 'hello world'
await bitable.bridge.getData('test_key2') // 1
await bitable.bridge.getData('test_key3') // { key: 'value' }
```

--------------------------------

### Example: Add and Configure a Field

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/table

Demonstrates adding a new single-select field and then adding an option to it. It's recommended to specify the field type when getting the field for better type hinting.

```typescript
const field = await table.addField({ type: FieldType.SingleSelect });
const singleSelectField = await table.getField<ISingleSelectField>(field);
await singleSelectField.addOption('Option1');
```

```typescript
const field = await table.addField({ type: FieldType.SingleSelect });
const singleSelectField = await table.getField<ISingleSelectField>(field);
await singleSelectField.addOption('Option1');
```

--------------------------------

### Example: Get Table Name

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/table

Demonstrates how to call the `getName` method to retrieve the table's name.

```typescript
const name = await table.getName();
```

--------------------------------

### Theme Change Listener Example

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/bridge

Example of setting up a listener for theme changes and logging the new theme mode to the console.

```typescript
const theme = await bitable.bridge.onThemeChange((event) => {
  console.log('theme change', event.data.theme);
});
```

```typescript
const theme = await bitable.bridge.onThemeChange((event) => {
  console.log('theme change', event.data.theme);
});
```

--------------------------------

### Example: Get Field Metadata by ID

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/table

Illustrates how to fetch the metadata for a field using its ID and provides an example of the returned metadata structure.

```typescript
const fieldMeta = await table.getFieldMetaById('f_id');
// { id: 'f_id', name: 'text field', type: 1, isPrimary: true, description: { content: content, disableSyncToFormDesc: false } }
```

--------------------------------

### Example: Get CreateUser Field Value

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/field/createUser

Demonstrates how to call the `getValue` method to fetch the creator's information for a given record ID.

```typescript
await createUserField.getValue('r_id');
```

--------------------------------

### Generate Bitable URL Example

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/bridge

Example of generating a Bitable URL with specified table, view, and field IDs.

```typescript
const res = await bitable.bridge.getBitableUrl({
  tableId: 'tblkrAjKK1wEP4Nf',
  viewId: 'vewboZNrq3',
  fieldId: 'fldfd2ITyJ',
});
// 'https://bytedance.feishu.cn/base/QtTUxxxx?field=fldfd2ITyJ&table=tblkrAjKK1wEP4Nf&view=vewboZNrq3'
```

```typescript
const res = await bitable.bridge.getBitableUrl({
  tableId: 'tblkrAjKK1wEP4Nf',
  viewId: 'vewboZNrq3',
  fieldId: 'fldfd2ITyJ',
});
// 'https://bytedance.feishu.cn/base/QtTUxxxx?field=fldfd2ITyJ&table=tblkrAjKK1wEP4Nf&view=vewboZNrq3'
```

--------------------------------

### Example: Handling Field Add Event

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/table

Example of setting up a listener for the `onFieldAdd` event and then adding a new text field.

```typescript

const off = table.onFieldAdd((event) => {
  console.log('event:', event);
})
const fieldId = await table.addField({ // 新增一个多行文本类型的字段
  type: FieldType.Text,
  name: 'field_test'
})
```

```typescript

const off = table.onFieldAdd((event) => {
  console.log('event:', event);
})
const fieldId = await table.addField({ // 新增一个多行文本类型的字段
  type: FieldType.Text,
  name: 'field_test'
})
```

--------------------------------

### Example: Get List of Field IDs

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/table

Demonstrates fetching the unordered list of field IDs present in the table.

```typescript
const fieldIdList = await table.getFieldIdList();
```

--------------------------------

### Example: Getting Record by ID

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/table

Demonstrates fetching a record by its ID. It first retrieves a list of all record IDs and then uses the first ID in the list to get the record's value.

```typescript
const recordIdList = await table.getRecordIdList(); // 获取 recordId 列表

const recordValue = await table.getRecordById(recordIdList[0]);
```

```typescript
const recordIdList = await table.getRecordIdList(); // 获取 recordId 列表

const recordValue = await table.getRecordById(recordIdList[0]);
```

--------------------------------

### Data Change Listener Example

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/bridge

Example of setting up a listener for data changes and then triggering a data change with setData.

```typescript
bridge.onDataChange((event) => {
  console.log('data change', event.data);
})

bridge.setData('test_key', 233);
```

```typescript
bridge.onDataChange((event) => {
  console.log('data change', event.data);
})

bridge.setData('test_key', 233);
```

--------------------------------

### Example: Get Field ID

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/cell

An example demonstrating how to get the field ID of a given cell.

```typescript
const fieldId = cell.getFieldId();
```

--------------------------------

### Example: Retrieve Cell Value

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/cell

An example showing how to retrieve a cell from a record or field and then get its value using the getValue method.

```typescript
const cell = await field.getCell(recordOrId);
const value = await cell.getValue();
```

--------------------------------

### Example: Add a New Table

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/base

Provides an example of how to use the addTable method to create a new data table with a specified name.

```typescript
const { tableId, index } = await bitable.base.addTable({
    name: '测试添加数据表'
})
```

```typescript
const { tableId, index } = await bitable.base.addTable({
    name: '测试添加数据表'
})
```

--------------------------------

### Example: Get Field Metadata

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/table

Example of how to call `getFieldMetaList` to retrieve field metadata.

```typescript
const fieldMetaList = await table.getFieldMetaList();
```

```typescript
const fieldMetaList = await table.getFieldMetaList();
```

--------------------------------

### Example: Get Field by ID or Name

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/table

Shows how to retrieve a field, such as an attachment field, by providing its ID or name and specifying the type.

```typescript
const field = await table.getField<IAttachmentField>(idOrName);
```

--------------------------------

### Example: Get Attachment Field Metadata

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/table

Example of how to use `getFieldMetaListByType` to get metadata for all attachment fields.

```typescript
// 获取 table 下所有的附件字段的 Meta 列表
const attachmentFieldMetaList = await table.getFieldMetaListByType<IAttachmentFieldMeta>(FieldType.Attachment)
```

```typescript
// 获取 table 下所有的附件字段的 Meta 列表
const attachmentFieldMetaList = await table.getFieldMetaListByType<IAttachmentFieldMeta>(FieldType.Attachment)
```

--------------------------------

### Example: Getting Cell Value

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/table

Illustrates how to get the value of a cell by first obtaining the current selection's fieldId and recordId, then calling getCellValue.

```typescript
// 光标选中数据表中的单元格
const { fieldId, recordId } = await bitable.base.getSelection();
const cellValue = table.getCellValue(fieldId, recordId);
```

```typescript
// 光标选中数据表中的单元格
const { fieldId, recordId } = await bitable.base.getSelection();
const cellValue = table.getCellValue(fieldId, recordId);
```

--------------------------------

### Example: Get Field by Name

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/table

Illustrates fetching a field, such as an attachment field, by its name, including type specification.

```typescript
const field = await table.getFieldByName<IAttachmentField>(idOrName);
```

--------------------------------

### Example Usage of getRecordIdList

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/table

Demonstrates how to get a list of record IDs using the deprecated getRecordIdList method.

```typescript
const recordIdList = await table.getRecordIdList();
```

--------------------------------

### Example: Get TextField Cell

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/field/text

Shows how to fetch a cell's value from a text field using a record object.

```typescript
const table = await bitable.base.getActiveTable();
const recordList = await table.getRecordList();

const cell = await textField.getCell(recordList[0]);
```

--------------------------------

### Example Usage of getRecords

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/table

Demonstrates how to fetch records using the getRecords method after obtaining the active table.

```typescript
// 首先使用 getActiveTable 方法获取了当前用户选择的 table（用户当前编辑的数据表）
const table = await bitable.base.getActiveTable();
const records = await table.getRecords({
  pageSize: 200
})
```

--------------------------------

### Example: Delete a Table

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/base

Provides an example of how to delete the currently active table using its ID.

```typescript
const table = await bitable.base.getActiveTable();

await bitable.base.deleteTable(table.id);
```

```typescript
const table = await bitable.base.getActiveTable();

await bitable.base.deleteTable(table.id);
```

--------------------------------

### Get Base User ID Example

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/bridge

Example of calling the getBaseUserId function to retrieve a unique user identifier.

```typescript
const res = await bitable.bridge.getBaseUserId();
```

```typescript
const res = await bitable.bridge.getBaseUserId();
```

--------------------------------

### Example: Get Field by ID

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/table

Demonstrates retrieving a field, like an attachment field, by its ID, with type assertion for better IntelliSense.

```typescript
const field = await table.getFieldById<IAttachmentField>(idOrName);
```

--------------------------------

### Example: Modify Cell Value

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/cell

An example demonstrating how to create a cell and then modify its value using the setValue method.

```typescript
const cell = await textField.createCell('test');
cell.setValue('modify value');
```

--------------------------------

### Example: Get CreateUser Field Cell

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/field/createUser

Demonstrates how to call the `getCell` method to obtain the cell object for the creator field for a specific record ID.

```typescript
await createUserField.getCell('r_id');
```

--------------------------------

### Example: Get ModifiedUser Value

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/field/modifiedUser

Demonstrates how to call the `getValue` method to retrieve the ModifiedUser field's data for a given record ID.

```typescript
await modifiedUserField.getValue('r_id');
```

--------------------------------

### Get Active Table and Attachment Fields

Source: https://lark-base-team.github.io/js-sdk-docs/zh/start/core

This snippet demonstrates how to get the active table and a list of attachment fields using the bitable SDK. Ensure the SDK is imported before use.

```typescript
import { bitable } from '@lark-base-open/js-sdk'
const table = await bitable.base.getActiveTable();
const attachmentFieldList = await table.getFieldListByType<IAttachmentField>(FieldType.Attachment);
```

--------------------------------

### Example Usage of getCellAttachmentUrls

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/table

Demonstrates how to fetch attachment URLs for multiple tokens, a specific field, and record.

```typescript
const urls = await table.getCellAttachmentUrls(['token_1', 'token_2'], 'f_id', 'r_id');
```

--------------------------------

### Example Usage of getCellThumbnailUrls

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/table

Demonstrates fetching thumbnail URLs for attachments with a specified maximum quality.

```typescript
const urls = await table.getCellThumbnailUrls(['token_1', 'token_2'], 'f_id', 'r_id', ImageQuality.MAX);
```

--------------------------------

### Example: Get UrlField Cell

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/field/url

Shows how to obtain a UrlField's cell value by fetching the record ID list and then selecting the first record's ID.

```typescript
const recordIdList = await table.getRecordIdList();

const cell = await urlField.getCell(recordIdList[0]);
```

--------------------------------

### Example: Check if Field Exists

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/table

Demonstrates how to use `isFieldExist` to verify if a field is present in the table.

```typescript
const isExist = await table.isFieldExist('fieldId');
```

--------------------------------

### Get User ID Example

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/bridge

Example of calling the deprecated getUserId function.

```typescript
const res = await bitable.bridge.getUserId();
```

```typescript
const res = await bitable.bridge.getUserId();
```

--------------------------------

### getEnv

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/bridge

Fetches the current environment information, including the product type.

```APIDOC
## getEnv

### Description
Fetches the current environment information, including the product type.

### Method
GET (assumed, as it's a retrieval operation)

### Endpoint
/bridge/getEnv

### Parameters
None

### Response
#### Success Response (200)
- **env** (Env) - An object containing environment details.

### Type Definition
```typescript
type Product = 'lark' | 'feishu';
interface Env {
  product: Product;
}
```

### Response Example
```json
{
  "env": {
    "product": "feishu"
  }
}
```
```

--------------------------------

### Example: Modify Table Name

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/base

Demonstrates how to use the setTable method to change the name of an existing data table.

```typescript
const tableId = await bitable.base.setTable({
    name: '修改数据表'
})
```

```typescript
const tableId = await bitable.base.setTable({
    name: '修改数据表'
})
```

--------------------------------

### Get Sort Information

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/view/gallery

Retrieves the current sorting configuration applied to the gallery view.

```typescript
getSortInfo(): Promise<ISortInfo[]>;

```

--------------------------------

### Get Tenant Key

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/bridge

Retrieves the unique identifier for the current tenant. This is essential for multi-tenant applications.

```typescript
getTenantKey(): Promise<string>;
```

```typescript
await bitable.bridge.getTenantKey();
```

--------------------------------

### Set Plugin Data Examples

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/bridge

Demonstrates how to store different types of data (string, number, object) using the setData function.

```typescript
await bitable.bridge.setData('test_key1', 'hello world');
await bitable.bridge.setData('test_key2', 1);
await bitable.bridge.setData('test_key3', { key: 'value' });
```

```typescript
await bitable.bridge.setData('test_key1', 'hello world');
await bitable.bridge.setData('test_key2', 1);
await bitable.bridge.setData('test_key3', { key: 'value' });
```

--------------------------------

### Example: Create Text and URL Cells

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/field/text

Demonstrates creating cells for both plain text and URL segments within a text field.

```typescript
// text segment
await textField.createCell('test');
// URL segment
await textField.createCell('https://www.feishu.cn');
```

--------------------------------

### Example: Batch Upload File

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/base

Demonstrates how to upload a single file using batchUploadFile. The returned token can be used to set attachment fields. File name length must not exceed 250 characters, and file size must not exceed 2GB.

```typescript
// 文件上传限制
// file name 长度不得大于 250
// file size 不得大于 1024 * 1024 * 1024 * 2

const file = new File(['Hello, World!'], 'hello.txt', { type: 'text/plain' });
const tokens =await bitable.base.batchUploadFile([file]); // 拿到的 token 可以用于设置附件字段
console.log(tokens) // ['BcdqbMmW4ohD7ExUq9rcGtuVn8e']
```

```typescript
// 文件上传限制
// file name 长度不得大于 250
// file size 不得大于 1024 * 1024 * 1024 * 2

const file = new File(['Hello, World!'], 'hello.txt', { type: 'text/plain' });
const tokens =await bitable.base.batchUploadFile([file]); // 拿到的 token 可以用于设置附件字段
console.log(tokens) // ['BcdqbMmW4ohD7ExUq9rcGtuVn8e']
```

--------------------------------

### navigateToExtension

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/bridge

Navigates to a specified plugin by its ID. Requires user authorization and may return false on failure or denial.

```APIDOC
## navigateToExtension

### Description
Navigates to a specified plugin by its ID. Requires user authorization and may return false on failure or denial.

### Method
POST (assumed, as it involves an action and a parameter)

### Endpoint
/bridge/navigateToExtension

### Parameters
#### Query Parameters
- **extensionId** (string) - Required - The ID of the extension to navigate to.

### Request Example
```json
{
  "extensionId": "xxx_id"
}
```

### Response
#### Success Response (200)
- **success** (boolean) - True if navigation was successful, false otherwise.

### Response Example
```json
{
  "success": true
}
```
```

--------------------------------

### Get Filter Information

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/view/gallery

Retrieves the current filter configuration for the gallery view. Returns null if no filters are applied.

```typescript
getFilterInfo(): Promise<IFilterInfo | null>;

```

--------------------------------

### Example: Get TextField Cell Value

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/field/text

Illustrates fetching the value of a text field cell using its record ID.

```typescript
const table = await bitable.base.getActiveTable();
const recordIdList = await table.getRecordIdList();

const cellValue = await textField.getValue(recordIdList[0]);
```

--------------------------------

### Get Kanban View Type

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/view/kanban

Retrieves the type of the current view, which should be Kanban. This is a promise-based asynchronous operation.

```typescript
getType(): Promise<ViewType.Kanban>;
```

--------------------------------

### Example: Set TextField Value

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/field/text

Demonstrates how to modify the content of a text field cell using a record ID.

```typescript
const table = await bitable.base.getActiveTable();
const recordIdList = await table.getRecordIdList();

await textField.setValue(recordIdList[0], 'modify value');
```

--------------------------------

### Example: Query Field Edit Permission

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/base

Demonstrates how to check for field edit permissions using the getPermission method. Ensure necessary imports are included.

```typescript
import { PermissionEntity, OperationType } from '@lark-base-open/js-sdk';

const fieldInfo: FieldPermissionParams = {
  entity: PermissionEntity.Field,
  param: {
    tableId,
    fieldId,
  },
  type: OperationType.Editable,
}
const hasPermission = await base.getPermission(params);
```

```typescript
import { PermissionEntity, OperationType } from '@lark-base-open/js-sdk';

const fieldInfo: FieldPermissionParams = {
  entity: PermissionEntity.Field,
  param: {
    tableId,
    fieldId,
  },
  type: OperationType.Editable,
}
const hasPermission = await base.getPermission(params);
```

--------------------------------

### Get Environment Information

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/bridge

Fetches information about the current operating environment, including the product type (e.g., 'lark' or 'feishu').

```typescript
getEnv(): Promise<Env>;
```

```typescript
type Product = 'lark' | 'feishu';
interface Env {
  product: Product;
}
```

```typescript
const env = await bitable.bridge.getEnv();
// { product: 'feishu' }
```

--------------------------------

### Create Cell and Add Record (Attachment Field Example)

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/field

Demonstrates creating a cell for an attachment field and then adding a new record to the table with that cell.

```APIDOC
## Create Cell and Add Record (Attachment Field Example)

### Description
Demonstrates creating a cell for an attachment field and then adding a new record to the table with that cell.

### Method
`createCell(file: File): Promise<Cell>`
`addRecord(cell: Cell): Promise<Record>`

### Parameters
#### createCell Parameters
- **file** (File) - Required - The file to be attached.

#### addRecord Parameters
- **cell** (Cell) - Required - The cell containing the attachment data.

### Request Example
```typescript
const attachmentCell = await attachmentField.createCell(imageFile);
await table.addRecord(attachmentCell);
```
```

--------------------------------

### Example: Get UrlField Cell Value

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/field/url

Demonstrates retrieving the value of a UrlField cell for a specific record, after obtaining the record ID.

```typescript
const recordIdList = await table.getRecordIdList();

await urlField.getValue(recordIdList[0]);
```

--------------------------------

### Get Active Table

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/guide

Retrieve the currently selected table in the active view. This is a common starting point for most data manipulation operations.

```typescript
import { bitable } from '@lark-base-open/js-sdk';

const table = await bitable.base.getActiveTable();
```

```typescript
import { bitable } from '@lark-base-open/js-sdk';

const table = await bitable.base.getActiveTable();
```

--------------------------------

### 新版本添加附件数据记录

Source: https://lark-base-team.github.io/js-sdk-docs/zh/update

在新版本中，添加附件数据记录的流程得到优化。首先获取附件字段，然后通过 createCell 方法创建附件单元格，最后通过 addRecord 方法插入记录。

```typescript
const attachmentField = await table.getField<IAttachmentField>(attachmentFieldId);
const attachmentCell = await attachmentField.createCell(File);
const recordId = await table.addRecord(attachmentCell);
```

```typescript
const attachmentField = await table.getField<IAttachmentField>(attachmentFieldId);
const attachmentCell = await attachmentField.createCell(File);
const recordId = await table.addRecord(attachmentCell);
```

--------------------------------

### Example: Get ModifiedUser Cell

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/field/modifiedUser

Demonstrates how to call the `getCell` method to retrieve the cell object for the ModifiedUser field for a given record ID.

```typescript
await modifiedUserField.getCell('r_id');
```

--------------------------------

### Navigate to Extension

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/bridge

Navigates the user to a specified extension (plugin) by its ID. This action requires user authorization and may return false if authorization is denied or navigation fails.

```typescript
navigateToExtension(extensionId: string): Promise<boolean>;
```

```typescript
await bitable.bridge.navigateToExtension('xxx_id');
```

--------------------------------

### Example: Create UrlField Cell

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/field/url

Demonstrates creating a UrlField cell with a provided URL. The SDK handles the conversion to a hyperlink.

```typescript
const cell = await urlField.createCell('https://lark-base-team.github.io/js-sdk-docs');
```

--------------------------------

### Get Attachment Value Example

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/field/attachment

Retrieves all attachment values for a specified record in an attachment field. The returned value is an array of attachment objects.

```typescript
const table = await bitable.base.getActiveTable();
const attachmentField = await table.getField<IAttachmentField>(fieldId);
const val = await attachmentField.getValue(recordId);
```

--------------------------------

### Kanban View Methods

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/view/kanban

Provides methods for interacting with Kanban views, such as getting names, types, metadata, and managing fields.

```APIDOC
## KanbanView

### Description
Represents a Kanban view within the Lark Base.

### Methods

#### `getName()`
- **Description**: Retrieves the name of the Kanban view.
- **Returns**: `Promise<string>` - The name of the view.

#### `getType()`
- **Description**: Retrieves the type of the view, which is always `ViewType.Kanban` for Kanban views.
- **Returns**: `Promise<ViewType.Kanban>` - The view type.

#### `getMeta()`
- **Description**: Retrieves the metadata for the Kanban view.
- **Returns**: `Promise<IKanbanViewMeta>` - The Kanban view's metadata.

#### `showField(fieldId: string | string[])`
- **Description**: Makes specified fields visible in the Kanban view.
- **Parameters**:
  - `fieldId` (string | string[]) - The ID or an array of IDs of the fields to show.
- **Returns**: `Promise<boolean>` - True if the fields were successfully shown, false otherwise.

#### `hideField(fieldId: string | string[])`
- **Description**: Hides specified fields in the Kanban view.
- **Parameters**:
  - `fieldId` (string | string[]) - The ID or an array of IDs of the fields to hide.
- **Returns**: `Promise<boolean>` - True if the fields were successfully hidden, false otherwise.

#### `getFieldMetaList()`
- **Description**: Retrieves a list of metadata for all fields in the Kanban view, in the order they are displayed.
- **Returns**: `Promise<IFieldMeta[]>` - An array of field metadata.

#### `getVisibleRecordIdList()`
- **Description**: Retrieves a list of IDs for all records that are currently visible in the Kanban view.
- **Returns**: `Promise<(string | undefined)[]>` - An array of visible record IDs.

#### `getVisibleFieldIdList()`
- **Description**: Retrieves a list of IDs for all fields that are currently visible in the Kanban view.
- **Returns**: `Promise<string[]>` - An array of visible field IDs.

#### `applySetting()`
- **Description**: Submits view settings such as grouping, filtering, and sorting, synchronizing them with other users.
- **Returns**: `Promise<void>`
```

--------------------------------

### Get Cell String Value

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/table

Retrieves the raw string representation of a cell's value. For example, a date field will return a 'YYYY/MM/DD' string.

```typescript
getCellString(fieldId: string, recordId: string): Promise<string>;
```

```typescript
const recordIds = await table.getRecordIdList();
const dateTimeField = await table.getField('日期');

const res = await table.getCellString(dateTimeField.id, recordIds[0]); 
// 2023/10/01
```

--------------------------------

### Example: Listening to Field Modifications

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/table

Demonstrates how to subscribe to field modification events, add a new text field, and then modify an existing field. The callback logs event details.

```typescript

const off = table.onFieldModify((event) => {
  console.log('field modify:', event);
})

const fieldId = await table.addField({ // 新增一个多行文本类型的字段
  type: FieldType.Text,
  name: 'field_test'
})

const fieldId = await table.setField({ // 修改字段名称
  name: 'field_modified'
})
```

```typescript

const off = table.onFieldModify((event) => {
  console.log('field modify:', event);
})

const fieldId = await table.addField({ // 新增一个多行文本类型的字段
  type: FieldType.Text,
  name: 'field_test'
})

const fieldId = await table.setField({ // 修改字段名称
  name: 'field_modified'
})
```

--------------------------------

### applySetting

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/view/calendar

Submits the current view settings (grouping, filtering, sorting) to synchronize them with other users.

```APIDOC
## applySetting

### Description
Submits the current view settings (grouping, filtering, sorting) to synchronize them with other users.

### Method
POST

### Endpoint
/api/view/calendar/{id}/settings/apply
```

--------------------------------

### Example: Advanced Permissions Scenario

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/base

Shows how to check specific record edit permissions in advanced scenarios by changing the entity type to Record.

```typescript
// 示例：高级权限场景下，检查 Table 实体的 editable 权限，可将 entity 改为 Record 
const hasPermission = await base.getPermission({
  entity: PermissionEntity.Record,
  param: {
    tableId,
  },
  type: OperationType.Editable,
});
```

```typescript
// 示例：高级权限场景下，检查 Table 实体的 editable 权限，可将 entity 改为 Record 
const hasPermission = await base.getPermission({
  entity: PermissionEntity.Record,
  param: {
    tableId,
  },
  type: OperationType.Editable,
});
```

--------------------------------

### 新版本新增单选字段选项

Source: https://lark-base-team.github.io/js-sdk-docs/zh/update

在新版本中，设置字段属性更加方便，例如可以先获取对应字段，然后调用该字段特有的方法来新增选项。

```typescript
const singleSelectField = await table.getField<ISingleSelectField>(singleSelectFieldId);
await singleSelectField.addOption('option1');
```

```typescript
const singleSelectField = await table.getField<ISingleSelectField>(singleSelectFieldId);
await singleSelectField.addOption('option1');
```

--------------------------------

### Example: Listen for Table Add Event

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/base

Logs 'table added' to the console when a table is added. The returned function `off` can be called to stop listening.

```typescript
const off = bitable.base.onTableAdd((event) => {
  console.log('table added')
})
```

```typescript
const off = bitable.base.onTableAdd((event) => {
  console.log('table added')
})
```

--------------------------------

### getOptions

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/field/multipleSelect

Retrieves all available options for a multi-select field.

```APIDOC
## getOptions

### Description
Retrieves all available options for a multi-select field.

### Method
GET (assumed based on SDK method name)

### Endpoint
`/field/multipleSelect/options` (inferred)

### Response
#### Success Response (200)
- **options** (array) - An array of option objects, each with an `id` and `name`.

### Response Example
```json
{
  "options": [
    {
      "id": "option1_id",
      "name": "Option 1"
    },
    {
      "id": "option2_id",
      "name": "Option 2"
    }
  ]
}
```
```

--------------------------------

### Get Active Table

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/table

Retrieves the currently selected table instance. This is the primary way to get a table object for further operations.

```APIDOC
## Get Active Table

### Description
Retrieves the currently selected table instance. This is the primary way to get a table object for further operations.

### Method
`bitable.base.getActiveTable()`

### Endpoint
N/A (SDK Method)

### Response
#### Success Response
- **table** (Table) - The active table instance.

### Response Example
```typescript
const table = await bitable.base.getActiveTable()
```
```

--------------------------------

### Example: Listening to Field Deletions

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/table

Demonstrates subscribing to field deletion events, adding a text field, and then deleting it. The callback logs event details upon deletion.

```typescript

const off = table.onFieldDelete((event) => {
  console.log('field delete', event);
})

const fieldId = await table.addField({ // 新增多行文本类型的字段
  type: FieldType.Text,
  name: 'field_test'
})

table.deleteField(fieldId) // 删除字段
```

```typescript

const off = table.onFieldDelete((event) => {
  console.log('field delete', event);
})

const fieldId = await table.addField({ // 新增多行文本类型的字段
  type: FieldType.Text,
  name: 'field_test'
})

table.deleteField(fieldId) // 删除字段
```

--------------------------------

### Get ModifiedTime Value

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/field/modifiedTime

Retrieves the update timestamp for a specific record or cell. Use this to get the current update time of a record.

```typescript
await modifiedTimeField.getValue('r_id');
```

--------------------------------

### getOptions

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/field/singleSelect

Retrieves all available options for the single-select field.

```APIDOC
## getOptions

### Description
Retrieves all options for the single-select field.

### Method
`getOptions`

### Response
- **Array<ISelectFieldOption>** - An array of option objects, each containing id, name, and color.

### Example
```typescript
await singleSelectField.getOptions();
```
```

--------------------------------

### Get Active Table Instance

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/table

Retrieves the currently selected data table instance. This is the primary way to get a table object for further operations.

```typescript
const table = await bitable.base.getActiveTable()
```

--------------------------------

### getActiveTable

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/base

Gets the currently selected data table.

```APIDOC
## getActiveTable

### Description
Gets the currently selected data table (`table`).

### Method
`getActiveTable: () => Promise<ITable>;`

### Example
```typescript
const table = await base.getActiveTable();
```
```

--------------------------------

### Get Table Name

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/table

Retrieves the name of the data table.

```APIDOC
## Get Table Name

### Description
Retrieves the name of the data table.

### Method
`table.getName()`

### Response
#### Success Response
- **name** (string) - The name of the table.

### Request Example
```typescript
const name = await table.getName();
```
```

--------------------------------

### getType

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/view/calendar

Gets the type of the current view, which is always CalendarView.

```APIDOC
## getType

### Description
Gets the type of the current view, which is always CalendarView.

### Method
GET

### Endpoint
/api/view/calendar/{id}/type

### Response
#### Success Response (200)
- **type** (ViewType.Calendar) - The type of the view.
```

--------------------------------

### Get Table Name

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/table

Asynchronously retrieves the name of the data table.

```typescript
getName: () => Promise<string>;
```

--------------------------------

### Example: Listen for Table Delete Event

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/base

Logs 'table deleted' to the console when a table is deleted. The returned function `off` can be called to stop listening.

```typescript
const off = bitable.base.onTableDelete((event) => {
  console.log('table deleted')
})
```

```typescript
const off = bitable.base.onTableDelete((event) => {
  console.log('table deleted')
})
```

--------------------------------

### Get Field Width

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/view/grid

Retrieves the current width of a specified field.

```typescript
getFieldWidth(fieldId: string): Promise<number>;
```

```typescript
getFieldWidth(fieldId: string): Promise<number>;
```

--------------------------------

### showToast

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/ui

Displays a global message prompt. A message is displayed globally when this API is called. It accepts an options object with a message and an optional toast type.

```APIDOC
## showToast

### Description
Displays a global message prompt. A message is displayed globally when this API is called.

### Method
`showToast(options: ShowToastOptions): Promise<boolean>`

### Parameters
#### Request Body
- **options** (object) - Required - Configuration for the toast message.
  - **message** (string) - Required - The message content to display.
  - **toastType** (ToastType) - Optional - The type of toast (info, success, warning, error, loading).

### Types
```typescript
enum ToastType {
  info = 'info',
  success = 'success',
  warning = 'warning',
  error = 'error',
  loading = 'loading',
}

interface ShowToastOptions {
  toastType?: ToastType,
  message: string,
}
```

### Response
#### Success Response (boolean)
- `true` if the toast was shown successfully, `false` otherwise.

### Request Example
```typescript
await bitable.ui.showToast({
  toastType: ToastType.info,
  message: 'hello world'
});
```
```

--------------------------------

### Get Group Information

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/view/grid

Retrieves the current grouping configuration for the grid.

```typescript
getGroupInfo(): Promise<IGroupInfo[]>;
```

```typescript
getGroupInfo(): Promise<IGroupInfo[]>;
```

--------------------------------

### switchToView

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/ui

Switches to a specified view within a given table. The view must belong to the table; otherwise, the call will fail. It returns a promise that resolves to a boolean indicating success.

```APIDOC
## switchToView

### Description
Switches to a specified view within a given table. The view must belong to the table; otherwise, the call will fail.

### Method
`switchToView(tableId: string, viewId: string): Promise<boolean>`

### Parameters
#### Path Parameters
- **tableId** (string) - Required - The ID of the table.
- **viewId** (string) - Required - The ID of the view to switch to.

### Response
#### Success Response (boolean)
- `true` if the switch was successful, `false` otherwise.

### Request Example
```typescript
await bitable.ui.switchToView('table_id', 'view_id');
```
```

--------------------------------

### Get Sort Information

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/view/grid

Retrieves the current sorting configuration for the grid.

```typescript
getSortInfo(): Promise<ISortInfo[]>;
```

```typescript
getSortInfo(): Promise<ISortInfo[]>;
```

--------------------------------

### getVisibleFieldIdList

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/view/calendar

Gets a list of IDs for all fields currently visible in the calendar view.

```APIDOC
## getVisibleFieldIdList

### Description
Gets a list of IDs for all fields currently visible in the calendar view.

### Method
GET

### Endpoint
/api/view/calendar/{id}/fields/visible/ids

### Response
#### Success Response (200)
- **visibleFieldIdList** (string[]) - An array of visible field IDs.
```

--------------------------------

### Example: Listen for Selection Change Event

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/base

Logs the current selection event data to the console when the selection changes. The returned function `off` can be called to stop listening.

```typescript
const off = bitable.base.onSelectionChange((event: { data: Selection }) => {
  console.log('current selection', event)
})
```

```typescript
const off = bitable.base.onSelectionChange((event: { data: Selection }) => {
  console.log('current selection', event)
})
```

--------------------------------

### getVisibleRecordIdList

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/view/calendar

Gets a list of IDs for all records currently visible in the calendar view.

```APIDOC
## getVisibleRecordIdList

### Description
Gets a list of IDs for all records currently visible in the calendar view.

### Method
GET

### Endpoint
/api/view/calendar/{id}/records/visible/ids

### Response
#### Success Response (200)
- **visibleRecordIdList** (Array<string | undefined>) - An array of visible record IDs.
```

--------------------------------

### Get Field ID

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/cell

Retrieves the ID of the Field to which the current Cell belongs.

```APIDOC
## getFieldId

### Description
Gets the ID of the field to which the current cell belongs.

### Method
getFieldId: () => string;

### Parameters
None

### Request Example
```typescript
const fieldId = cell.getFieldId();
```

### Response
#### Success Response (200)
- **string** - The ID of the field.
```

--------------------------------

### Get Barcode Value

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/field/barcode

Retrieve the value of a barcode field for a given record.

```typescript
const val = await barcodeField.getValue(recordId);
```

--------------------------------

### 新版本优化获取 Table 方式

Source: https://lark-base-team.github.io/js-sdk-docs/zh/update

新版本 JS SDK 优化了获取 Table 的过程，可以直接调用 getActiveTable() 方法一步获取对应的 Table 对象。

```typescript
const table = await bitable.base.getActiveTable()
```

```typescript
const table = await bitable.base.getActiveTable()
```

--------------------------------

### showRecordDetailDialog

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/ui

Displays the detail dialog for a specific record in a given table. By default, all fields are shown, but a list of fields to display can be specified. Returns a promise that resolves to a boolean indicating success.

```APIDOC
## showRecordDetailDialog

### Description
Displays the detail dialog for a specific record in a given table. By default, all fields are shown, but a list of fields to display can be specified.

### Method
`showRecordDetailDialog(params: { tableId: string, recordId: string, fieldIdList?: string[] } ): Promise<boolean>`

### Parameters
#### Request Body
- **params** (object) - Required - Parameters for the dialog.
  - **tableId** (string) - Required - The ID of the table.
  - **recordId** (string) - Required - The ID of the record.
  - **fieldIdList** (string[]) - Optional - A list of field IDs to display in the dialog.

### Response
#### Success Response (boolean)
- `true` if the dialog was shown successfully, `false` otherwise.

### Request Example
```typescript
await bitable.ui.showRecordDetailDialog({ tableId: 't_id', recordId: 'r_id' });
```
```

--------------------------------

### ModifiedTime Field Type Definition

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/field/modifiedTime

Defines the IModifiedTimeField type and provides an example of how to obtain it.

```APIDOC
## Type Definition `IModifiedTimeField`

This field type represents an update timestamp and does not support manual value input.

### Usage Example
```typescript
const modifiedTimeField = await table.getField<IModifiedTimeField>(fieldId);
```

### Field Value Type
```typescript
type IOpenTimestamp = number;
```
```

--------------------------------

### Get View List

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/table

Retrieves a list of all views associated with the current data table.

```typescript
getViewList: () => Promise<IView[]>;

```

```typescript
const viewList = await table.getViewList();
```

--------------------------------

### Get Field Meta by ID

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/table

Retrieves the metadata for a specific field using its ID.

```APIDOC
## Get Field Meta by ID

### Description
Retrieves the metadata for a specific field using its ID.

### Method
`table.getFieldMetaById(fieldId: string): Promise<IFieldMeta>`

### Parameters
#### Path Parameters
- **fieldId** (string) - Required - The ID of the field whose metadata to retrieve.

### Response
#### Success Response
- **fieldMeta** (IFieldMeta) - An object containing the field's metadata.
  - **id** (string) - The field ID.
  - **type** (FieldType) - The type of the field.
  - **name** (string) - The name of the field.
  - **isPrimary** (boolean) - Indicates if this is the primary field.
  - **description** (IBaseFieldDescription) - The description of the field.

### Request Example
```typescript
const fieldMeta = await table.getFieldMetaById('f_id');
// { id: 'f_id', name: 'text field', type: 1, isPrimary: true, description: { content: content, disableSyncToFormDesc: false } }
```
```

--------------------------------

### onThemeChange

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/bridge

Listens for changes in the theme. A callback is triggered when the theme changes.

```APIDOC
## onThemeChange

### Description
Listens for changes in the theme. A callback is triggered when the theme changes.

### Method
```typescript
onThemeChange(callback: (ev: IEventCbCtx<ThemeModeCtx>) => void): () => void;
```

### Parameters
* **callback** ((ev: IEventCbCtx<ThemeModeCtx>) => void) - Required - The function to call when the theme changes. It receives an event object containing the new theme data.

### Returns
* **() => void** - A function to unsubscribe from theme change events.

### Example
```typescript
const unsubscribe = await bitable.bridge.onThemeChange((event) => {
  console.log('theme change', event.data.theme);
});
// To unsubscribe later: unsubscribe();
```
```

--------------------------------

### Get Field List

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/table

Retrieves a list of all field objects within the current table.

```APIDOC
## Get Field List

### Description
Retrieves a list of all field objects within the current table.

### Method
`table.getFieldList<T extends IField>(): Promise<T[]>`

### Response
#### Success Response
- **fieldList** (T[]) - An array of field objects.

### Request Example
```typescript
const fieldList = await table.getFieldList();
```
```

--------------------------------

### Sort Methods

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/view/gantt

Methods for managing sorting configurations within the Gantt View.

```APIDOC
## Sort Methods

### `getSortInfo()`

**Description**: Retrieves the current sorting information for the Gantt View.

**Method**: `GET` (conceptual)

**Endpoint**: N/A (SDK method)

**Return Type**: `Promise<ISortInfo[]>`

### `setAutoSort(param: boolean)`

**Description**: Sets whether to automatically sort the view. This is typically set to `true` when sorting conditions are applied. Note that this does not save the setting; `applySetting()` must be called separately.

**Method**: `PUT` (conceptual)

**Endpoint**: N/A (SDK method)

**Parameters**:
  - **param** (boolean) - Required - `true` to enable auto-sort, `false` otherwise.

**Return Type**: `Promise<boolean>`

### `addSort(param: ISortInfo | ISortInfo[])`

**Description**: Adds new sorting condition(s) to the Gantt View. Note that this does not save the setting; `applySetting()` must be called separately.

**Method**: `POST` (conceptual)

**Endpoint**: N/A (SDK method)

**Parameters**:
  - **param** (ISortInfo | ISortInfo[]) - Required - The sorting information or an array of sorting information to add.

**Return Type**: `Promise<boolean>`

### `deleteSort(param: ISortInfo | string)`

**Description**: Deletes a sorting condition from the Gantt View. Note that this does not save the setting; `applySetting()` must be called separately.

**Method**: `DELETE` (conceptual)

**Endpoint**: N/A (SDK method)

**Parameters**:
  - **param** (ISortInfo | string) - Required - The sorting information or the ID of the sorting condition to delete.

**Return Type**: `Promise<boolean>`

### `updateSort(param: ISortInfo)`

**Description**: Updates an existing sorting condition in the Gantt View. Note that this does not save the setting; `applySetting()` must be called separately.

**Method**: `PUT` (conceptual)

**Endpoint**: N/A (SDK method)

**Parameters**:
  - **param** (ISortInfo) - Required - The updated sorting information.

**Return Type**: `Promise<boolean>`
```

--------------------------------

### getType

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/view/grid

Gets the type of the current view. It is expected to always return ViewType.Grid for this view.

```APIDOC
## getType

### Description
Gets the type of the current view.

### Method
GET (conceptual)

### Endpoint
N/A (SDK method)

### Parameters
None

### Response
#### Success Response
- **type** (ViewType.Grid) - The type of the view, which is Grid.

### Response Example
```json
"grid" 
```
```

--------------------------------

### Get View Name

Source: https://lark-base-team.github.io/js-sdk-docs/zh/api/view/form

Retrieves the name of the current form view. This is an asynchronous operation.

```typescript
getName(): Promise<string>;
```
Tokens:
Raw