File

libs/common/src/lib/dynamic-form-bb/dynamic-form-bb.component.ts

Extends

AbstractBuildingBlock

Metadata

providers	`createBuildingBlockProvider(forwardRef(() => DynamicFormBuildingBlock))`
selector	`taly-dynamic-form-bb`
styleUrls	`dynamic-form-bb.component.scss`
templateUrl	`dynamic-form-bb.component.html`

Index

Inputs

id
Type : `any`
Default value : `dasherize(this.constructor.name)`
Inherited from `AbstractBuildingBlock`
Defined in `AbstractBuildingBlock:135`
can be changed during runtime and given as a default by the implemented Building Block

resources
Type : `BuildingBlockResources`
Inherited from `AbstractBuildingBlock`
Defined in `AbstractBuildingBlock:215`
The method will be called by the facade and is marked as an @Input. Derived Building Blocks need to list the input in the @Component decorator under `inputs:[]` to make it available to the template (View Engine limitation).

state
Type : `NoArray<BuildingBlockState>`
Inherited from `AbstractBuildingBlock`
Defined in `AbstractBuildingBlock:265`
The method will be called by the facade and is marked as an @Input. Derived Building Blocks need to list the input in the @Component decorator under `inputs:[]` to make it available to the template (View Engine limitation).

Outputs

completed
Type : `EventEmitter`
Inherited from `AbstractBuildingBlock`
Defined in `AbstractBuildingBlock:152`
Mark this Building Block as complete. That way a workflow engine can determine the overall completion state of any given pages. This method can be actively triggered by the user (say a button is clicked) or indirectly by a form being changed. The author of a Building Block needs to make sure that this function is called during the lifetime of a Building Block. If the Building Block is purely presentational this method can be called during initialization.

Methods

getForm

getForm()

Inherited from AbstractBuildingBlock

Defined in AbstractBuildingBlock:84

Returns : any

getState

getState()

Inherited from AbstractBuildingBlock

Defined in AbstractBuildingBlock:54

Returns : DynamicFormBbState

setFormCompletion

setFormCompletion(complete: boolean)

Defined in libs/common/src/lib/dynamic-form-bb/dynamic-form-bb.component.ts:58

Parameters :

Name	Type	Optional
complete	`boolean`	No

Returns : void

setResources

setResources(data: DynamicFormBbResources)

Inherited from AbstractBuildingBlock

Defined in AbstractBuildingBlock:36

Parameters :

Name	Type	Optional
data	`DynamicFormBbResources`	No

Returns : void

setState

setState(data: DynamicFormBbState)

Inherited from AbstractBuildingBlock

Defined in AbstractBuildingBlock:50

Parameters :

Name	Type	Optional
data	`DynamicFormBbState`	No

Returns : void

setValidationConfiguration

setValidationConfiguration(data: ValidationConfigItem[])

Inherited from AbstractBuildingBlock

Defined in AbstractBuildingBlock:88

Parameters :

Name	Type	Optional
data	`ValidationConfigItem[]`	No

Returns : void

callBusinessEvent

callBusinessEvent(event: string)

Inherited from AbstractBuildingBlock

Defined in AbstractBuildingBlock:101

This method creates a Deferred object for the business event given. This will have a newly created promise and their executor parameters resolve & reject. This deferred object is then emitted along with the business event name

The Store Integration(Facade) can then decide when to resolve or reject the underlying promise based on the service activator call attached to the business event.

call's status.

Parameters :

Name	Type	Optional	Description
event	`string`	No	name of the business event

Returns : Promise<>

the promise from the deferred. The building block can then be notified on the respective service activator call's status.

commitCompletion

commitCompletion()

Inherited from AbstractBuildingBlock

Defined in AbstractBuildingBlock:156

Returns : void

navigate

navigate(type: BUILDING_BLOCK_NAVIGATION_TYPE, payload?: string)

Inherited from AbstractBuildingBlock

Defined in AbstractBuildingBlock:119

Parameters :

Name	Type	Optional
type	`BUILDING_BLOCK_NAVIGATION_TYPE`	No
payload	`string`	Yes

