@stemy/ngx-dynamic-form 19.8.16 → 19.8.18

package/ngx-dynamic-form/common-types.d.ts

@@ -185,14 +185,59 @@ export type FormFieldExpressions = {
     "props.required"?: FormFieldExpression<boolean>;
 };
 export interface FormFieldConfig<T = FormFieldProps> extends FormlyFieldConfig<T> {
+    /**
+     * Conditional check if the field should be serialized or not, normal serialization can happen even if the field is hidden
+     */
     serialize?: FormFieldConditionFn;
+    /**
+     * This is a custom serializer callback function.
+     */
     serializer?: FormFieldSerializer;
+    /**
+     * Puts the field in a custom field set
+     */
     fieldSet?: string;
+    /**
+     * Optionally change the default label prefix for this field and its children
+     */
+    labelPrefix?: string;
+    /**
+     * Optional key to use when requesting a ng-template for the field control (instead of key || id)
+     */
+    controlTemplateKey?: string;
+    /**
+     * Optional key to use when requesting a ng-template for the field label (instead of key || id)
+     */
+    labelTemplateKey?: string;
+    /**
+     * Optional key to use when requesting a ng-template for the field input (instead of key || id)
+     */
+    inputTemplateKey?: string;
+    /**
+     * Optional key to use when requesting a ng-template for the field prefix (instead of key || id)
+     */
+    prefixTemplateKey?: string;
+    /**
+     * Optional key to use when requesting a ng-template for the field suffix (instead of key || id)
+     */
+    suffixTemplateKey?: string;
+    /**
+     * Gives purpose to a field (can be used as a filter in serialization)
+     */
     purposes?: string[];
+    /**
+     * Use this field as a field set instead of a keyed form group
+     */
     asFieldSet?: boolean;
     priority?: number;
     fieldGroup?: FormFieldConfig[];
+    /**
+     * Definition of how array items look
+     */
     fieldArray?: FormFieldConfig;
+    /**
+     * Custom field hook definitions
+     */
     hooks: FormHookConfig;
     expressions: FormFieldExpressions;
     readonly parent?: FormFieldConfig;
@@ -287,6 +332,30 @@ export type FormFieldData = Pick<FormFieldProps, "label" | "labelAlign" | "descr
      * Puts the field in a custom field set
      */
     fieldSet?: string;
+    /**
+     * Optionally change the default label prefix for this field and its children
+     */
+    labelPrefix?: string;
+    /**
+     * Optional key to use when requesting a ng-template for the field control (instead of key || id)
+     */
+    controlTemplateKey?: string;
+    /**
+     * Optional key to use when requesting a ng-template for the field label (instead of key || id)
+     */
+    labelTemplateKey?: string;
+    /**
+     * Optional key to use when requesting a ng-template for the field input (instead of key || id)
+     */
+    inputTemplateKey?: string;
+    /**
+     * Optional key to use when requesting a ng-template for the field prefix (instead of key || id)
+     */
+    prefixTemplateKey?: string;
+    /**
+     * Optional key to use when requesting a ng-template for the field suffix (instead of key || id)
+     */
+    suffixTemplateKey?: string;
     /**
      * Gives purpose to a field (can be used as a filter in serialization)
      */
@@ -329,12 +398,12 @@ export type FormGroupData = FormFieldData & Pick<FormFieldProps, "useTabs"> & {
 };
 export type FormArrayData = FormFieldData & Pick<FormFieldProps, "useTabs" | "tabsLabel" | "insertItem" | "cloneItem" | "moveItem" | "removeItem" | "addItem" | "clearItems">;
 export type FormSerializerData = RequireAtLeastOne<Pick<FormFieldData, "serialize" | "serializer">>;
-export type FormFieldSetData = RequireAtLeastOne<Pick<FormFieldData, "classes" | "layout">> & {
+export type FormFieldSetData = RequireAtLeastOne<Pick<FormFieldData, "label" | "labelPrefix" | "classes" | "layout">> & {
     id: string;
 };
 export type AsyncSubmitMode = "click" | "submit" | "all";
 export type AsyncSubmitMethod = (form: IDynamicForm, context?: any, ev?: MouseEvent) => Promise<IAsyncMessage>;
-export type FormTemplateType = "control" | "label" | "input" | "prefix" | "suffix" | "setPrefix" | "setSuffix";
+export type FormTemplateType = "control" | "label" | "input" | "prefix" | "suffix";
 export type FormFieldCustomizer = (field: FormFieldConfig, options: FormBuilderOptions, injector: Injector, property: OpenApiSchemaProperty, schema: OpenApiSchema) => MaybePromise<MaybeArray<FormFieldConfig>>;
 export interface ConfigForSchemaOptionsBase extends FormBuilderOptionsBase {
     fieldCustomizer?: FormFieldCustomizer;

package/ngx-dynamic-form/components/dynamic-form/dynamic-form.component.d.ts

@@ -5,12 +5,15 @@ import { EventsService } from "@stemy/ngx-utils";
 import { FormFieldChangeEvent, FormFieldConfig, FormFieldLabelCustomizer, FormSerializeResult, IDynamicForm } from "../../common-types";
 import { DynamicFormBuilderService } from "../../services/dynamic-form-builder.service";
 import { DynamicFormService } from "../../services/dynamic-form.service";
+import { DynamicFormTemplateService } from "../../services/dynamic-form-template.service";
 import * as i0 from "@angular/core";
 export declare class DynamicFormComponent implements IDynamicForm {
     readonly forms: DynamicFormService;
+    protected readonly templates: DynamicFormTemplateService;
     protected readonly builder: DynamicFormBuilderService;
     protected readonly events: EventsService;
     protected readonly languages: import("@stemy/ngx-utils").ILanguageService;
+    readonly globalTemplatePrefix: import("@angular/core").InputSignal<string>;
     readonly labelPrefix: import("@angular/core").InputSignal<string>;
     readonly labelCustomizer: import("@angular/core").InputSignal<FormFieldLabelCustomizer>;
     readonly testId: import("@angular/core").InputSignal<string>;
@@ -32,12 +35,12 @@ export declare class DynamicFormComponent implements IDynamicForm {
     readonly onValueChanges: import("@angular/core").OutputRef<FormFieldChangeEvent>;
     readonly onInit: import("@angular/core").OutputRef<FormFieldChangeEvent>;
     readonly options: FormlyFormOptions;
-    constructor(forms: DynamicFormService);
+    constructor(forms: DynamicFormService, templates: DynamicFormTemplateService);
     submit(): void;
     reset(): void;
     serialize(validate?: boolean, ...purposes: string[]): Promise<FormSerializeResult>;
     getField(path: string): FormFieldConfig;
     getControl(path: string): AbstractControl;
     static ɵfac: i0.ɵɵFactoryDeclaration<DynamicFormComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<DynamicFormComponent, "dynamic-form", never, { "labelPrefix": { "alias": "labelPrefix"; "required": false; "isSignal": true; }; "labelCustomizer": { "alias": "labelCustomizer"; "required": false; "isSignal": true; }; "testId": { "alias": "testId"; "required": false; "isSignal": true; }; "useTabs": { "alias": "useTabs"; "required": false; "isSignal": true; }; "legacyLabels": { "alias": "legacyLabels"; "required": false; "isSignal": true; }; "data": { "alias": "data"; "required": false; "isSignal": true; }; "fields": { "alias": "fields"; "required": false; "isSignal": true; }; }, { "onSubmit": "onSubmit"; "onFieldChanges": "onFieldChanges"; "onValueChanges": "onValueChanges"; "onInit": "onInit"; }, never, ["*"], false, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<DynamicFormComponent, "dynamic-form", never, { "globalTemplatePrefix": { "alias": "globalTemplatePrefix"; "required": false; "isSignal": true; }; "labelPrefix": { "alias": "labelPrefix"; "required": false; "isSignal": true; }; "labelCustomizer": { "alias": "labelCustomizer"; "required": false; "isSignal": true; }; "testId": { "alias": "testId"; "required": false; "isSignal": true; }; "useTabs": { "alias": "useTabs"; "required": false; "isSignal": true; }; "legacyLabels": { "alias": "legacyLabels"; "required": false; "isSignal": true; }; "data": { "alias": "data"; "required": false; "isSignal": true; }; "fields": { "alias": "fields"; "required": false; "isSignal": true; }; }, { "onSubmit": "onSubmit"; "onFieldChanges": "onFieldChanges"; "onValueChanges": "onValueChanges"; "onInit": "onInit"; }, never, ["*"], false, never>;
 }

package/ngx-dynamic-form/services/dynamic-form-builder.service.d.ts

@@ -26,7 +26,7 @@ export declare class DynamicFormBuilderService {
     createFormSerializer(key: string, data: FormFieldSerializer | FormSerializerData): Partial<FormFieldConfig>;
     fixSelectOptions(field: FormFieldConfig, options: FormSelectOption[]): Promise<FormSelectOption[]>;
     protected isFieldset(field: FormFieldConfig): boolean;
-    protected getLabel(key: string, label: string, parent: FormFieldConfig, options: FormBuilderOptions, legacyPrefix?: string): string;
+    protected getLabel(key: string, label: string, labelPrefix: string, parent: FormFieldConfig, options: FormBuilderOptions, legacyPrefix?: string): string;
     protected createFormField(key: string, type: string, data: FormFieldData, props: FormFieldProps, parent: FormFieldConfig, options?: FormBuilderOptions): FormFieldConfig;
     protected isValid(field: FormFieldConfig): boolean;
     protected setExpressions(field: FormFieldConfig, options: FormBuilderOptions): void;

package/ngx-dynamic-form/services/dynamic-form-template.service.d.ts

@@ -1,13 +1,19 @@
 import { TemplateRef } from "@angular/core";
 import { Subject } from "rxjs";
+import { GlobalTemplateService } from "@stemy/ngx-utils";
 import { FormTemplateType } from "../common-types";
 import * as i0 from "@angular/core";
 export declare class DynamicFormTemplateService {
+    protected readonly globalTemplates: GlobalTemplateService;
     readonly templatesUpdated: Subject<void>;
     protected templates: Map<FormTemplateType, Map<string, TemplateRef<any>>>;
-    constructor();
+    protected globalTemplatePrefix: string;
+    get globalPrefix(): string;
+    set globalPrefix(value: string);
+    constructor(globalTemplates: GlobalTemplateService);
     isValidType(type: string): boolean;
     get(type: FormTemplateType, key: string): TemplateRef<any>;
+    protected getGlobalTemplate(type: FormTemplateType, key: string): TemplateRef<any>;
     add(key: string, type: FormTemplateType, template: TemplateRef<any>): void;
     remove(key: string, type: FormTemplateType): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<DynamicFormTemplateService, never>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stemy/ngx-dynamic-form",
-  "version": "19.8.16",
+  "version": "19.8.18",
   "license": "MIT",
   "public": true,
   "repository": "https://github.com/stemyke/ngx-dynamic-form.git",