Form API

Form API 提供了一系列方法用于操作表单字段、控制字段状态和验证表单。本文档详细介绍了所有可用的方法及其用法。

字段值操作

提供获取和设置字段值的方法,支持单个字段操作和批量操作。

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

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

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

// 获取所有字段值
const allValues = kinlink.formApi.getAllValues();

字段显示控制

控制字段的显示状态,包括完全隐藏和仅视觉隐藏两种模式。

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

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

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

// 获取字段状态
const state = kinlink.formApi.getFieldState('字段代码');

字段验证

提供完整的字段验证机制,支持自定义验证规则和错误提示。

JavaScript
// 添加字段验证器
kinlink.formApi.addFieldValidator('邮箱', (value) => {
  if (!value) return;
  if (!/^\w+@\w+\.\w+$/.test(value)) {
    return '请输入有效的邮箱地址';
  }
  return undefined; // 验证通过
});

// 验证单个字段
const errorMsg = kinlink.formApi.validateField('邮箱', 'test@example.com');

// 验证整个表单
const { errors, isValid } = kinlink.formApi.validateForm();

样式与标签

允许自定义字段的样式和标签文本,实现个性化的界面定制。

JavaScript
// 设置字段标签样式
kinlink.formApi.setFieldLabelStyle('字段代码', {
  color: '#ff0000',
  fontWeight: 'bold'
});

// 设置字段组件样式
kinlink.formApi.setFieldComponentStyle('字段代码', {
  fontSize: '16px',
  padding: '12px 8px'
});

// 设置字段标签文本
kinlink.formApi.setFieldLabelText('字段代码', '新标签文本');

注意事项

  • 所有方法都是同步执行的,立即生效
  • 样式修改会立即反映在界面上
  • 验证错误会自动显示在相应字段下方
  • 建议在 FORM_LOADED 事件中进行初始化设置

相关资源