import * as inputs from "@arcgis/core/form/elements/inputs.js";
const inputs = await $arcgis.import("@arcgis/core/form/elements/inputs.js");
@arcgis/core/form/elements/inputs
A convenience module for importing esri/form/elements/inputs/Input classes when developing with TypeScript. For example, rather than importing form element inputs one at a time like this:
import BarcodeScannerInput from "@arcgis/core/form/elements/inputs/BarcodeScannerInput.js";
import ComboBoxInput from "@arcgis/core/form/elements/inputs/ComboBoxInput.js";
import DatePickerInput from "@arcgis/core/form/elements/inputs/DatePickerInput.js";
import DateTimeOffsetPickerInput from "@arcgis/core/form/elements/inputs/DateTimeOffsetPickerInput.js";
import DateTimePickerInput from "@arcgis/core/form/elements/inputs/DateTimePickerInput.js";
import RadioButtonsInput from "@arcgis/core/form/elements/inputs/RadioButtonsInput.js";
import SwitchInput from "@arcgis/core/form/elements/inputs/SwitchInput.js";
import TextAreaInput from "@arcgis/core/form/elements/inputs/TextAreaInput.js";
import TextBoxInput from "@arcgis/core/form/elements/inputs/TextBoxInput.js";
import TimePickerInput from "@arcgis/core/form/elements/inputs/TimePickerInput.js";
You can use this module to import them on a single line:
import { BarcodeScannerInput, ComboBoxInput, DatePickerInput, DateTimeOffsetPickerInput, DateTimePickerInput, RadioButtonsInput, SwitchInput, TextAreaInput, TextBoxInput, TimePickerInput } from "@arcgis/core/form/elements/inputs.js";
This module also allows you to implement type guards on the form element inputs, making your code smarter.
import { Input } from "@arcgis/core/form/elements/inputs.js";
function logFormElementInput(input: Input): void {
if (input.type === "text-area") {
console.log("Form element input type is TextAreaInput");
}
else {
// The compiler knows the content element must be an input type such as `text-area` | `text-box` | `barcode-scanner` | `radio-buttons` | `combo-box`, etc.
console.log("The value is not a valid form element input.")
}
}
Type Definitions
-
BarcodeScannerInput
Type DefinitionBarcodeScannerInput BarcodeScannerInput -
The
BarcodeScannerInputclass defines the desired user interface is a barcode or QR code scanner. If this type is used in an ArcGIS Maps SDK for JavaScript web application, it will default to the esri/form/elements/inputs/TexBoxInput type as the API does not support bar code scanning as an input type.
-
ComboBoxInput
Type DefinitionComboBoxInput ComboBoxInput -
The
ComboBoxInputclass defines the desired user interface for a combo box group.
-
DatePickerInput
Type DefinitionDatePickerInput DatePickerInput -
The
DatePickerInputclass defines the desired user interface for working with date-only types.
-
DateTimeOffsetPickerInput
Type DefinitionDateTimeOffsetPickerInput DateTimeOffsetPickerInput -
The
DateTimeOffsetPickerInputclass defines the desired user interface for editing date and time fields in a form that also requires the option to include an offset from Coordinated Universal Time (UTC).
-
DateTimePickerInput
Type DefinitionDateTimePickerInput DateTimePickerInput -
The
DateTimePickerInputclass defines the desired user interface for editing date (including time) fields in a form.
-
Input
Type DefinitionInput BarcodeScannerInput |ComboBoxInput |DatePickerInput |DateTimeOffsetPickerInput |DateTimePickerInput |RadioButtonsInput |SwitchInput |TextAreaInput |TextBoxInput |TimePickerInput -
Form element input types.
-
RadioButtonsInput
Type DefinitionRadioButtonsInput RadioButtonsInput -
The
RadioButtonsInputclass defines the desired user interface for a radio button group.
-
SwitchInput
Type DefinitionSwitchInput SwitchInput -
The
SwitchInputclass defines the desired user interface for a binary switch or toggle. This should be used when selecting between two options in a form.
-
TextAreaInput
Type DefinitionTextAreaInput TextAreaInput -
TextAreaInputdefines the desired user interface is a multi-line text area.
-
TextBoxInput
Type DefinitionTextBoxInput TextBoxInput -
TextBoxInputdefines the desired user interface is a single-line text box.
-
TimePickerInput
Type DefinitionTimePickerInput TimePickerInput -
The
TimePickerInputclass defines the desired user interface for working with time-only types.