Returns : void

onPageConnection

onPageConnection()

Inherited from AbstractBuildingBlock

Defined in AbstractBuildingBlock:176

Returns : void

onPageDisconnected

onPageDisconnected()

Inherited from AbstractBuildingBlock

Defined in AbstractBuildingBlock:179

Returns : void

revertCompletion

revertCompletion()

Inherited from AbstractBuildingBlock

Defined in AbstractBuildingBlock:161

Returns : void

stateChanged

stateChanged()

Inherited from AbstractBuildingBlock

Defined in AbstractBuildingBlock:236

Returns : void

transformResources

transformResources(data: BuildingBlockResources)

Inherited from AbstractBuildingBlock

Defined in AbstractBuildingBlock:205

Override if you need to pre process the incoming resource data and if you want to establish some default values. The return value will arrive in setResources and stored in the 'resources' variable. Needs to match the Resource Generic of the given Building Block

Parameters :

Name	Type	Optional
data	`BuildingBlockResources`	No

Returns : BuildingBlockResources

transformState

transformState(data: NoArray<BuildingBlockState>)

Inherited from AbstractBuildingBlock

Defined in AbstractBuildingBlock:255

Override if you need to pre process the incoming state data and if you want to establish some default values. The return value will arrive in setState and stored in the 'state' variable. Needs to match the State Generic of the given Building Block

Parameters :

Name	Type	Optional
data	`NoArray<BuildingBlockState>`	No

Returns : NoArray<BuildingBlockState>

Properties

_aclService

Type : AclService

Inherited from AbstractBuildingBlock

Defined in AbstractBuildingBlock:57

aclTag

Type : AclTag | null

Inherited from AbstractBuildingBlock

Defined in AbstractBuildingBlock:58

businesssEventCall$

Default value : new EventEmitter<BusinessEvent>()

Inherited from AbstractBuildingBlock

Defined in AbstractBuildingBlock:64

Readonly channel

Type : CHANNEL

Inherited from AbstractBuildingBlock

Defined in AbstractBuildingBlock:60

completion$

Default value : new BehaviorSubject(false)

Inherited from AbstractBuildingBlock

Defined in AbstractBuildingBlock:154

connected$

Default value : new Subject<void>()

Inherited from AbstractBuildingBlock

Defined in AbstractBuildingBlock:175

Lifecycle Event called once the Building Block is connected to the page. This can only happen when the Building Block is embed in a Building Block Page This is not intended to be used standalone.

At this point you can be sure that:

The Building Block is ready (AfterViewInit)
The initial state and resources has been set

disconnected$

Default value : new Subject<void>()

Inherited from AbstractBuildingBlock

Defined in AbstractBuildingBlock:178

Readonly isExpertChannel

Type : boolean

Inherited from AbstractBuildingBlock

Defined in AbstractBuildingBlock:62

Readonly isRetailChannel

Type : boolean

Inherited from AbstractBuildingBlock

Defined in AbstractBuildingBlock:61

loadingStatus$

Default value :

this._loadingStatus$
    .asObservable()
    .pipe(
      scan(accumulateBusinessEvents, []),
      map(groupEventStatusesByName),
      distinctUntilChanged(isEqual)
    )

Inherited from AbstractBuildingBlock

Defined in AbstractBuildingBlock:317

navigateEvent$

Default value : new EventEmitter<BuildingBlockNavigationEvent>()

Inherited from AbstractBuildingBlock

Defined in AbstractBuildingBlock:65

stateChange$

Default value : new BehaviorSubject({} as BuildingBlockState)

Inherited from AbstractBuildingBlock

Defined in AbstractBuildingBlock:235

Call this function to grab the current state and forward it any time your internal state is ready to be forwarded. It's a BehaviorSubject to always deliver the latest state on subscription. TODO: Evaluate if a multicast could help maintaining an more coordiated data stream

trackForm$

Default value : new EventEmitter<UntypedFormGroup>()

Inherited from AbstractBuildingBlock

Defined in AbstractBuildingBlock:74

Can be used to add automatic tracking to a form. Keep in mind that the form that is returned by getForm() is tracked automatically during the initialization.

