ng-forge
What is Dynamic Forms? Installation
Material Design PREVIEW Bootstrap PREVIEW PrimeNG PREVIEW Ionic PREVIEW
Field Types Validation Conditional Logic Type Safety Form Submission Internationalization (i18n) Event Bus
Form Rows Form Groups Form Arrays Form Pages Text Components
User Registration Form Contact Form Login Form Paginated Form (Multi-Step) Conditional Logic Showcase
Expression Parser Security Configuration Custom Integrations
API Reference
dynamic-forms-primeng / Class

PrimeNGFormTestUtils

Utility class for testing PrimeNG dynamic forms

Static Methods

static

assertFormValue()

Asserts that the form has a specific value

Presentation
static assertFormValue(component: DynamicForm<RegisteredFieldTypes[], { [x: string]: Record<string, unknown>; } & Record<string, unknown>>, expectedValue: Record<string, unknown>): void;
Parameters
NameTypeDescription
component
DynamicForm<RegisteredFieldTypes[], { [x: string]: Record<string, unknown>; } & Record<string, unknown>>
expectedValue
Record<string, unknown>
Returns
void
static

assertPrimeFieldError()

Asserts that a PrimeNG field shows an error message

Presentation
static assertPrimeFieldError(fixture: ComponentFixture<DynamicForm<RegisteredFieldTypes[], { [x: string]: Record<string, unknown>; } & Record<string, unknown>>>, fieldSelector: string, expectedError?: string | undefined): void;
Parameters
NameTypeDescription
fixture
ComponentFixture<DynamicForm<RegisteredFieldTypes[], { [x: string]: Record<string, unknown>; } & Record<string, unknown>>>
fieldSelector
string
expectedError
string | undefined
Returns
void
static

assertPrimeFieldValue()

Asserts that a PrimeNG field has a specific value

Presentation
static assertPrimeFieldValue(fixture: ComponentFixture<DynamicForm<RegisteredFieldTypes[], { [x: string]: Record<string, unknown>; } & Record<string, unknown>>>, fieldSelector: string, expectedValue: string): void;
Parameters
NameTypeDescription
fixture
ComponentFixture<DynamicForm<RegisteredFieldTypes[], { [x: string]: Record<string, unknown>; } & Record<string, unknown>>>
fieldSelector
string
expectedValue
string
Returns
void
static

builder()

Creates a new PrimeNG form config builder

Presentation
static builder(): PrimeNGFormConfigBuilder;
Returns
PrimeNGFormConfigBuilder
static async

createTest()

Creates a PrimeNG dynamic form test setup with proper providers

Presentation
async static createTest(testConfig: PrimeNGFormTestConfig): Promise<PrimeNGFormTestResult>;
Parameters
NameTypeDescription
testConfig
PrimeNGFormTestConfig
Returns
Promise<PrimeNGFormTestResult>
static

getFormErrors()

Gets validation errors from the component

Presentation
static getFormErrors(component: DynamicForm<RegisteredFieldTypes[], { [x: string]: Record<string, unknown>; } & Record<string, unknown>>): unknown[];
Parameters
NameTypeDescription
component
DynamicForm<RegisteredFieldTypes[], { [x: string]: Record<string, unknown>; } & Record<string, unknown>>
Returns
unknown[]
static

getFormValue()

Gets the current form value from the component

Presentation
static getFormValue(component: DynamicForm<RegisteredFieldTypes[], { [x: string]: Record<string, unknown>; } & Record<string, unknown>>): Record<string, unknown>;
Parameters
NameTypeDescription
component
DynamicForm<RegisteredFieldTypes[], { [x: string]: Record<string, unknown>; } & Record<string, unknown>>
Returns
Record<string, unknown>
static

getPButton()

Gets a PrimeNG button element

Presentation
static getPButton(fixture: ComponentFixture<DynamicForm<RegisteredFieldTypes[], { [x: string]: Record<string, unknown>; } & Record<string, unknown>>>, selector: string): HTMLButtonElement;
Parameters
NameTypeDescription
fixture
ComponentFixture<DynamicForm<RegisteredFieldTypes[], { [x: string]: Record<string, unknown>; } & Record<string, unknown>>>
selector
string
Returns
HTMLButtonElement
static

getPCalendar()

Gets a PrimeNG calendar (datepicker) element

