@syncfusion/ej2-form-renderer 34.2.8 → 35.1.37

package/src/form-renderer/form-renderer.d.ts

@@ -1,425 +0,0 @@
-import { Component, EmitType } from '@syncfusion/ej2-base';
-import { FormLayout, Schema } from './types/form-schema';
-import { FormRendererModel } from './form-renderer-model';
-/**
- * Specifies the types for the form field data values.
- */
-export declare type FieldDataType = string | number | boolean | string[] | number[] | Date | Record<string, unknown> | object | unknown[] | null;
-/**
- * This event argument provides details for field value changes during form interaction.
- */
-export interface ChangeEventArgs {
-    /** Provides the unique name/identifier of the changed field */
-    fieldName: string;
-    /** Specifies the display text/label of the form field. */
-    label: string;
-    /** Specifies the new value of the field */
-    value: FieldDataType;
-}
-/**
- * This event argument provides details for form submission.
- */
-export interface SubmitEventArgs {
-    /** Provides the complete form data object keyed by field names */
-    data: Record<string, FieldDataType>;
-    /** Specifies whether the form passed all validation rules */
-    isValid: boolean;
-}
-/**
- * This event argument provides details for custom button clicks within the rendered form.
- */
-export interface ButtonClickEventArgs {
-    /** Specifies the unique identifier of the clicked button */
-    fieldName: string;
-    /** Specifies the display text/label of the clicked button */
-    label: string;
-    /** Provides the original button click event. */
-    event: any;
-}
-/**
- * Event arguments describing a failure/warning that occurred in the form renderer.
- */
-export interface FailureEventArgs {
-    /** The underlying error error/warning or exception. */
-    error: any;
-}
-/**
- * @private
- */
-export declare const defaultLocale: {
-    "unsupportedComponent": string;
-};
-/**
- * The FormRenderer component consumes a JSON form schema and renders a fully functional, Syncfusion-based form. It handles field mapping, conditional visibility/disabling, expression evaluation, custom validation, and data submission.
- *
- * ```typescript
- * let form: FormRenderer = new FormRenderer({
- *   schema: formSchema,
- *   submit: (args: SubmitEventArgs) => console.log(args)
- * });
- * form.appendTo('#container');
- * ```
- */
-export declare class FormRenderer extends Component<HTMLElement> {
-    /**
-     * Specifies the data schema of the form that needs to be rendered in the Form Renderer.
-     */
-    schema: Schema | string | Record<string, unknown> | null;
-    /**
-     * Specifies the form layout configuration (only applies when layout details are NOT available in the schema). Determines how form fields are arranged in columns.
-     *
-     * @default 'SingleColumn'
-     */
-    layout: FormLayout | string;
-    /**
-     * Specifies the CSS class name to apply to the root form container element. This property supports space-separated multiple classes.
-     *
-     * @default ""
-     */
-    className: string;
-    /**
-     * Event triggered when the form is submitted.
-     * This event provides form data and validation status in the event argument.
-     *
-     * @event
-     */
-    submit: EmitType<SubmitEventArgs>;
-    /**
-     * Event triggered when any form field value changes. Fired on user input for tracked fields.
-     *
-     * @event
-     */
-    change: EmitType<ChangeEventArgs>;
-    /**
-     * Event triggered when a button in the form is clicked. Applies to all button types (button, submit, splitButton).
-     *
-     * @event
-     */
-    buttonClick: EmitType<ButtonClickEventArgs>;
-    /**
-     * Event triggered when an error is thrown in the form rendering or schema parsing.
-     *
-     * @event
-     */
-    failure: EmitType<FailureEventArgs>;
-    /**
-     * Event triggered when all form elements are rendered and ready for interaction. Useful for performing post-render initialization or setup.
-     *
-     * @event
-     */
-    created: EmitType<Object>;
-    /**
-     * Constructor for creating the widget
-     *
-     * @param  {FormRendererModel} options - Specifies the form renderer model
-     * @param  {string|HTMLDivElement} element - Specifies the target element
-     */
-    constructor(options?: FormRendererModel, element?: string | HTMLDivElement);
-    private processedSchemaCache;
-    /** Localization instance */
-    private l10n;
-    /**
-     * @private
-     *
-     * Minimal form-state container owned by the orchestrator. The previous
-     * vanilla-TS port delegated this to `FormStateBridge`; that bridge's
-     * `registeredFields` gate silently short-circuited every field to "no
-     * error" because the orchestrator never called `registerField`. The
-     * EJ2 native `FormValidator` (bound to `this.element`) now handles all
-     * rule evaluation, error-element placement, change/blur/submit wiring,
-     * and ARIA — exactly what `FormValidator` was designed for. This object
-     * is the orchestrator's authoritative values store; `errors` are
-     * mirrored from the FormValidator's `errorRules` for `renderField`'s
-     * initial-paint logic and for submit-time `isValid` checks.
-     */
-    private formState;
-    /** EJ2 native FormValidator bound to `this.element` (replaces FormStateBridge). */
-    private validator;
-    /** Map of input component instances keyed by `name` (or `${name}_${idx}`). */
-    private inputRefs;
-    /** Conditional value applied tracker (per-field). */
-    private conditionalValueApplied;
-    /** Expression engine + dependency graph + computed-field set. */
-    private expressionEngine;
-    private expressionDependencyGraph;
-    private expressionEvaluationInProgress;
-    private previousFormValues;
-    private computedFieldNames;
-    /** Custom validation engine instance. */
-    private customValidationEngine;
-    /** Latest form values snapshot for custom validation (named-key context). */
-    private currentFormValues;
-    /** Whether initial values have been seeded once. */
-    private isInitialized;
-    /** Cached layout detection result. */
-    private hasLayoutComponentsCache;
-    /** Cached id→label map. */
-    private idToLabelCache;
-    /** Cached initial values (recomputed on schema change). */
-    private initialValuesCache;
-    /** Rendered child EJ2 instances (for destroy cleanup). */
-    private renderedInstances;
-    /** Tooltip instances keyed by field id so stale tooltips can be replaced promptly. */
-    private tooltipRefs;
-    /** `created` fired-once guard. */
-    private createdFired;
-    /**
-     * Coalescing guard for `scheduleRerender`. Prevents redundant full-form
-     * re-renders within a single microtask — mirrors React's batched-state
-     * semantics so that a user keystroke + expression cascade fire one render.
-     */
-    private rerenderScheduled;
-    /**
-     * Set of `component.id`s that are referenced as the trigger field of any
-     * other component's `conditions` (`visibleWhen` / `hideWhen` /
-     * `disabledWhen` / `requiredWhen` / `readOnlyWhen` / `setValueWhen` /
-     * `choiceBasedField.primaryFieldId`). Only changes to these fields can
-     * affect visibility / disabled / required / valueWhen of any other
-     * field, so only they need to trigger a full-form re-render. Changes to
-     * fields *not* in this set are guaranteed to have no conditional side
-     * effects and safely skip the (expensive) full DOM teardown + rebuild.
-     * Built once per schema in `buildConditionalDependencyMap`.
-     */
-    private conditionalTriggerFieldIds;
-    /**
-     * Maps `component.id` → the previously-rendered DOM subtree (form-group)
-     * for "expensive" components (dataGrid, dropdown, multiselect,
-     * checkboxGroup) that support remote data. During a full-form re-render
-     * triggered by an *unrelated* conditional change, these subtrees are
-     * detached (not destroyed) and re-attached in place, avoiding a re-fetch
-     * of their remote data sources and preventing the visible blink/reload.
-     * A subtree is *invalidated* (dropped from this map, forcing a fresh
-     * render) when a field it depends on (via its own `conditions` or
-     * `conditionalData`) is the one that changed.
-     */
-    private preservedFields;
-    /**
-     * Component types eligible for DOM preservation across re-renders.
-     * These types either bind remote data (dataGrid, lookup-backed
-     * dropdown/multiselect) or render many child options (checkboxGroup)
-     * and are noticeably expensive / flicker-prone to rebuild.
-     */
-    private static readonly PRESERVABLE_TYPES;
-    /**
-     * Per-consumer dependency map: `component.id` → set of trigger field ids
-     * that the consumer's own `conditions` / `conditionalData` /
-     * `choiceBasedField` reference. Used during `rerenderForm` to decide
-     * whether a preserved subtree must be invalidated (rebuilt) because the
-     * changed field is one of its own dependencies, or can be safely reused.
-     */
-    private consumerDependencyMap;
-    /**
-     * Returns the EJ2 component module name.
-     * @private
-     */
-    getModuleName(): string;
-    /**
-     * Return the persisted-state payload. The base class declares this
-     * abstract; FormRenderer does not implement state persistence, so an
-     * empty object is returned (mirrors the EJ2 convention for
-     * non-persistent components).
-     * @private
-     */
-    getPersistData(): string;
-    /**
-     * Pre-render wiring: enable ripple, init the expression engine + bridge.
-     * @private
-     */
-    protected preRender(): void;
-    /**
-     * Main render: normalize schema, build rules + initial values, render tree.
-     * @private
-     */
-    protected render(): void;
-    /**
-     * @private
-     */
-    private normalizeSchema;
-    /**
-     * Recursively scan the schema for any `table`/`tabs`/`panel`/`card`
-     * (including inside table cells and tab content). Mirrors `hasLayoutComponents`.
-     * @private
-     */
-    private computeHasLayoutComponents;
-    /**
-     * The layout CSS class (suppressed when layout components are present).
-     * @private
-     */
-    private readonly layoutClass;
-    /**
-     * Recursively collect all components including nested ones.
-     * @private
-     */
-    private collectAllComponents;
-    /**
-     * @private
-     */
-    private computeIdToLabel;
-    /**
-     * @private
-     */
-    private buildValidationRulesAndBridge;
-    /**
-     * @private
-     *
-     * Mirror the FormValidator's `errorRules` array into `this.formState.errors`
-     * keyed by field `name` (= `component.id`). Called after every
-     * `validationComplete` callback and from submit-time `isValid` reads.
-     */
-    private syncFormStateErrors;
-    /**
-     * @private
-     */
-    private buildInitialValues;
-    /**
-     * Initialize the expression engine dependency graph + computed-field set.
-     * @private
-     */
-    private initExpressionEngine;
-    /**
-     * @private
-     */
-    private disposeTooltipInstance;
-    private renderField;
-    /**
-     * @private
-     */
-    private renderComponent;
-    /**
-     * @private
-     */
-    private afterValueChange;
-    /**
-     * @private
-     */
-    private beforeValidate;
-    /**
-     * @private
-     *
-     * Coalesced full-form re-render. Multiple triggers within the same
-     * microtask drain into a single `rerenderForm()` call. The set of
-     * changed field ids is accumulated across the tick so `rerenderForm`
-     * can decide which preserved subtrees must be invalidated (because one
-     * of the changed fields is in their own dependency set).
-     */
-    private pendingChangedFieldIds;
-    private scheduleRerender;
-    /**
-     * @private
-     *
-     * Recursively walk a `ConditionType` (a `ConditionalRule { field }` leaf
-     * or a `CompositeConditionalRule { rules: [...] }` tree) and collect the
-     * `field` ids of every leaf rule into the supplied `acc` set. These are
-     * the trigger ids whose value changes can affect the visibility/disabled/
-     * required/readOnly/valueWhen of the component that owns this `conditions`.
-     */
-    private collectConditionFieldIds;
-    private collectDataSourceReferenceIds;
-    /**
-     * @private
-     *
-     * Build `this.conditionalTriggerFieldIds` — the set of every
-     * `component.id` that is referenced by *any* other component's
-     * `conditions` (visibleWhen / hideWhen / disabledWhen / requiredWhen /
-     * readOnlyWhen / setValueWhen / choiceBasedField.primaryFieldId).
-     * Only changes to ids in this set can affect another field's
-     * visibility/enabled/required/value, so only they need to trigger a
-     * full-form re-render. Called once per schema during `render()`.
-     */
-    private buildConditionalDependencyMap;
-    /**
-     * @private
-     *
-     * Returns `true` if a value change to `fieldId` can affect any other
-     * field's conditional state (visibility/disabled/required/readOnly/
-     * valueWhen/choiceBasedField) — i.e. `fieldId` is in the
-     * `conditionalTriggerFieldIds` set built by
-     * `buildConditionalDependencyMap`. Used by `afterValueChange` to skip
-     * the expensive full-form re-render when the changed field is not a
-     * conditional trigger.
-     */
-    private isConditionalTrigger;
-    /**
-     * @private
-     *
-     * Tear down the rendered tree and re-render it, preserving user-entered
-     * `formState.values` (carried through `buildValidationRulesAndBridge`'s
-     * `previousValues` merge) and restoring keyboard focus to the field that
-     * had it before re-render (so a user typing in a textbox is not
-     * interrupted by a dependent field appearing/disappearing on the page).
-     */
-    private rerenderForm;
-    /**
-     * @private
-     */
-    private removePreviousRoot;
-    /**
-     * @private
-     */
-    private destroyRenderedInstance;
-    /**
-     * @private
-     *
-     * Destroy all rendered EJ2 instances except those whose host element
-     * lives inside a preserved subtree (those are kept alive for re-use in
-     * the upcoming `render()` pass). Mirrors `destroyRendered` but skips
-     * instances rooted in `preservedFields` nodes.
-     */
-    private destroyRenderedExcludingPreserved;
-    /**
-     * @private
-     *
-     * Destroy EJ2 instances whose host element lives inside a preserved
-     * subtree that was NOT re-attached (field became hidden). Used during
-     * the post-render cleanup pass in `rerenderForm`.
-     */
-    private destroyPreservedSubtree;
-    private getInputElementByName;
-    /**
-     * Evaluate expressions in topological order with type coercion.
-     * @private
-     */
-    private evaluateExpressions;
-    /**
-     * Re-trigger custom validation for changed + dependent fields.
-     * @private
-     */
-    private retriggerCustomValidation;
-    /**
-     * @private
-     */
-    private handleSubmitData;
-    /**
-     * Retrieves the underlying Syncfusion form-input component instance by its field name. Use this to call Syncfusion component methods and properties.
-     */
-    getComponent(name: string): object | null;
-    /**
-     * Re-normalize + re-render on `schema`/`locale`/`enableRtl` change.
-     * @private
-     */
-    protected onPropertyChanged(newProps: {
-        [key: string]: any;
-    }, oldProps: {
-        [key: string]: any;
-    }): void;
-    /**
-     * Destroy all child EJ2 instances, detach listeners, null refs.
-     * @private
-     */
-    private destroyRendered;
-    /**
-     * Remove persisted tab selection state for this form when it is fully destroyed.
-     * @private
-     */
-    private clearPersistedTabSelections;
-    /**
-     * Full component teardown.
-     * @private
-     */
-    destroy(): void;
-    /**
-     * @private
-     */
-    private clearEngineCaches;
-}
-export default FormRenderer;