This only has to be called if there are other forms that should be tracked or if the form is created after the initialization.

import {
  AbstractBuildingBlock,
  createBuildingBlockProvider,
  ValidationConfigItem
} from '@allianz/taly-core';
import {
  CUSTOM_COMPONENT_TYPE,
  type DfEventPayload,
  type DfInteractiveEventConfig
} from '@allianz/taly-core/dynamic-form';
import { DynamicFormConfiguration, type DfBasicComponentsConfig } from '@allianz/taly-core/schemas';
import { Component, forwardRef } from '@angular/core';
import { UntypedFormGroup } from '@angular/forms';
import { DynamicFormBbResources, DynamicFormBbState } from './dynamic-form-bb.model';

@Component({
  selector: 'taly-dynamic-form-bb',
  templateUrl: 'dynamic-form-bb.component.html',
  styleUrls: ['dynamic-form-bb.component.scss'],
  providers: [createBuildingBlockProvider(forwardRef(() => DynamicFormBuildingBlock))],
  standalone: false
})
export class DynamicFormBuildingBlock extends AbstractBuildingBlock<
  DynamicFormBbState,
  DynamicFormBbResources
> {
  protected formGroup = new UntypedFormGroup({});

  protected formConfig?: DynamicFormConfiguration;
  protected formRawValue: Record<string, unknown> | undefined;

  protected nxColValue = '12, 12, 8';

  protected enrichedValidationConfiguration: ValidationConfigItem[] | undefined;

  override setResources(data: DynamicFormBbResources): void {
    if (data.dynamicFormConfig) {
      this.formConfig = data.dynamicFormConfig;
    }

    if (this.isExpertChannel) {
      this.nxColValue = this.formConfig?.expertFullWidth ? '12, 12, 12' : '12, 12, 6';
    }
  }

  protected formDataChange() {
    this.stateChanged();
  }

  override setState(data: DynamicFormBbState): void {
    this.formRawValue = data;
  }

  override getState(): DynamicFormBbState {
    return this.formRawValue ?? {};
  }

  setFormCompletion(complete: boolean) {
    if (complete) {
      this.commitCompletion();
    } else {
      this.revertCompletion();
    }
  }

  protected processFormEvent(event: DfEventPayload) {
    const fieldConfig = this.formConfig?.fields.find(
      (field) => field.id === event.fieldIdConfig
    ) as DfBasicComponentsConfig;

    let eventConfig: DfInteractiveEventConfig | undefined;
    if (fieldConfig.type === CUSTOM_COMPONENT_TYPE) {
      eventConfig = fieldConfig.config?.[event.type] as DfInteractiveEventConfig | undefined;
    } else {
      // eslint-disable-next-line @typescript-eslint/no-explicit-any
      eventConfig = (fieldConfig as any)[event.type];
    }

    if (eventConfig) {
      this.callBusinessEvent(`${event.fieldIdConfig}.${event.type}`);
    }
  }

  override getForm() {
    return this.formGroup;
  }

  override setValidationConfiguration(data: ValidationConfigItem[]): void {
    this.enrichedValidationConfiguration = data;
  }
}

<div nxLayout="grid nopadding">
  <div nxRow [rowJustify]="isExpertChannel ? 'start' : 'center'">
    <div [nxCol]="this.nxColValue" data-testid="column-container">
      <df-form
        [id]="id"
        [formConfig]="formConfig"
        [existingFormGroup]="formGroup"
        (formValid)="setFormCompletion($event)"
        [(formRawValue)]="formRawValue"
        (formRawValueChange)="formDataChange()"
        [enrichedValidationConfiguration]="enrichedValidationConfiguration"
        (formEvent)="processFormEvent($event)"
        data-testid="dynamicForm"
      ></df-form>
    </div>
  </div>
</div>

dynamic-form-bb.component.scss

:host {
  display: block;
}

Legend

Html element

Component

Html element with directive

File

Extends

Metadata

Index

Properties

Methods

Inputs

Outputs

Inputs

Outputs

Methods

Properties

results matching ""

No results matching ""