Kinlink API 参考

本文档详细介绍了 Kinlink JavaScript API 的所有方法、参数和用法,帮助开发者充分利用 Kinlink 的功能。

核心对象

Kinlink API 通过全局对象 window.kinlink 提供,主要包含以下几个核心部分:

  • formApi - 表单操作 API
  • layoutApi - 布局控制 API
  • events - 事件系统
  • FormEvents - 事件类型常量

formApi - 表单操作

formApi 提供了一系列方法用于操作表单字段、控制字段状态和验证表单。

字段值操作

JavaScript
// 获取字段值
const value = kinlink.formApi.getFieldValue('字段代码');

// 设置字段值
kinlink.formApi.setFieldValue('字段代码', '新值');

// 批量设置多个字段值
kinlink.formApi.setFieldsValue({
  字段1: '值1',
  字段2: '值2'
});

字段显示/隐藏

JavaScript
// 隐藏字段
kinlink.formApi.hideField('字段代码');

// 显示字段
kinlink.formApi.showField('字段代码');

// 仅视觉上隐藏字段(值仍会被提交)
kinlink.formApi.visuallyHideField('字段代码');

events - 事件系统

Kinlink 提供了完善的事件系统,允许开发者监听表单的各种状态变化。

JavaScript
// 监听表单加载完成事件
kinlink.events.on(kinlink.FormEvents.FORM_LOADED, () => {
  console.log('表单已加载完成');
  // 执行初始化逻辑
});

// 监听字段变更事件
kinlink.events.on(kinlink.FormEvents.FIELD_CHANGE, (data) => {
  const { fieldName, value } = data;
  console.log(`字段 ${fieldName} 的值变更为 ${value}`);
});

提示

完整的 API 文档请参考左侧导航栏中的相关部分,包括更多高级用法和示例。