Skip to main content

ScreenField

A field within a screen section

interface ScreenField {
id: String!
type: ScreenFieldType!
label: String!
helpText: String
available: Boolean!
}

Fields

ScreenField.id ● String! non-null scalar

Unique identifier for the field

ScreenField.type ● ScreenFieldType! non-null enum

The type of the field

ScreenField.label ● String! non-null scalar

The label to display in the UI

ScreenField.helpText ● String scalar

Help text explaining the field format or purpose

ScreenField.available ● Boolean! non-null scalar

Whether the field is visible and enabled

Member Of

ScreenSection object ● ScreenSectionBase interface ● ScreenTable object

Implemented By

BooleanScreenField object ● DateTimeScreenField object ● FilesScreenField object ● FloatScreenField object ● IntegerScreenField object ● SelectScreenField object ● SystemScreenField object ● TextListScreenField object ● TextLongScreenField object ● TextScreenField object ● TextSecureScreenField object