Skip to content

扩展表单 API

FormCreate 的 API 具有高度的扩展性,允许开发者创建自定义的操作和功能,以满足复杂的业务需求。通过 formCreate.extendApi 方法,您可以轻松地为 API 对象添加新的方法和属性。

获取 API

在使用扩展的 API 之前,您需要先获取 API 对象。API 对象可以通过事件、验证函数、钩子函数等方式获取。

详细说明请查看:如何获取 API

基本用法

js
import formCreate from '@form-create/element-ui';

formCreate.extendApi((api) => {
  return {
    customMethod() {
      // 执行自定义操作
      console.log('这是一个自定义 API 方法');
    },
    // 自定义 HTTP 请求方法
    async customRequest(url, options = {}) {
      // 实现自定义请求逻辑
      const response = await fetch(url, options);
      return response.json();
    },

    // 自定义工具方法
    formatDate(date, format = 'YYYY-MM-DD') {
      // 格式化日期
      return new Date(date).toLocaleDateString();
    },

    // 自定义数据处理方法
    processData(data) {
      // 处理数据
      return data.map(item => ({ ...item, processed: true }));
    }
  };
});

使用扩展的 API

扩展后的 API 可以在表单事件、验证函数等任何可以访问 api 对象的地方使用:

js
// 在事件中使用
function handleClick($inject) {
  const api = $inject.api;

  // 调用扩展的方法
  api.customMethod();

  // 使用扩展的请求方法
  api.customRequest('/api/data').then(data => {
    console.log('数据:', data);
  });
}

通过这种方式,您可以在整个应用中统一使用扩展的 API,提高代码的可维护性和复用性。