a!paragraphField( label, instructions, required, readOnly, disabled, value, validations, saveInto, refreshAfter, labelPosition, validationGroup, requiredMessage, height, placeholder, helpTooltip, showWhen, accessibilityText, characterLimit, showCharacterCount )
Displays and allows entry of multiple lines of text. For a single line of text, use a text component.
Name | Keyword | Types | Description |
---|---|---|---|
Label |
|
Text |
Text to display as the field label. |
Instructions |
|
Text |
Supplemental text about this field. |
Required |
|
Boolean |
Determines if a value is required to submit the form. Default: false. |
Read-only |
|
Boolean |
Determines if the field should display as not editable. Default: false. |
Disabled |
|
Boolean |
Determines if the field should display as potentially editable but grayed out. Default: false. |
Display Value |
|
Text |
Text to display in the field. |
Validations |
|
List of Text String |
Validation errors to display below the field when the value is not null. |
Save Input To |
|
List of Save |
One or more variables that are updated with the text when the user changes it. Use a!save() to save a modified or alternative value to a variable. |
Refresh After |
|
Text |
Determines when the interface is refreshed with the saved value from the paragraph field. Valid values are |
Label Position |
|
Text |
Determines where the label appears. Valid values:
|
Validation Group |
|
Text |
When present, the requiredness of the field is only evaluated when a button in the same validation group is pressed. The value for this parameter cannot contain spaces. For example, |
Required Message |
|
Text |
Custom message to display when the field's value is required and not provided. |
Height |
|
Text |
Determines the field height. Valid values: |
Placeholder |
|
Text |
Text to display in the field when it is empty. Does not show if the field is read only. |
Help Tooltip |
|
Text |
Displays a help icon with the specified text as a tooltip. The tooltip displays a maximum of 500 characters. The help icon does not show when the label position is |
Visibility |
|
Boolean |
Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default: true. |
Accessibility Text |
|
Text |
Additional text to be announced by screen readers. Used only for accessibility; produces no visible change. |
Character Limit |
|
Number (Integer) |
Determines the maximum number of characters. Depending on the language, some characters may count as more than one. |
Show Character Limit Count |
|
Boolean |
Determines if the character count displays on the paragraph field. Only applicable if the character limit is set. Default: true. |
true
, the component's character limit won't be displayed.true
, the component's value displays without a box around it.false
, you can use the user's input in the component to modify the interface.Use the interactive editor below to test out your code:
Feature | Compatibility | Note |
---|---|---|
Portals | Compatible | |
Offline Mobile | Compatible | |
Sync-Time Custom Record Fields | Incompatible | |
Real-Time Custom Record Fields | Incompatible | Custom record fields that evaluate in real time must be configured using one or more Custom Field functions. |
Process Reports | Incompatible | Cannot be used to configure a process report. |
Process Events | Incompatible | Cannot be used to configure a process event node, such as a start event or timer event. |
The following patterns include usage of the Paragraph Component.
Paragraph Component