|
|
@@ -2,10 +2,6 @@
|
|
|
title: "Default Inputs"
|
|
|
generated: true
|
|
|
---
|
|
|
-
|
|
|
-
|
|
|
-## BooleanFormInputComponent
|
|
|
-
|
|
|
<GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/dynamic-form-inputs/boolean-form-input/boolean-form-input.component.ts" sourceLine="14" packageName="@vendure/admin-ui" />
|
|
|
|
|
|
A checkbox input. The default input component for `boolean` fields.
|
|
|
@@ -47,10 +43,6 @@ class BooleanFormInputComponent implements FormInputComponent {
|
|
|
|
|
|
|
|
|
</div>
|
|
|
-
|
|
|
-
|
|
|
-## HtmlEditorFormInputComponent
|
|
|
-
|
|
|
<GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/dynamic-form-inputs/code-editor-form-input/html-editor-form-input.component.ts" sourceLine="23" packageName="@vendure/admin-ui" />
|
|
|
|
|
|
A JSON editor input with syntax highlighting and error detection. Works well
|
|
|
@@ -90,10 +82,6 @@ class HtmlEditorFormInputComponent extends BaseCodeEditorFormInputComponent impl
|
|
|
|
|
|
|
|
|
</div>
|
|
|
-
|
|
|
-
|
|
|
-## JsonEditorFormInputComponent
|
|
|
-
|
|
|
<GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/dynamic-form-inputs/code-editor-form-input/json-editor-form-input.component.ts" sourceLine="33" packageName="@vendure/admin-ui" />
|
|
|
|
|
|
A JSON editor input with syntax highlighting and error detection. Works well
|
|
|
@@ -133,10 +121,6 @@ class JsonEditorFormInputComponent extends BaseCodeEditorFormInputComponent impl
|
|
|
|
|
|
|
|
|
</div>
|
|
|
-
|
|
|
-
|
|
|
-## CombinationModeFormInputComponent
|
|
|
-
|
|
|
<GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/dynamic-form-inputs/combination-mode-form-input/combination-mode-form-input.component.ts" sourceLine="17" packageName="@vendure/admin-ui" />
|
|
|
|
|
|
A special input used to display the "Combination mode" AND/OR toggle.
|
|
|
@@ -208,10 +192,6 @@ class CombinationModeFormInputComponent implements FormInputComponent, OnInit {
|
|
|
|
|
|
|
|
|
</div>
|
|
|
-
|
|
|
-
|
|
|
-## CurrencyFormInputComponent
|
|
|
-
|
|
|
<GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/dynamic-form-inputs/currency-form-input/currency-form-input.component.ts" sourceLine="17" packageName="@vendure/admin-ui" />
|
|
|
|
|
|
An input for monetary values. Should be used with `int` type fields.
|
|
|
@@ -265,10 +245,6 @@ class CurrencyFormInputComponent implements FormInputComponent {
|
|
|
|
|
|
|
|
|
</div>
|
|
|
-
|
|
|
-
|
|
|
-## CustomerGroupFormInputComponent
|
|
|
-
|
|
|
<GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/dynamic-form-inputs/customer-group-form-input/customer-group-form-input.component.ts" sourceLine="20" packageName="@vendure/admin-ui" />
|
|
|
|
|
|
Allows the selection of a Customer via an autocomplete select input.
|
|
|
@@ -341,10 +317,6 @@ class CustomerGroupFormInputComponent implements FormInputComponent, OnInit {
|
|
|
|
|
|
|
|
|
</div>
|
|
|
-
|
|
|
-
|
|
|
-## DateFormInputComponent
|
|
|
-
|
|
|
<GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/dynamic-form-inputs/date-form-input/date-form-input.component.ts" sourceLine="14" packageName="@vendure/admin-ui" />
|
|
|
|
|
|
Allows selection of a datetime. Default input for `datetime` type fields.
|
|
|
@@ -404,10 +376,6 @@ class DateFormInputComponent implements FormInputComponent {
|
|
|
|
|
|
|
|
|
</div>
|
|
|
-
|
|
|
-
|
|
|
-## FacetValueFormInputComponent
|
|
|
-
|
|
|
<GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/dynamic-form-inputs/facet-value-form-input/facet-value-form-input.component.ts" sourceLine="16" packageName="@vendure/admin-ui" />
|
|
|
|
|
|
Allows the selection of multiple FacetValues via an autocomplete select input.
|
|
|
@@ -469,10 +437,6 @@ class FacetValueFormInputComponent implements FormInputComponent {
|
|
|
|
|
|
|
|
|
</div>
|
|
|
-
|
|
|
-
|
|
|
-## NumberFormInputComponent
|
|
|
-
|
|
|
<GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/dynamic-form-inputs/number-form-input/number-form-input.component.ts" sourceLine="14" packageName="@vendure/admin-ui" />
|
|
|
|
|
|
Displays a number input. Default input for `int` and `float` type fields.
|
|
|
@@ -544,10 +508,6 @@ class NumberFormInputComponent implements FormInputComponent {
|
|
|
|
|
|
|
|
|
</div>
|
|
|
-
|
|
|
-
|
|
|
-## PasswordFormInputComponent
|
|
|
-
|
|
|
<GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/dynamic-form-inputs/password-form-input/password-form-input.component.ts" sourceLine="14" packageName="@vendure/admin-ui" />
|
|
|
|
|
|
Displays a password text input. Should be used with `string` type fields.
|
|
|
@@ -589,10 +549,6 @@ class PasswordFormInputComponent implements FormInputComponent {
|
|
|
|
|
|
|
|
|
</div>
|
|
|
-
|
|
|
-
|
|
|
-## ProductSelectorFormInputComponent
|
|
|
-
|
|
|
<GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/dynamic-form-inputs/product-selector-form-input/product-selector-form-input.component.ts" sourceLine="20" packageName="@vendure/admin-ui" />
|
|
|
|
|
|
Allows the selection of multiple ProductVariants via an autocomplete select input.
|
|
|
@@ -671,15 +627,11 @@ class ProductSelectorFormInputComponent implements FormInputComponent, OnInit {
|
|
|
|
|
|
|
|
|
</div>
|
|
|
-
|
|
|
-
|
|
|
-## RelationFormInputComponent
|
|
|
-
|
|
|
<GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/dynamic-form-inputs/relation-form-input/relation-form-input.component.ts" sourceLine="17" packageName="@vendure/admin-ui" />
|
|
|
|
|
|
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 <a href='/reference/admin-ui-api/custom-input-components/register-form-input-component#registerforminputcomponent'>registerFormInputComponent</a>.
|
|
|
+implementation will need to be defined. See <DocsLink href="/reference/admin-ui-api/custom-input-components/register-form-input-component#registerforminputcomponent">registerFormInputComponent</DocsLink>.
|
|
|
|
|
|
```ts title="Signature"
|
|
|
class RelationFormInputComponent implements FormInputComponent {
|
|
|
@@ -718,13 +670,9 @@ class RelationFormInputComponent implements FormInputComponent {
|
|
|
|
|
|
|
|
|
</div>
|
|
|
-
|
|
|
-
|
|
|
-## RichTextFormInputComponent
|
|
|
-
|
|
|
<GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/dynamic-form-inputs/rich-text-form-input/rich-text-form-input.component.ts" sourceLine="14" packageName="@vendure/admin-ui" />
|
|
|
|
|
|
-Uses the <a href='/reference/admin-ui-api/components/rich-text-editor-component#richtexteditorcomponent'>RichTextEditorComponent</a> as in input for `text` type fields.
|
|
|
+Uses the <DocsLink href="/reference/admin-ui-api/components/rich-text-editor-component#richtexteditorcomponent">RichTextEditorComponent</DocsLink> as in input for `text` type fields.
|
|
|
|
|
|
```ts title="Signature"
|
|
|
class RichTextFormInputComponent implements FormInputComponent {
|
|
|
@@ -763,10 +711,6 @@ class RichTextFormInputComponent implements FormInputComponent {
|
|
|
|
|
|
|
|
|
</div>
|
|
|
-
|
|
|
-
|
|
|
-## SelectFormInputComponent
|
|
|
-
|
|
|
<GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/dynamic-form-inputs/select-form-input/select-form-input.component.ts" sourceLine="18" packageName="@vendure/admin-ui" />
|
|
|
|
|
|
Uses a select input to allow the selection of a string value. Should be used with
|
|
|
@@ -839,10 +783,6 @@ class SelectFormInputComponent implements FormInputComponent, OnInit {
|
|
|
|
|
|
|
|
|
</div>
|
|
|
-
|
|
|
-
|
|
|
-## StructFormInputComponent
|
|
|
-
|
|
|
<GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/dynamic-form-inputs/struct-form-input/struct-form-input.component.ts" sourceLine="18" packageName="@vendure/admin-ui" />
|
|
|
|
|
|
A checkbox input. The default input component for `boolean` fields.
|
|
|
@@ -923,10 +863,6 @@ class StructFormInputComponent implements FormInputComponent, OnInit, OnDestroy
|
|
|
|
|
|
|
|
|
</div>
|
|
|
-
|
|
|
-
|
|
|
-## TextFormInputComponent
|
|
|
-
|
|
|
<GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/dynamic-form-inputs/text-form-input/text-form-input.component.ts" sourceLine="14" packageName="@vendure/admin-ui" />
|
|
|
|
|
|
Uses a regular text form input. This is the default input for `string` and `localeString` type fields.
|
|
|
@@ -980,10 +916,6 @@ class TextFormInputComponent implements FormInputComponent {
|
|
|
|
|
|
|
|
|
</div>
|
|
|
-
|
|
|
-
|
|
|
-## TextareaFormInputComponent
|
|
|
-
|
|
|
<GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/dynamic-form-inputs/textarea-form-input/textarea-form-input.component.ts" sourceLine="14" packageName="@vendure/admin-ui" />
|
|
|
|
|
|
Uses textarea form input. This is the default input for `text` type fields.
|