Type Alias FreshdeskDependentFieldElement

FreshdeskDependentFieldElement: {
    defaultValue?: FreshdeskDependentFieldElementValue;
    itemHint?: string;
    itemLabel: string;
    subCategoryHint?: string;
    subCategoryLabel: string;
    type: "freshdeskDependentField";
} & FormElementWithOptionsBase

An element to allow the user to select an item after being filter down via category and sub-category.

The element must have an id property that contains a universally unique identifier (UUID). The identifier must be a Version 4 (V4) UUID and must conform to the formatting requirements defined in this RFC 9562 specification: https://www.rfc-editor.org/rfc/rfc9562.html

Example

{
  "id": "b1311ae0-6bb7-11e9-a923-1681be663d3e",
  "type": "freshdeskDependentField",
  "name": "country_state_suburb",
  "label": "Country",
  "hint": "Please select a Country before selecting a State.",
  "subCategoryLabel": "State",
  "subCategoryHint": "Please select a State before selecting a Suburb.",
  "itemLabel": "Suburb",
  "itemHint": "Please select a Suburb.",
  "defaultValue": {
    "category": "Australia",
    "subCategory": "NSW",
    "item": "Sydney"
  },
  "required": true,
  "readOnly": false
}

Example Submission Data

{
  "submission": {
    "[element.name]": {
      "category": "Australia",
      "subCategory": "NSW",
      "item": "Sydney"
    }
  }
}

Type declaration

  • OptionaldefaultValue?: FreshdeskDependentFieldElementValue

    A default value when the form is opened.

  • OptionalitemHint?: string

    A hint triggered by an icon tooltip to be displayed when hovering beside the item label.

  • itemLabel: string

    Display text presented to the user above the item input by default.

  • OptionalsubCategoryHint?: string

    A hint triggered by an icon tooltip to be displayed when hovering beside the sub category label.

  • subCategoryLabel: string

    Display text presented to the user above the sub category input by default.

  • type: "freshdeskDependentField"

    The type of Form Element.

Settings

Member Visibility

On This Page

ExampleExample Submission Data