Skip to main content

Enumeration: CustomFieldType

Defines the types of custom fields available for product configuration.

This enum specifies the different data input types that can be used when creating custom fields in the configurator. Each field type offers different user interaction patterns and data validation rules, appropriate for different kinds of information.

Custom fields extend the configurator's capabilities beyond standard options, allowing for personalization, specifications, or additional information collection during the configuration process.

Enumeration Members​

CHECKBOX​

CHECKBOX: "CHECKBOX"

True/false toggle input.

CHECKBOX fields provide a simple binary choice, allowing users to enable or disable an option. They're typically rendered as checkboxes that can be checked (true) or unchecked (false).

Use CHECKBOX fields for optional features, agreements, or any yes/no choices that affect the product configuration or order processing.

FILE​

FILE: "FILE"

File upload field.

FILE fields allow users to upload a file as part of the product configuration. The uploaded file is stored and linked to the configuration, making it accessible for processing, review, or production purposes.

Use FILE fields when you need users to provide reference images, design documents, blueprints, or any other file-based input that directly supports customization or validation of the configured product.

META_OBJECT​

META_OBJECT: "META_OBJECT"

Structured set of nested custom fields.

META_OBJECT fields store a collection of other custom fields as a single, structured value, typically represented as JSON. This allows grouping related inputs together into a cohesive unit, while still leveraging all available field types within the set.

Use META_OBJECT fields when you need to capture complex, multi-part data — such as detailed component specifications, grouped measurements, or any scenario where multiple related fields should be treated as one logical configuration element.

MULTI_LINE_TEXT​

MULTI_LINE_TEXT: "MULTI_LINE_TEXT"

Multi-line text area for longer input.

MULTI_LINE_TEXT fields allow users to enter longer text content that spans multiple lines. They provide more space for detailed information entry than standard TEXT fields.

Use MULTI_LINE_TEXT fields for comments, special instructions, detailed specifications, or any information that might require paragraphs rather than a single line of text.

MULTI_LINE_TRANSLATABLE_TEXT​

MULTI_LINE_TRANSLATABLE_TEXT: "MULTI_LINE_TRANSLATABLE_TEXT"

NUMBER​

NUMBER: "NUMBER"

Numeric input field with validation.

NUMBER fields allow users to enter numeric values only, with built-in validation to ensure the input is a valid number. They may include optional constraints like minimum/maximum values or step increments.

Use NUMBER fields for dimensions, quantities, or any numeric specifications where you want to prevent non-numeric input or apply range validation.

SINGLE_SELECT​

SINGLE_SELECT: "SINGLE_SELECT"

Dropdown selection from predefined options.

SINGLE_SELECT fields present users with a list of predefined options from which they can select exactly one choice. This provides a controlled input experience with a finite set of possible values.

Use SINGLE_SELECT fields when users need to choose from a specific list of options, such as color preferences, materials, or predefined configurations that don't warrant their own option blocks.

TEXT​

TEXT: "TEXT"

Single-line text input field.

TEXT fields allow users to enter short, free-form text input. They're suitable for collecting simple textual information that doesn't require formatting, such as names, reference numbers, or brief specifications.

Use TEXT fields for information that is typically a single word or short phrase, fits on one line, and doesn't require number-specific validation.

TRANSLATABLE_TEXT​

TRANSLATABLE_TEXT: "TRANSLATABLE_TEXT"

Text field with multi-language support.

TRANSLATABLE_TEXT fields allow for text input that can be provided in multiple languages. The field stores different values for each supported language, displaying the appropriate one based on the user's current language setting.

Use TRANSLATABLE_TEXT fields for information that should be localized, such as custom inscriptions or personalized messages that might be displayed on the product.