Presentation
static getPCalendar(fixture: ComponentFixture<DynamicForm<RegisteredFieldTypes[], { [x: string]: Record<string, unknown>; } & Record<string, unknown>>>, selector: string): Element;
Parameters
NameTypeDescription
fixture
ComponentFixture<DynamicForm<RegisteredFieldTypes[], { [x: string]: Record<string, unknown>; } & Record<string, unknown>>>
selector
string
Returns
Element
static

getPCheckbox()

Gets a PrimeNG checkbox element

Presentation
static getPCheckbox(fixture: ComponentFixture<DynamicForm<RegisteredFieldTypes[], { [x: string]: Record<string, unknown>; } & Record<string, unknown>>>, selector: string): Element;
Parameters
NameTypeDescription
fixture
ComponentFixture<DynamicForm<RegisteredFieldTypes[], { [x: string]: Record<string, unknown>; } & Record<string, unknown>>>
selector
string
Returns
Element
static

getPDropdown()

Gets a PrimeNG dropdown element

Presentation
static getPDropdown(fixture: ComponentFixture<DynamicForm<RegisteredFieldTypes[], { [x: string]: Record<string, unknown>; } & Record<string, unknown>>>, selector: string): Element;
Parameters
NameTypeDescription
fixture
ComponentFixture<DynamicForm<RegisteredFieldTypes[], { [x: string]: Record<string, unknown>; } & Record<string, unknown>>>
selector
string
Returns
Element
static

getPInputSwitch()

Gets a PrimeNG InputSwitch (toggle) element

Presentation
static getPInputSwitch(fixture: ComponentFixture<DynamicForm<RegisteredFieldTypes[], { [x: string]: Record<string, unknown>; } & Record<string, unknown>>>, selector: string): Element;
Parameters
NameTypeDescription
fixture
ComponentFixture<DynamicForm<RegisteredFieldTypes[], { [x: string]: Record<string, unknown>; } & Record<string, unknown>>>
selector
string
Returns
Element
static

getPInputText()

Gets a PrimeNG input text element

Presentation
static getPInputText(fixture: ComponentFixture<DynamicForm<RegisteredFieldTypes[], { [x: string]: Record<string, unknown>; } & Record<string, unknown>>>, selector: string): HTMLInputElement;
Parameters
NameTypeDescription
fixture
ComponentFixture<DynamicForm<RegisteredFieldTypes[], { [x: string]: Record<string, unknown>; } & Record<string, unknown>>>
selector
string
Returns
HTMLInputElement
static

getPRadioButton()

Gets a PrimeNG radio button element

Presentation
static getPRadioButton(fixture: ComponentFixture<DynamicForm<RegisteredFieldTypes[], { [x: string]: Record<string, unknown>; } & Record<string, unknown>>>, selector: string): Element;
Parameters
NameTypeDescription
fixture
ComponentFixture<DynamicForm<RegisteredFieldTypes[], { [x: string]: Record<string, unknown>; } & Record<string, unknown>>>
selector
string
Returns
Element
static

getPrimeFieldElements()

Gets all PrimeNG field elements from the fixture

Presentation
static getPrimeFieldElements(fixture: ComponentFixture<DynamicForm<RegisteredFieldTypes[], { [x: string]: Record<string, unknown>; } & Record<string, unknown>>>, fieldType: string): NodeListOf<Element>;
Parameters
NameTypeDescription
fixture
ComponentFixture<DynamicForm<RegisteredFieldTypes[], { [x: string]: Record<string, unknown>; } & Record<string, unknown>>>
fieldType
string
Returns
NodeListOf<Element>
static

getPSlider()

Gets a PrimeNG slider element

Presentation
static getPSlider(fixture: ComponentFixture<DynamicForm<RegisteredFieldTypes[], { [x: string]: Record<string, unknown>; } & Record<string, unknown>>>, selector: string): Element;
Parameters
NameTypeDescription
fixture
ComponentFixture<DynamicForm<RegisteredFieldTypes[], { [x: string]: Record<string, unknown>; } & Record<string, unknown>>>
selector
string
Returns
Element
static

getPTextarea()

Gets a PrimeNG textarea element

Presentation
static getPTextarea(fixture: ComponentFixture<DynamicForm<RegisteredFieldTypes[], { [x: string]: Record<string, unknown>; } & Record<string, unknown>>>, selector: string): HTMLTextAreaElement;
Parameters
NameTypeDescription
fixture
ComponentFixture<DynamicForm<RegisteredFieldTypes[], { [x: string]: Record<string, unknown>; } & Record<string, unknown>>>
selector
string
Returns
HTMLTextAreaElement
static

isFormValid()

