Helper Methods

The designer provides various public methods for more efficient development. These methods cover practical functions from copying text to clipboard, language loading to configuration item generation.

How to Use These Methods

Use these methods in advanced application scenarios to optimize component interactions or data processing. Example of how to import and call the makeOptionsRule method:

import { makeOptionsRule } from '@form-create/designer';

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

Method List

Public methods provided by the designer and their data structure definitions:

Copy Content

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

• Description: Copy text to clipboard without additional plugins
• Example Usage:

  import { copyTextToClipboard } from '@form-create/designer';
  copyTextToClipboard('This is a text to copy');

Generate $inject Parameter Hints

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

• Description: Generate injection parameter hints based on type t, used to generate $inject parameter description information

Load Multi-language for Options

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

• Description: Load multi-language support for a set of configuration options
• Example Usage:

  import { localeOptions } from '@form-create/designer';
  const translatedOptions = localeOptions(t, [{ label: 'small', value: 'small' },{ label: 'mini', value: 'mini' }]);

Load Multi-language for Configuration Items

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

• Description: Load multi-language support for configuration item rules

Generate Options Configuration Item Rules

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

• Description: Generate options configuration item rules
• Example Usage:

  import { makeOptionsRule } from '@form-create/designer';
  const optionRule = makeOptionsRule(t, 'props.options', 'label', 'value');

Generate Recursive Type Options Configuration Item Rules

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

• Description: Generate rules for recursive options configuration items suitable for tree structures

Generate Required Rule

export type makeRequiredRule = () => Rule;

• Description: Generate required validation rule
• Example Usage:

  import { makeRequiredRule } from '@form-create/designer';
  const requiredRule = makeRequiredRule();

Convert to JSON String

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

• Description: Convert object to JSON string
• Example Usage:

  import { toJSON } from '@form-create/designer';
  const jsonString = toJSON({ key: 'value' });
  console.log(jsonString); // Output: {"key":"value"}

These utility methods help developers simplify common tasks and improve the flexibility and extensibility of the form designer. In actual projects, choose appropriate helper methods according to your needs to improve development efficiency.