InputField

AMD: require(["esri/widgets/FeatureForm/InputField"], (InputField) => { /* code goes here */ });
ESM: import InputField from "@arcgis/core/widgets/FeatureForm/InputField";
Class: esri/widgets/FeatureForm/InputField
Inheritance: InputField Accessor
Since: ArcGIS API for JavaScript 4.9

This is a read-only support class that represents an input field. It helps provide a consistent API for the different types of input fields used by the FeatureForm widget. The values are computed internally by the FeatureFormViewModel.

See also:

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class
Stringmore details

The name of the class.

more detailsAccessor
Stringmore details

The field's description.

more detailsInputField
CodedValueDomain|RangeDomainmore details

The input value's domain.

more detailsInputField
Booleanmore details

When true, the field can be edited.

more detailsInputField
Stringmore details

The type of editor used when working with string fields.

more detailsInputField
Stringmore details

If the input field's value is invalid, this property returns validation error code.

more detailsInputField
Stringmore details

A user-friendly formatted error message based on the validation error code.

more detailsInputField
InputFieldGroupmore details

The group this input field belongs to.

more detailsInputField
Stringmore details

A hint for the field's value.

more detailsInputField
Stringmore details

For date inputs, this enables the time input part.

more detailsInputField
Stringmore details

The field's label.

more detailsInputField
Numbermore details

Restricts the input length.

more detailsInputField
Numbermore details

Restricts the input length.

more detailsInputField
Stringmore details

The associated field name.

more detailsInputField
Booleanmore details

Indicates whether the field is required.

more detailsInputField
Stringmore details

The type of input field.

more detailsInputField
Booleanmore details

When true, the input value is valid.

more detailsInputField
Number|String|nullmore details

The input's value.

more detailsInputField
Booleanmore details

When true, the field is displayed.

more detailsInputField

Property Details

declaredClass Stringreadonly inherited

The name of the class. The declared class name is formatted as esri.folder.className.

description Stringreadonly

The field's description.

domain CodedValueDomain|RangeDomainreadonly

The input value's domain. This is used to constrain the allowable values of the layer.

editable Booleanreadonly

When true, the field can be edited.

editorType Stringreadonly

The type of editor used when working with string fields. Possible values are in the table below.

Value Description
text-box An HTML textbox used to capture input.
text-area An HTML textarea used to capture input.

Possible Values:"text-box"|"text-area"

Default Value:text-box
error Stringreadonly

If the input field's value is invalid, this property returns validation error code. Otherwise, it is null.

errorMessage Stringreadonly

A user-friendly formatted error message based on the validation error code.

group InputFieldGroupreadonly
Since: ArcGIS API for JavaScript 4.10

The group this input field belongs to.

hint Stringreadonly

A hint for the field's value. Set this as a temporary placeholder for text/number inputs in either TextAreaInput or TextBoxInput.

includeTime Stringreadonly
Since: ArcGIS API for JavaScript 4.17

For date inputs, this enables the time input part.

label Stringreadonly

The field's label.

maxLength Numberreadonly

Restricts the input length.

minLength Numberreadonly

Restricts the input length.

name Stringreadonly

The associated field name.

required Booleanreadonly

Indicates whether the field is required.

type Stringreadonly

The type of input field. Possible values are listed below.

Value Description
number Input represents a number.
text Input represents text.
date Input represents a date.
unsupported The field represents an unsupported value. A blob field type is an example of this.

Possible Values:"number"|"text"|"date"|"unsupported"

valid Booleanreadonly

When true, the input value is valid. Otherwise, it is invalid.

value Number|String|nullreadonly

The input's value.

visible Booleanreadonly

When true, the field is displayed. Otherwise, it is hidden.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.