default-inputs
BooleanFormInputComponent
A checkbox input. The default input component for boolean
fields.
Signature
class BooleanFormInputComponent implements FormInputComponent {
static readonly static readonly id: DefaultFormComponentId = 'boolean-form-input';
readonly: boolean;
formControl: UntypedFormControl;
config: DefaultFormComponentConfig<'boolean-form-input'>;
}
Implements
Members
id
DefaultFormComponentId
readonly
boolean
formControl
UntypedFormControl
config
DefaultFormComponentConfig<'boolean-form-input'>
HtmlEditorFormInputComponent
A JSON editor input with syntax highlighting and error detection. Works well
with text
type fields.
Signature
class HtmlEditorFormInputComponent extends BaseCodeEditorFormInputComponent implements FormInputComponent, AfterViewInit, OnInit {
static readonly static readonly id: DefaultFormComponentId = 'html-editor-form-input';
constructor(changeDetector: ChangeDetectorRef)
ngOnInit() => ;
}
Extends
- BaseCodeEditorFormInputComponent
Implements
- FormInputComponent
- AfterViewInit
- OnInit
Members
id
DefaultFormComponentId
constructor
(changeDetector: ChangeDetectorRef) => HtmlEditorFormInputComponent
ngOnInit
() =>
JsonEditorFormInputComponent
A JSON editor input with syntax highlighting and error detection. Works well
with text
type fields.
Signature
class JsonEditorFormInputComponent extends BaseCodeEditorFormInputComponent implements FormInputComponent, AfterViewInit, OnInit {
static readonly static readonly id: DefaultFormComponentId = 'json-editor-form-input';
constructor(changeDetector: ChangeDetectorRef)
ngOnInit() => ;
}
Extends
- BaseCodeEditorFormInputComponent
Implements
- FormInputComponent
- AfterViewInit
- OnInit
Members
id
DefaultFormComponentId
constructor
(changeDetector: ChangeDetectorRef) => JsonEditorFormInputComponent
ngOnInit
() =>
CombinationModeFormInputComponent
A special input used to display the “Combination mode” AND/OR toggle.
Signature
class CombinationModeFormInputComponent implements FormInputComponent, OnInit {
static readonly static readonly id: DefaultFormComponentId = 'combination-mode-form-input';
readonly: boolean;
formControl: UntypedFormControl;
config: DefaultFormComponentConfig<'combination-mode-form-input'>;
selectable$: Observable<boolean>;
constructor(configurableInputComponent: ConfigurableInputComponent)
ngOnInit() => ;
setCombinationModeAnd() => ;
setCombinationModeOr() => ;
}
Implements
- FormInputComponent
- OnInit
Members
id
DefaultFormComponentId
readonly
boolean
formControl
UntypedFormControl
config
DefaultFormComponentConfig<'combination-mode-form-input'>
selectable$
Observable<boolean>
constructor
(configurableInputComponent: ConfigurableInputComponent) => CombinationModeFormInputComponent
ngOnInit
() =>
setCombinationModeAnd
() =>
setCombinationModeOr
() =>
CurrencyFormInputComponent
An input for monetary values. Should be used with int
type fields.
Signature
class CurrencyFormInputComponent implements FormInputComponent {
static readonly static readonly id: DefaultFormComponentId = 'currency-form-input';
@Input() @Input() readonly: boolean;
formControl: UntypedFormControl;
currencyCode$: Observable<CurrencyCode>;
config: DefaultFormComponentConfig<'currency-form-input'>;
constructor(dataService: DataService)
}
Implements
Members
id
DefaultFormComponentId
readonly
boolean
formControl
UntypedFormControl
currencyCode$
Observable<CurrencyCode>
config
DefaultFormComponentConfig<'currency-form-input'>
constructor
(dataService: DataService) => CurrencyFormInputComponent
CustomerGroupFormInputComponent
Allows the selection of a Customer via an autocomplete select input.
Should be used with ID
type fields which represent Customer IDs.
Signature
class CustomerGroupFormInputComponent implements FormInputComponent, OnInit {
static readonly static readonly id: DefaultFormComponentId = 'customer-group-form-input';
@Input() @Input() readonly: boolean;
formControl: FormControl<string | { id: string }>;
customerGroups$: Observable<GetCustomerGroupsQuery['customerGroups']['items']>;
config: DefaultFormComponentConfig<'customer-group-form-input'>;
constructor(dataService: DataService)
ngOnInit() => ;
selectGroup(group: ItemOf<GetCustomerGroupsQuery, 'customerGroups'>) => ;
compareWith(o1: ItemOf<GetCustomerGroupsQuery, 'customerGroups'>, o2: ItemOf<GetCustomerGroupsQuery, 'customerGroups'>) => ;
}
Implements
- FormInputComponent
- OnInit
Members
id
DefaultFormComponentId
readonly
boolean
formControl
FormControl<string | { id: string }>
customerGroups$
Observable<GetCustomerGroupsQuery['customerGroups']['items']>
config
DefaultFormComponentConfig<'customer-group-form-input'>
constructor
(dataService: DataService) => CustomerGroupFormInputComponent
ngOnInit
() =>
selectGroup
(group: ItemOf<GetCustomerGroupsQuery, 'customerGroups'>) =>
compareWith
(o1: ItemOf<GetCustomerGroupsQuery, 'customerGroups'>, o2: ItemOf<GetCustomerGroupsQuery, 'customerGroups'>) =>
DateFormInputComponent
Allows selection of a datetime. Default input for datetime
type fields.
Signature
class DateFormInputComponent implements FormInputComponent {
static readonly static readonly id: DefaultFormComponentId = 'date-form-input';
@Input() @Input() readonly: boolean;
formControl: UntypedFormControl;
config: DefaultFormComponentConfig<'date-form-input'>;
min: void
max: void
yearRange: void
}
Implements
Members
id
DefaultFormComponentId
readonly
boolean
formControl
UntypedFormControl
config
DefaultFormComponentConfig<'date-form-input'>
min
max
yearRange
FacetValueFormInputComponent
Allows the selection of multiple FacetValues via an autocomplete select input.
Should be used with ID
type list fields which represent FacetValue IDs.
Signature
class FacetValueFormInputComponent implements FormInputComponent {
static readonly static readonly id: DefaultFormComponentId = 'facet-value-form-input';
readonly readonly isListInput = true;
readonly: boolean;
formControl: UntypedFormControl;
config: InputComponentConfig;
valueTransformFn = (values: FacetValueFragment[]) => {
const isUsedInConfigArg = this.config.__typename === 'ConfigArgDefinition';
if (isUsedInConfigArg) {
return JSON.stringify(values.map(s => s.id));
} else {
return values;
}
};
}
Implements
Members
id
DefaultFormComponentId
isListInput
readonly
boolean
formControl
UntypedFormControl
config
InputComponentConfig
valueTransformFn
NumberFormInputComponent
Displays a number input. Default input for int
and float
type fields.
Signature
class NumberFormInputComponent implements FormInputComponent {
static readonly static readonly id: DefaultFormComponentId = 'number-form-input';
@Input() @Input() readonly: boolean;
formControl: UntypedFormControl;
config: DefaultFormComponentConfig<'number-form-input'>;
prefix: void
suffix: void
min: void
max: void
step: void
}
Implements
Members
id
DefaultFormComponentId
readonly
boolean
formControl
UntypedFormControl
config
DefaultFormComponentConfig<'number-form-input'>
prefix
suffix
min
max
step
PasswordFormInputComponent
Displays a password text input. Should be used with string
type fields.
Signature
class PasswordFormInputComponent implements FormInputComponent {
static readonly static readonly id: DefaultFormComponentId = 'password-form-input';
readonly: boolean;
formControl: UntypedFormControl;
config: InputComponentConfig;
}
Implements
Members
id
DefaultFormComponentId
readonly
boolean
formControl
UntypedFormControl
config
InputComponentConfig
ProductSelectorFormInputComponent
Allows the selection of multiple ProductVariants via an autocomplete select input.
Should be used with ID
type list fields which represent ProductVariant IDs.
Signature
class ProductSelectorFormInputComponent implements FormInputComponent, OnInit {
static readonly static readonly id: DefaultFormComponentId = 'product-selector-form-input';
readonly readonly isListInput = true;
readonly: boolean;
formControl: FormControl<Array<string | { id: string }>>;
config: DefaultFormComponentUiConfig<'product-selector-form-input'>;
selection$: Observable<Array<GetProductVariantQuery['productVariant']>>;
constructor(dataService: DataService)
ngOnInit() => ;
addProductVariant(product: ProductSelectorSearchQuery['search']['items'][number]) => ;
removeProductVariant(id: string) => ;
}
Implements
- FormInputComponent
- OnInit
Members
id
DefaultFormComponentId
isListInput
readonly
boolean
formControl
FormControl<Array<string | { id: string }>>
config
DefaultFormComponentUiConfig<'product-selector-form-input'>
selection$
Observable<Array<GetProductVariantQuery['productVariant']>>
constructor
(dataService: DataService) => ProductSelectorFormInputComponent
ngOnInit
() =>
addProductVariant
(product: ProductSelectorSearchQuery['search']['items'][number]) =>
removeProductVariant
(id: string) =>
RelationFormInputComponent
The default input component for relation
type custom fields. Allows the selection
of a ProductVariant, Product, Customer or Asset. For other entity types, a custom
implementation will need to be defined. See registerFormInputComponent.
Signature
class RelationFormInputComponent implements FormInputComponent {
static readonly static readonly id: DefaultFormComponentId = 'relation-form-input';
@Input() @Input() readonly: boolean;
formControl: UntypedFormControl;
config: RelationCustomFieldConfig;
}
Implements
Members
id
DefaultFormComponentId
readonly
boolean
formControl
UntypedFormControl
config
RelationCustomFieldConfig
RichTextFormInputComponent
Uses the RichTextEditorComponent as in input for text
type fields.
Signature
class RichTextFormInputComponent implements FormInputComponent {
static readonly static readonly id: DefaultFormComponentId = 'rich-text-form-input';
readonly: boolean;
formControl: UntypedFormControl;
config: DefaultFormComponentConfig<'rich-text-form-input'>;
}
Implements
Members
id
DefaultFormComponentId
readonly
boolean
formControl
UntypedFormControl
config
DefaultFormComponentConfig<'rich-text-form-input'>
SelectFormInputComponent
Uses a select input to allow the selection of a string value. Should be used with
string
type fields with options.
Signature
class SelectFormInputComponent implements FormInputComponent, OnInit {
static readonly static readonly id: DefaultFormComponentId = 'select-form-input';
@Input() @Input() readonly: boolean;
formControl: UntypedFormControl;
config: DefaultFormComponentConfig<'select-form-input'> & CustomFieldConfigFragment;
uiLanguage$: Observable<LanguageCode>;
options: void
constructor(dataService: DataService)
ngOnInit() => ;
trackByFn(index: number, item: any) => ;
}
Implements
- FormInputComponent
- OnInit
Members
id
DefaultFormComponentId
readonly
boolean
formControl
UntypedFormControl
config
DefaultFormComponentConfig<'select-form-input'> & CustomFieldConfigFragment
uiLanguage$
Observable<LanguageCode>
options
constructor
(dataService: DataService) => SelectFormInputComponent
ngOnInit
() =>
trackByFn
(index: number, item: any) =>
TextFormInputComponent
Uses a regular text form input. This is the default input for string
and localeString
type fields.
Signature
class TextFormInputComponent implements FormInputComponent {
static readonly static readonly id: DefaultFormComponentId = 'text-form-input';
readonly: boolean;
formControl: UntypedFormControl;
config: DefaultFormComponentConfig<'text-form-input'>;
prefix: void
suffix: void
}
Implements
Members
id
DefaultFormComponentId
readonly
boolean
formControl
UntypedFormControl
config
DefaultFormComponentConfig<'text-form-input'>
prefix
suffix
TextareaFormInputComponent
Uses textarea form input. This is the default input for text
type fields.
Signature
class TextareaFormInputComponent implements FormInputComponent {
static readonly static readonly id: DefaultFormComponentId = 'textarea-form-input';
readonly: boolean;
formControl: UntypedFormControl;
config: DefaultFormComponentConfig<'textarea-form-input'>;
spellcheck: boolean
}
Implements
Members
id
DefaultFormComponentId
readonly
boolean
formControl
UntypedFormControl
config
DefaultFormComponentConfig<'textarea-form-input'>
spellcheck
boolean