助手方法

设计器为开发者提供了多种公共方法以便在项目中进行更高效的开发。这些方法涵盖了从复制文本到剪贴板、语言加载到配置项生成等多种实用功能。

方法列表

以下是设计器提供的公共方法及其数据结构定义：

1. 复制内容

export type copyTextToClipboard = (text: string) => void;

• 描述: 将文本复制到剪贴板，无需额外插件。
• 示例使用:

  import { copyTextToClipboard } from '/path/to/fcDesignerPro/dist/index.es.js';
  copyTextToClipboard('This is a text to copy');

2. 生成 $inject 参数的提示

export type getInjectArg = (t: t) => Object;

• 描述: 根据类型 t 生成注入参数的提示，用于生成$inject参数描述信息。

3. 加载选项的多语言

export type localeOptions = (t: t, options: Object[], prefix: String) => Object[];

• 描述: 为一组配置选项加载多语言支持。
• 示例使用:

  import { localeOptions } from '/path/to/fcDesignerPro/dist/index.es.js';
  const translatedOptions = localeOptions(t, [{ label: 'small', value: 'small' },{ label: 'mini', value: 'mini' }]);

4. 加载配置项的多语言

export type localeProps = (t: t, prefix: String, rule: Rule[]) => Rule[];

• 描述: 为配置项规则加载多语言支持。

5. 生成选项配置项的规则

export type makeOptionsRule = (t: t, to?: String, label?: string, value?: string) => Rule;

• 描述: 生成选项配置项的规则。
• 示例使用:

  import { makeOptionsRule } from '/path/to/fcDesignerPro/dist/index.es.js';
  const optionRule = makeOptionsRule(t, 'props.options', 'label', 'value');

6. 生成递归类型选项配置项的规则

export type makeTreeOptionsRule = (t: t, to?: String, label?: string, value?: string) => Rule;

• 描述: 生成适用于树状结构的递归选项配置项的规则。

8. 生成必填的规则

export type makeRequiredRule = () => Rule;

• 描述: 生成必填验证规则。
• 示例使用:

  import { makeRequiredRule } from '/path/to/fcDesignerPro/dist/index.es.js';
  const requiredRule = makeRequiredRule();

9. 转 JSON 字符串

export type toJSON = (obj: Object) => string;

• 描述: 将对象转换为 JSON 字符串。
• 示例使用:

  import { toJSON } from '/path/to/fcDesignerPro/dist/index.es.js';
  const jsonString = toJSON({ key: 'value' });
  console.log(jsonString); // 输出: {"key":"value"}

如何使用这些方法

这些方法可以在设计器的高级应用场景中使用，用于优化组件交互或数据处理。以下是一个代码示例，展示如何导入并调用 makeOptionsRule 方法：

import { makeOptionsRule } from '/path/to/fcDesignerPro/dist/index.es.js';


const ruleOption = makeOptionsRule(t, 'options', 'label', 'value');
console.log(ruleOption);

这些工具方法将帮助开发者简化常见任务，提高表单设计器的灵活性和可扩展性。在实际项目中，您可以根据需求选择适合的助手方法，从而提高开发效率。