Skip to main content

FormInputComponent

FormInputComponent​

@vendure/admin-uicomponent-registry-types.ts

This interface should be implemented by any component being used as a custom input. For example, inputs for custom fields, or for configurable arguments.

Signature
interface FormInputComponent<C = InputComponentConfig> {
    isListInput?: boolean;
    readonly: boolean;
    formControl: FormControl;
    config: C;
}

isListInput​

property
boolean

Should be set to true if this component is designed to handle lists. If true then the formControl value will be an array of all the values in the list.

readonly​

property
boolean

This is set by the Admin UI when consuming this component, indicating that the component should be rendered in a read-only state.

formControl​

property
FormControl

This controls the actual value of the form item. The current value is available as this.formControl.value, and an Observable stream of value changes is available as this.formControl.valueChanges. To update the value, use .setValue(val) and then .markAsDirty().

Full documentation can be found in the Angular docs.

config​

property
C

The config property contains the full configuration object of the custom field or configurable argument.