register-form-input-component.md

title	isDefaultIndex	generated
RegisterFormInputComponent	false	true

import MemberInfo from '@site/src/components/MemberInfo'; import GenerationInfo from '@site/src/components/GenerationInfo'; import MemberDescription from '@site/src/components/MemberDescription';

registerFormInputComponent

Registers a custom FormInputComponent which can be used to control the argument inputs of a ConfigurableOperationDef (e.g. CollectionFilter, ShippingMethod etc.) or for a custom field.

Example

import { registerFormInputComponent } from '@vendure/admin-ui/core';

export default [
    // highlight-next-line
    registerFormInputComponent('my-custom-input', MyCustomFieldControl),
];

This input component can then be used in a custom field:

Example

import { VendureConfig } from '@vendure/core';

const config: VendureConfig = {
  // ...
  customFields: {
    ProductVariant: [
      {
        name: 'rrp',
        type: 'int',
        // highlight-next-line
        ui: { component: 'my-custom-input' },
      },
    ]
  }
}

or with an argument of a ConfigurableOperationDef:

Example

args: {
  rrp: { type: 'int', ui: { component: 'my-custom-input' } },
}

function registerFormInputComponent(id: string, component: Type<FormInputComponent>): FactoryProvider

Parameters

id

<MemberInfo kind="parameter" type={string} />

component

<MemberInfo kind="parameter" type={Type&#60;<a href='/reference/admin-ui-api/custom-input-components/form-input-component#forminputcomponent'>FormInputComponent</a>&#62;} />