@syncfusion/ej2-react-form-builder 0.1.0-beta → 35.1.37

package/src/FormBuilder.d.ts

@@ -1,211 +0,0 @@
-import React, { type HTMLAttributes } from 'react';
-import type { FormComponent, PaletteConfig, Schema } from './types/FormSchema';
-import type { DefaultTemplates } from './types/FormSchema';
-/**
- * @private
- */
-export declare let formBuilderMode: string;
-/**
- * @private
- */
-export declare const extractTemplateComponents: (template: DefaultTemplates) => FormComponent[];
-/**
- * The IFormBuilder interface defines the configuration options of the FormBuilder component, which is used to design form schemas.
- */
-export interface IFormBuilder {
-    /**
-     * This is the FormBuilder component element.
-     *
-     * @private
-     * @default null
-     */
-    element?: HTMLElement | null;
-    /**
-     * Specifies the locale of the Form Builder Component.
-     *
-     * @property
-     * @default 'en-US'
-     */
-    locale?: string;
-    /**
-     * Specifies whether the form schema created with the Form Builder can be exported.
-     *
-     * @property
-     * @default true
-     */
-    allowExport?: boolean;
-    /**
-     * Enables or disables the form preview mode option in the Form Builder.
-     *
-     * @property
-     * @default true
-     */
-    enablePreview?: boolean;
-    /**
-     * Specifies the mode of the Form Builder. There are two modes available:
-     * - Simple - This mode limits the supported components and options in the Form Builder to provide ease for non-technical users.
-     * - Developer - This mode enables the complete features in the Form Builder. This is the default mode.
-     *
-     * @property
-     * @default true
-     */
-    mode?: 'Simple' | 'Developer';
-    /**
-     * Specifies whether the form schema state should be persisted in the Form Builder. The local storage is used to maintain the persistence behavior.
-     *
-     * @property
-     * @default false
-     */
-    enablePersistence?: boolean;
-    /**
-     * Specifies whether the form elements to be displayed in Right to Left.
-     *
-     * @property
-     * @default false
-     */
-    enableRtl?: boolean;
-    /**
-     * This property is used to provide a set of custom components in addition to the existing form field components.
-     *
-     * @property
-     * @default undefined (uses defaultTemplates)
-     */
-    formTemplates?: DefaultTemplates[];
-    /**
-     * This property is used to modify the components for the form fields in basic, advanced, and layout categories in the left panel of the Form Builder.
-     *
-     * @example
-     * paletteConfig={{
-     *   [ComponentCategory.BASIC]: [
-     *     { type: FormComponentType.TEXTBOX, category: 'basic' },
-     *     { type: FormComponentType.CHECKBOX, category: 'basic' }
-     *   ],
-     *   [ComponentCategory.ADVANCED]: [
-     *     { type: FormComponentType.MULTISELECT, category: 'advanced' }
-     *   ]
-     * }}
-     *
-     * @property
-     * @private
-     * @default undefined (uses defaultPalette)
-     */
-    paletteConfig?: PaletteConfig;
-    /**
-     * Event triggered when a component property is changed in the property panel.
-     * Fires on every property value change with details of the changed field.
-     *
-     * @event
-     *
-     * @param args - Event data containing label, property key, value, and component id
-     */
-    onPropertyChanged?: (args: PropertyChangedEventArgs) => void;
-    /**
-     * Event triggered when a field drag operation starts.
-     * Fires for both root-level and nested container drags.
-     *
-     * @event
-     *
-     * @param args - Event data containing component and source container info
-     */
-    onFieldDragStarted?: (args: FieldDragStartedEventArgs) => void;
-    /**
-     * Event triggered when a dragged field is over a valid drop zone.
-     * Fires repeatedly while hovering over drop targets.
-     *
-     * @event
-     *
-     * @param args - Event data containing target container info
-     */
-    onFieldDraggingOver?: (args: FieldDraggingOverEventArgs) => void;
-    /**
-     * Event triggered when a field drop operation completes.
-     * Fires for successful drops in both root and nested containers.
-     *
-     * @event
-     *
-     * @param args - Event data containing source, target, and drop details
-     */
-    onFieldDropped?: (args: FieldDroppedEventArgs) => void;
-    /**
-     * This property facilitates an optional initial form schema to load in the Form Builder.
-     *
-     * @property
-     * @default null
-     */
-    schema?: Schema | any;
-    /**
-     * Gets the current form settings as a JSON string in the required export format.
-     *
-     * @returns Form settings JSON string
-     * @private
-     */
-    getFormSettings(): any;
-}
-/**
- * FormBuilder component props (used for JSX props, excludes imperative methods)
- */
-type IFormBuilderProps = Omit<IFormBuilder, 'element' | 'getFormSettings'> & HTMLAttributes<HTMLDivElement>;
-/**
- * The FormBuilder component provides a visual, drag-and-drop interface for authoring form schemas. It supports palette customization, template insertion, dual modes (Simple/Developer), and emits structural form schemas (FormSchema) that can be consumed by FormRenderer.
- *
- * ```typescript
- * import { FormBuilder } from '@syncfusion/ej2-react-form-builder';
- *
- * <FormBuilder />
- * ```
- */
-export declare const FormBuilder: React.ForwardRefExoticComponent<IFormBuilderProps & React.RefAttributes<IFormBuilder>>;
-declare const _default: React.NamedExoticComponent<Omit<IFormBuilder, "element" | "getFormSettings"> & React.HTMLAttributes<HTMLDivElement> & React.RefAttributes<IFormBuilder>>;
-export default _default;
-/**
- * This event argument provides details when a form field's drag action starts.
- */
-export interface FieldDragStartedEventArgs {
-    /** Specifies the name of the component being dragged. */
-    componentName: string | null;
-    /** Specifies the type of the component (e.g., 'textbox', 'dropdown', 'panel'). */
-    componentType: string;
-    /** Specifies the container ID where the drag originated ('root', panel ID, table ID, etc.). */
-    sourceContainerId: string;
-    /** Specifies whether this is a nested container drag. */
-    isNested: boolean;
-}
-/**
- * This event argument provides details when a form field's drag action is in progress over a drop zone.
- */
-export interface FieldDraggingOverEventArgs {
-    /** Specifies whether hovering over a nested container. */
-    isNested: boolean;
-}
-/**
- * This event argument provides details when a form field's drag action is completed by dropping on a drop zone.
- */
-export interface FieldDroppedEventArgs {
-    /** Specifies the name of the dropped component */
-    componentName: string;
-    /** Specifies whether the component was reordered. */
-    isReordered: boolean;
-    /** Specifies the type of the component. */
-    componentType: string;
-    /** Specifies the source container ID ('root', panel ID, 'palette' for new components) which acts as a drop zone. */
-    sourceContainerId: string;
-    /** Specifies the target container ID where the component was dropped. */
-    targetContainerId: string;
-}
-/**
- * This event argument provides details when a property value changes in the property panel.
- */
-export interface PropertyChangedEventArgs {
-    /**
-     * Specifies the display label of the changed property.
-     *
-     * @private
-     */
-    field: string;
-    /** Specifies the property name of the field. */
-    property: string;
-    /** Specifies the new value of the property. */
-    value: any;
-    /** Specifies the name of the component being edited. */
-    name: string;
-}