@syncfusion/ej2-form-renderer 34.2.6 → 35.1.37

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

@@ -0,0 +1,373 @@
+import { Component, EmitType, ChildProperty } from '@syncfusion/ej2-base';
+import { FormLayout, Schema } from './types/form-schema';
+import { FormRendererModel, CustomWidgetSettingModel } 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;
+    /** Specifies all the current form field values */
+    dataModel: object;
+}
+/**
+ * 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;
+};
+/**
+ * Specifies the custom widget settings for rendering custom templates for existing FormComponentTypes.
+ */
+export declare class CustomWidgetSetting extends ChildProperty<CustomWidgetSetting> {
+    /**
+     * Specifies the template content to be used.
+     *
+     * @default null
+     * @angularType string | object
+     * @reactType string | function | JSX.Element
+     * @vueType string | function
+     * @aspType string
+     */
+    template: string | HTMLElement | Function;
+    /**
+     * Specifies the type of the widget to which the template must be bound. The values will be FormComponentType.
+     *
+     * @default ''
+     */
+    type: string;
+    /**
+     * Specifies an optional template identifier. When set, the template is rendered to the JSON object whose templateId matches this value, irrespective of the type.
+     *
+     * @default ''
+     */
+    templateId: string;
+    /**
+     * Specifies the name of the field to which the template must be bound. When set, the template is rendered to the control with the matching name, irrespective of the type property value.
+     *
+     * @default ''
+     */
+    fieldName: 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 initial values for form fields by field name.
+     *
+     * @default null
+     */
+    dataModel: Record<string, FieldDataType> | 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;
+    /**
+     * Specifies the custom widget settings to bind and render custom templates for form fields.
+     *
+     * @default null
+     */
+    customWidgetSettings: CustomWidgetSettingModel[];
+    /**
+     * Specifies whether to enable the sanitization of untrusted HTML in custom widget string/script templates (`customWidgetSettings[].template`).
+     *
+     * @default false
+     */
+    enableHtmlSanitizer: boolean;
+    /**
+     * 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>;
+    /**
+     * @private
+     */
+    constructor(options?: FormRendererModel, element?: string | HTMLDivElement);
+    private processedSchemaCache;
+    private l10n;
+    /**
+     * @private
+     */
+    private formState;
+    private validator;
+    private inputRefs;
+    private conditionalValueApplied;
+    private expressionEngine;
+    private expressionDependencyGraph;
+    private expressionEvaluationInProgress;
+    private previousFormValues;
+    private computedFieldNames;
+    private customValidationEngine;
+    private currentFormValues;
+    private isInitialized;
+    private hasLayoutComponentsCache;
+    private idToLabelCache;
+    private initialValuesCache;
+    private renderedInstances;
+    private tooltipRefs;
+    private createdFired;
+    private rerenderScheduled;
+    private conditionalTriggerFieldIds;
+    private preservedFields;
+    private static readonly PRESERVABLE_TYPES;
+    private consumerDependencyMap;
+    /**
+     * @private
+     */
+    getModuleName(): string;
+    /**
+     * @private
+     */
+    getPersistData(): string;
+    /**
+     * @private
+     */
+    protected preRender(): void;
+    /**
+     * @private
+     */
+    protected render(): void;
+    private refreshRenderedComponent;
+    /**
+     * @private
+     */
+    private normalizeSchema;
+    /**
+     * @private
+     */
+    private computeHasLayoutComponents;
+    /**
+     * @private
+     */
+    private readonly layoutClass;
+    /**
+     * @private
+     */
+    private collectAllComponents;
+    private getDataModelByName;
+    /**
+     * @private
+     */
+    private computeIdToLabel;
+    /**
+     * @private
+     */
+    private buildValidationRulesAndBridge;
+    /**
+     * @private
+     */
+    private syncFormStateErrors;
+    /**
+     * @private
+     */
+    private buildInitialValues;
+    /**
+     * @private
+     */
+    private initExpressionEngine;
+    /**
+     * @private
+     */
+    private disposeTooltipInstance;
+    private renderField;
+    /**
+     * @private
+     */
+    private renderComponent;
+    /**
+     * @private
+     */
+    private afterValueChange;
+    /**
+     * @private
+     */
+    private beforeValidate;
+    /**
+     * @private
+     */
+    private pendingChangedFieldIds;
+    private scheduleRerender;
+    /**
+     * @private
+     */
+    private collectConditionFieldIds;
+    private collectDataSourceReferenceIds;
+    /**
+     * @private
+     */
+    private buildConditionalDependencyMap;
+    /**
+     * @private
+     */
+    private isConditionalTrigger;
+    private getScrollParent;
+    /**
+     * @private
+     */
+    private rerenderForm;
+    /**
+     * @private
+     */
+    private removePreviousRoot;
+    /**
+     * @private
+     */
+    private destroyRenderedInstance;
+    /**
+     * @private
+     */
+    private destroyRenderedExcludingPreserved;
+    /**
+     * @private
+     */
+    private destroyPreservedSubtree;
+    private getInputElementByName;
+    /**
+     * @private
+     */
+    private evaluateExpressions;
+    /**
+     * @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.
+     *
+     * @param {string} name - Specifies the name for the built-in Syncfusion component.
+     * @returns {object | null} - Specifies the instance of the Syncfusion component in the form.
+     */
+    getComponent(name: string): object | null;
+    /**
+     * Programmatically sets a form field's value for user edits.
+     *
+     * @param  {string} fieldName - The field's `name` (the schema property's `name`).
+     * @param  {any} value - The new value to set.
+     * @returns void
+     */
+    setFieldValue(fieldName: string, value: any): void;
+    /**
+     * @private
+     */
+    private syncValueToInput;
+    /**
+     * @private
+     */
+    private static coerceChecked;
+    /**
+     * @private
+     */
+    protected onPropertyChanged(newProps: {
+        [key: string]: any;
+    }, oldProps: {
+        [key: string]: any;
+    }): void;
+    /**
+     * @private
+     */
+    private destroyRendered;
+    /**
+     * @private
+     */
+    private clearPersistedTabSelections;
+    private getTemplateFunction;
+    /**
+     * @private
+     */
+    private sanitizeTemplateValue;
+    /**
+     * @private
+     */
+    destroy(): void;
+    /**
+     * @private
+     */
+    private clearEngineCaches;
+}
+export default FormRenderer;