Class MjEntityFormHostComponent

Presentation-agnostic host that renders ANY MemberJunction entity form — generated (@RegisterClass / CodeGen), custom (*Extended), or interactive (EntityFormOverride) — for a given record.

This is the shared core extracted from Explorer's SingleRecordComponent. It encapsulates the full lifecycle: resolve which form to use (via FormResolverService, honoring variant overrides) → load the record (or accept a pre-loaded one) → create the form component dynamically → bind record / EditMode / Config / variants → re-emit the form's events → tear down cleanly.

It has ZERO routing and ZERO Explorer dependencies — it only emits events. The surrounding surface (a full-page tab in Explorer, a dialog, or a slide-in) decides what to do with Navigate, Notification, etc.

Example: Explorer tab (thin wrapper subscribes + maps to NavigationService)

<mj-entity-form-host [EntityName]="entityName" [PrimaryKey]="pk"
  (Navigate)="handleNavigation($event)" (Saved)="onSaved($event)">
</mj-entity-form-host>

Example: Bind a pre-loaded record (dialog/slide-in)

<mj-entity-form-host [Record]="myEntity" [Config]="DIALOG_FORM_CONFIG"></mj-entity-form-host>

Hierarchy (View Summary)

BaseAngularComponent
- MjEntityFormHostComponent

Implements

AfterViewInit
OnDestroy

Constructors

constructor

new MjEntityFormHostComponent(): MjEntityFormHostComponent
Returns MjEntityFormHostComponent
Inherited from BaseAngularComponent.constructor

Properties

Config

Config: EntityFormConfig | null = null

Per-instance form presentation config (toolbar, sections, width, links).

Dismissed

Dismissed: EventEmitter<void> = ...

Form asked to be dismissed (e.g. Discard on a brand-new record).

errorDetail

errorDetail: string | null = null

errorTitle

errorTitle: string | null = null

FormCreated

FormCreated: EventEmitter<BaseFormComponent> = ...

The live form instance, emitted right after it's created (for power-user wiring).

LoadComplete

LoadComplete: EventEmitter<void> = ...

Initial load + mount finished (success path).

LoadError

LoadError: EventEmitter<{ detail: string; title: string }> = ...

Load failed; carries a user-facing title + detail.

loading

loading: boolean = true

Navigate

Navigate: EventEmitter<FormNavigationEvent> = ...

Form navigation request (record link, new record, hierarchy, email, external, dismiss).

NewRecordValues

NewRecordValues: string | Record<string, unknown> | null = null

New-record default values: URL-segment string or a plain object.

Notification

Notification: EventEmitter<FormNotificationEvent> = ...

User-facing notification request (success/error/warning/info).

Provider

Provider: IMetadataProvider | null

If specified, this provider will be used for communication and for all metadata purposes. By default, if not provided, the Metadata and RunView classes are used for this and the default GraphQLDataProvider is used which is connected to the same back-end MJAPI instance as the Metadata and RunView classes. If you want to have this component connect to a different MJAPI back-end, create an instance of a ProviderBase sub-class like GraphQLDataProvider/etc, and configure it as appropriate to connect to the MJAPI back-end you want to use, and then pass it in here.

RecordDeleted

RecordDeleted: EventEmitter<RecordDeletedEvent> = ...

Re-emitted form RecordDeleted.

RecordReady

RecordReady: EventEmitter<BaseEntity<unknown>> = ...

Re-emitted form RecordReady (record fully initialized).

RecordSaved

RecordSaved: EventEmitter<RecordSavedEvent> = ...

Re-emitted form RecordSaved (richer payload).

RecordSaveFailed

RecordSaveFailed: EventEmitter<RecordSaveFailedEvent> = ...

Re-emitted form RecordSaveFailed.

Saved

Saved: EventEmitter<BaseEntity<unknown>> = ...

Emitted after the record is successfully saved (carries the live entity).

SectionName

SectionName: string | null = null

Render a single registered form section (a BaseFormSectionComponent registered as '<EntityName>.<SectionName>') instead of the full form. When set, the full-form resolver / variant picker / toolbar container are bypassed — the section component renders its own fields and the host saves the record directly. Used for compact, focused editors (e.g. a quick-edit grid row). Leave null for the normal full-form behavior.

ValidationFailed

ValidationFailed: EventEmitter<ValidationFailedEvent> = ...

Re-emitted form ValidationFailed.

`Static`ɵdir

"ɵdir": unknown

`Static`ɵfac

"ɵfac": unknown

Accessors

Dirty

get Dirty(): boolean
Whether the bound record has unsaved changes.

Returns boolean
- Defined in Angular/Generic/base-forms/src/lib/host/entity-form-host.component.ts:173

EditMode

get EditMode(): boolean | null
Returns boolean | null
- Defined in Angular/Generic/base-forms/src/lib/host/entity-form-host.component.ts:121
set EditMode(value: boolean | null): void
Force edit mode. When omitted, new records start in edit, existing in read.
Parameters
- value: boolean | null
Returns void
- Defined in Angular/Generic/base-forms/src/lib/host/entity-form-host.component.ts:120

EntityName

