FrameworkAdapterInput

Defined in: packages/core/src/framework.ts:282

Input type for defineFrameworkAdapter().

Framework packages pass this to register their component implementations. TypeScript enforces that every field type in the AdminField union has both an input component (fields) and a cell component (cells), and that each component accepts the correct props for its field type.

What the HKT does: The F parameter is the framework’s HKT — a type-level function that maps a props type to the framework’s component type. For React:

interface ReactHKT extends ComponentHKT {
  component: ComponentType<this['_props']>;
}

Passing ReactHKT as F means every slot in fields and cells resolves to ComponentType<CorrectProps>, giving the component full prop autocomplete.

Example

// In @vexcms/react
import { defineFrameworkAdapter, ComponentHKT } from '@vexcms/core';
import { ComponentType } from 'react';

interface ReactHKT extends ComponentHKT {
  component: ComponentType<this['_props']>;
}

export const reactAdapter = defineFrameworkAdapter<ReactHKT>({
  name: 'react',
  version: '0.1.0',
  fields: {
    text: TextFieldComponent,  // must accept FieldComponentProps<TextField>
  },
  cells: {
    text: TextCellComponent,   // must accept CellComponentProps<TextField>
  },
});

See

• FrameworkAdapter for the resolved type returned by defineFrameworkAdapter
• FieldComponentMap for the field component slot types
• CellComponentProps for the cell component props

Type Parameters

F

F extends ComponentHKT

TFieldMeta

TFieldMeta extends BaseFieldMeta = BaseFieldMeta

Properties

fields

fields: FieldComponentMap<F, TFieldMeta>

Defined in: packages/core/src/framework.ts:294

Input components for each field type, rendered in the document edit form. Every type in the AdminField union must have a corresponding component.

---

name

name: string

Defined in: packages/core/src/framework.ts:287

Framework name used for identification (e.g. "react", "solid").

---

version

version: string

Defined in: packages/core/src/framework.ts:289

Adapter version — should match the framework package version.

---

views

views: ViewComponentMap<F>

Defined in: packages/core/src/framework.ts:299

Admin view components — required for rendering the admin panel. All three must be provided; TypeScript enforces completeness.