function

Component

Component selects an application component registered in admin/src/admin.config.ts. Optionally pass a settings object; the component registration must provide a decoder to check it. Omit settings when the component does not use them.

Arguments

ArgumentTypeDescription
keystringThe key value.
config[]store.ValueThe config value.

Returns

The declared result.

ComponentRef

Full signature

Related types

  • Value

    An immutable scalar, object, list, or populated document value.

  • ComponentRef

    ComponentRef selects a custom admin component and its optional settings. It changes the UI without changing how the field's value is stored or typed.