What is a Field?
A Field is an input component automatically generated based on the field keys present in a template. Fields are used to collect and populate information when filling out a document dynamically.
Each field is linked to a field key in the format {field_key} and has 8 key properties:
1. Field Key
- A unique identifier enclosed in {}.
Example: {recipient_name}, {company_name}, or {project_start_date}.
2. Label
- The name is displayed for the field.
Example: “Recipient Name” or “Company Name.”
3. Placeholder
- A hint or example value is displayed inside the field when it’s empty.
Example: “Enter recipient name here.”
4. Data Type
- Determines the type of data the field will accept.
- String: Accepts plain text (e.g., names, addresses).
- Number: Accepts numeric values (e.g., quantities, prices).
- Drop-down: Offers a list of predefined options.
- Radio: Displays multiple-choice options as radio buttons.
- Date: Allows users to select a date.
- Function: Processes or calculates values based on formulas.
5. Tooltip
- A short instruction or description for the field, displayed as a hint (usually on hover or click).
Example: “Enter the recipient’s full legal name.”
6. Data Option
Meaning varies based on the Data Type:
- For Radio and Drop-down fields: Stores selectable values.
Example: {gender} with data option set to male; female will display radio buttons for “Male” and “Female.” - For Function fields: Stores formulas for calculations. (Learn more about formulas in the Function type field.)
7. Required
- Indicates whether the field must be filled before completing the document.
- Value:
- Checked: Field is mandatory.
- Unchecked: Field is optional.
8. User Input
- Determines whether the user can enter a value for the field.
- Value:
- True: The User can enter a value.
- False: The User cannot enter a value, and the field will display a pre-filled or static value.