get EntityName(): string | null
Returns string | null
- Defined in Angular/Generic/base-forms/src/lib/host/entity-form-host.component.ts:74
set EntityName(value: string | null): void
Entity name to load a record for. Ignored when Record is supplied.
Parameters
- value: string | null
Returns void
- Defined in Angular/Generic/base-forms/src/lib/host/entity-form-host.component.ts:69

Form

get Form(): BaseFormComponent | null
The live form component instance, or null before mount / after teardown.

Returns BaseFormComponent | null
- Defined in Angular/Generic/base-forms/src/lib/host/entity-form-host.component.ts:168

PrimaryKey

get PrimaryKey(): CompositeKey
Returns CompositeKey
- Defined in Angular/Generic/base-forms/src/lib/host/entity-form-host.component.ts:88
set PrimaryKey(value: CompositeKey): void
Primary key of the record to load. Empty key → new record.
Parameters
- value: CompositeKey
Returns void
- Defined in Angular/Generic/base-forms/src/lib/host/entity-form-host.component.ts:79

ProviderToUse

get ProviderToUse(): IMetadataProvider
Returns either the default Metadata provider or the one specified in the Provider property, if it was specified

Returns IMetadataProvider
Inherited from BaseAngularComponent.ProviderToUse
- Defined in Angular/Generic/base-types/dist/base-angular-component.d.ts:17

Record

get Record(): BaseEntity<unknown> | null
Returns BaseEntity<unknown> | null
- Defined in Angular/Generic/base-forms/src/lib/host/entity-form-host.component.ts:102
set Record(value: BaseEntity<unknown> | null): void
Pre-loaded record to bind directly. When supplied, the host skips the load step entirely and mounts the resolved form against this instance — EntityName/PrimaryKey are not required.
Parameters
- value: BaseEntity<unknown> | null
Returns void
- Defined in Angular/Generic/base-forms/src/lib/host/entity-form-host.component.ts:97

RunQueryToUse

get RunQueryToUse(): IRunQueryProvider
Returns either the default RunQuery provider or the one specified in the Provider property, if it was specified

Returns IRunQueryProvider
Inherited from BaseAngularComponent.RunQueryToUse
- Defined in Angular/Generic/base-types/dist/base-angular-component.d.ts:25

RunReportToUse

get RunReportToUse(): IRunReportProvider
Returns either the default RunReport provider or the one specified in the Provider property, if it was specified

Returns IRunReportProvider
Inherited from BaseAngularComponent.RunReportToUse
- Defined in Angular/Generic/base-types/dist/base-angular-component.d.ts:29

RunViewToUse

get RunViewToUse(): IRunViewProvider
Returns either the default RunView provider or the one specified in the Provider property, if it was specified

Returns IRunViewProvider
Inherited from BaseAngularComponent.RunViewToUse
- Defined in Angular/Generic/base-types/dist/base-angular-component.d.ts:21

Methods

Cancel

Cancel(): void
Cancel edits (revert). Full-form mode uses the form's cancel pipeline.

Returns void
- Defined in Angular/Generic/base-forms/src/lib/host/entity-form-host.component.ts:206

ngAfterViewInit

ngAfterViewInit(): void
A callback method that is invoked immediately after Angular has completed initialization of a component's view. It is invoked only once when the view is instantiated.

Returns void
Implementation of AfterViewInit.ngAfterViewInit
- Defined in Angular/Generic/base-forms/src/lib/host/entity-form-host.component.ts:179

ngOnDestroy

ngOnDestroy(): void
A callback method that performs custom clean-up, invoked immediately before a directive, pipe, or service instance is destroyed.

Returns void
Implementation of OnDestroy.ngOnDestroy
- Defined in Angular/Generic/base-forms/src/lib/host/entity-form-host.component.ts:184

Save

Save(): Promise<boolean>
Save the bound record. In full-form mode this runs the form's save pipeline (validation, pending records, notifications); in section mode the section component has no pipeline, so we save the record directly (the record's own save event still drives the Saved output).

Returns Promise<boolean>
- Defined in Angular/Generic/base-forms/src/lib/host/entity-form-host.component.ts:196

Class MjEntityFormHostComponent

Example: Explorer tab (thin wrapper subscribes + maps to NavigationService)

Example: Bind a pre-loaded record (dialog/slide-in)

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns MjEntityFormHostComponent

Properties

Config

Dismissed

errorDetail

errorTitle

FormCreated

LoadComplete

LoadError

loading

Navigate

NewRecordValues

Notification

Provider

RecordDeleted

RecordReady

RecordSaved

RecordSaveFailed

Saved

SectionName

ValidationFailed

Staticɵdir

Staticɵfac

Accessors

Dirty

Returns boolean

EditMode

Returns boolean | null

Parameters

Returns void

EntityName

Returns string | null

Parameters

Returns void

Form

Returns BaseFormComponent | null

PrimaryKey

Returns CompositeKey

Parameters

Returns void

ProviderToUse

Returns IMetadataProvider

Record

Returns BaseEntity<unknown> | null

Parameters

Returns void

RunQueryToUse

Returns IRunQueryProvider

RunReportToUse

Returns IRunReportProvider

RunViewToUse

Returns IRunViewProvider

Methods

Cancel

Returns void

ngAfterViewInit

Returns void

ngOnDestroy

Returns void

Save

Returns Promise<boolean>

Settings

On This Page

`Static`ɵdir

`Static`ɵfac