renderConfigScreenDescription()

Overview

public string function renderConfigScreenDescription(
      required string fieldType         
    , required any    currentValue      
    , required struct fieldConfiguration
)

Renders description text (e.g. usage advice) for the configuration screen for the given field type and field configuration. By convention, this text can simply be set in i18n, but more advanced, context-specific help can be provided via a custom renderConfigScreenDescription handler

Arguments

NameTypeRequiredDescription
fieldTypestringYesName of the fieldtype
currentValueanyYesThe current saved value for the field within the expression
fieldConfigurationstructYesField type configuration options for the specific field