Checks if the form is valid

Presentation
static isFormValid(component: DynamicForm<RegisteredFieldTypes[], { [x: string]: Record<string, unknown>; } & Record<string, unknown>>): boolean;
Parameters
NameTypeDescription
component
DynamicForm<RegisteredFieldTypes[], { [x: string]: Record<string, unknown>; } & Record<string, unknown>>
Returns
boolean
static async

simulatePrimeButtonClick()

Simulates PrimeNG button click

Presentation
async static simulatePrimeButtonClick(fixture: ComponentFixture<DynamicForm<RegisteredFieldTypes[], { [x: string]: Record<string, unknown>; } & Record<string, unknown>>>, selector: string): Promise<void>;
Parameters
NameTypeDescription
fixture
ComponentFixture<DynamicForm<RegisteredFieldTypes[], { [x: string]: Record<string, unknown>; } & Record<string, unknown>>>
selector
string
Returns
Promise<void>
static async

simulatePrimeCheckbox()

Simulates PrimeNG checkbox toggle

Presentation
async static simulatePrimeCheckbox(fixture: ComponentFixture<DynamicForm<RegisteredFieldTypes[], { [x: string]: Record<string, unknown>; } & Record<string, unknown>>>, selector: string, checked: boolean): Promise<void>;
Parameters
NameTypeDescription
fixture
ComponentFixture<DynamicForm<RegisteredFieldTypes[], { [x: string]: Record<string, unknown>; } & Record<string, unknown>>>
selector
string
checked
boolean
Returns
Promise<void>
static async

simulatePrimeDropdown()

Simulates user selection on a PrimeNG dropdown/select

Presentation
async static simulatePrimeDropdown(fixture: ComponentFixture<DynamicForm<RegisteredFieldTypes[], { [x: string]: Record<string, unknown>; } & Record<string, unknown>>>, selectSelector: string, value: string | string[]): Promise<void>;
Parameters
NameTypeDescription
fixture
ComponentFixture<DynamicForm<RegisteredFieldTypes[], { [x: string]: Record<string, unknown>; } & Record<string, unknown>>>
selectSelector
string
value
string | string[]
Returns
Promise<void>
static async

simulatePrimeInput()

Simulates user input on a PrimeNG input field

Presentation
async static simulatePrimeInput(fixture: ComponentFixture<DynamicForm<RegisteredFieldTypes[], { [x: string]: Record<string, unknown>; } & Record<string, unknown>>>, selector: string, value: string): Promise<void>;
Parameters
NameTypeDescription
fixture
ComponentFixture<DynamicForm<RegisteredFieldTypes[], { [x: string]: Record<string, unknown>; } & Record<string, unknown>>>
selector
string
value
string
Returns
Promise<void>
static async

simulatePrimeToggle()

Simulates PrimeNG toggle switch (InputSwitch)

Presentation
async static simulatePrimeToggle(fixture: ComponentFixture<DynamicForm<RegisteredFieldTypes[], { [x: string]: Record<string, unknown>; } & Record<string, unknown>>>, selector: string, checked: boolean): Promise<void>;
Parameters
NameTypeDescription
fixture
ComponentFixture<DynamicForm<RegisteredFieldTypes[], { [x: string]: Record<string, unknown>; } & Record<string, unknown>>>
selector
string
checked
boolean
Returns
Promise<void>
static async

updateFormValue()

Updates form value programmatically and waits for PrimeNG to synchronize Use this instead of directly calling fixture.componentRef.setInput('value', ...)

Presentation
async static updateFormValue(fixture: ComponentFixture<DynamicForm<RegisteredFieldTypes[], { [x: string]: Record<string, unknown>; } & Record<string, unknown>>>, value: Record<string, unknown>): Promise<void>;
Parameters
NameTypeDescription
fixture
ComponentFixture<DynamicForm<RegisteredFieldTypes[], { [x: string]: Record<string, unknown>; } & Record<string, unknown>>>
value
Record<string, unknown>
Returns
Promise<void>
static async

waitForInit()

Waits for the PrimeNG dynamic form to initialize

Presentation
async static waitForInit(fixture: ComponentFixture<DynamicForm<RegisteredFieldTypes[], { [x: string]: Record<string, unknown>; } & Record<string, unknown>>>): Promise<void>;
Parameters
NameTypeDescription
fixture
ComponentFixture<DynamicForm<RegisteredFieldTypes[], { [x: string]: Record<string, unknown>; } & Record<string, unknown>>>
Returns
Promise<void>