@elementor/editor-elements 3.33.0-271 → 3.33.0-273

package/dist/index.d.mts

@@ -87,7 +87,7 @@ type V1ElementEditorSettingsProps = {
     component_uid?: string;
 };
 type V1ElementSettingsProps = Record<string, PropValue>;
-type V1ElementConfig = {
+type V1ElementConfig<T = object> = {
     title: string;
     controls: object;
     atomic?: boolean;
@@ -99,7 +99,7 @@ type V1ElementConfig = {
     base_styles?: Record<string, StyleDefinition>;
     base_styles_dictionary?: Record<string, string>;
     atomic_style_states?: ClassState[];
-};
+} & T;
 type V1Model<T> = {
     get: <K extends keyof T>(key: K) => T[K];
     set: <K extends keyof T>(key: K, value: T[K]) => void;
@@ -108,9 +108,19 @@ type V1Model<T> = {
     }) => T;
 };
 
+type ElementModel = {
+    id: string;
+};
+type ElementChildren = Record<string, ElementModel[]>;
+declare function useElementChildren<T extends ElementChildren>(elementId: ElementID, childrenTypes: (keyof T & string)[]): T;
+
+declare const useElementEditorSettings: (elementId: ElementID) => V1ElementEditorSettingsProps;
+
 declare const useElementSetting: <TValue>(elementId: ElementID, settingKey: string) => TValue | null;
 declare const useElementSettings: <TValue>(elementId: ElementID, settingKeys: string[]) => Record<string, TValue>;
 
+declare function useParentElement(elementId: string | null): any;
+
 declare function useSelectedElement(): {
     element: null;
     elementType: null;
@@ -119,16 +129,6 @@ declare function useSelectedElement(): {
     elementType: ElementType;
 };
 
-declare function useParentElement(elementId: string | null): any;
-
-type ElementModel = {
-    id: string;
-};
-type ElementChildren = Record<string, ElementModel[]>;
-declare function useElementChildren<T extends ElementChildren>(elementId: ElementID, childrenTypes: (keyof T & string)[]): T;
-
-declare const useElementEditorSettings: (elementId: ElementID) => V1ElementEditorSettingsProps;
-
 type Options$4 = {
     useHistory?: boolean;
     at?: number;
@@ -144,72 +144,57 @@ type CreateElementParams = {
 };
 declare function createElement({ containerId, model, options }: CreateElementParams): V1Element;
 
-declare const updateElementEditorSettings: ({ elementId, settings, }: {
+type CreateNestedElementsParams = {
+    elements: CreateElementParams[];
+    title: string;
+    subtitle?: string;
+};
+type CreatedElement = {
     elementId: string;
-    settings: V1ElementModelProps["editor_settings"];
-}) => void;
+    model: V1ElementModelProps;
+    createParams: CreateElementParams;
+};
+type CreatedElementsResult = {
+    createdElements: CreatedElement[];
+};
+
+declare const createElements: ({ elements, title, subtitle, }: CreateNestedElementsParams) => CreatedElementsResult;
 
 type Options$3 = {
     useHistory?: boolean;
     at?: number;
-    edit?: boolean;
 };
-type MoveElementParams = {
+declare function deleteElement({ elementId, options, }: {
     elementId: string;
-    targetContainerId: string;
     options?: Options$3;
-};
-declare function moveElement({ elementId, targetContainerId, options }: MoveElementParams): V1Element;
+}): Promise<void>;
 
-type MoveElementsParams = {
-    moves: MoveElementParams[];
-    title: string;
-    subtitle?: string;
-};
-type OriginalPosition = {
-    elementId: string;
-    originalContainerId: string;
-    originalIndex: number;
-};
-type MovedElement = {
-    elementId: string;
-    originalPosition: OriginalPosition;
-    move: MoveElementParams;
-    element: V1Element;
+type Options$2 = {
+    useHistory?: boolean;
+    at?: number;
+    scrollIntoView: boolean;
 };
-type MovedElementsResult = {
-    movedElements: MovedElement[];
+type DropElementParams = {
+    containerId: string;
+    options?: Options$2;
+    model?: Omit<V1ElementModelProps, 'settings' | 'id'> & {
+        settings?: V1ElementSettingsProps;
+        id?: string;
+    };
 };
+declare function dropElement({ containerId, model, options }: DropElementParams): V1Element;
 
-declare const moveElements: ({ moves: movesToMake, title, subtitle, }: MoveElementsParams) => MovedElementsResult;
-
-type Options$2 = {
+type Options$1 = {
     useHistory?: boolean;
     at?: number;
     clone?: boolean;
 };
 type DuplicateElementParams = {
     elementId: string;
-    options?: Options$2;
+    options?: Options$1;
 };
 declare function duplicateElement({ elementId, options }: DuplicateElementParams): V1Element;
 
-type CreateNestedElementsParams = {
-    elements: CreateElementParams[];
-    title: string;
-    subtitle?: string;
-};
-type CreatedElement = {
-    elementId: string;
-    model: V1ElementModelProps;
-    createParams: CreateElementParams;
-};
-type CreatedElementsResult = {
-    createdElements: CreatedElement[];
-};
-
-declare const createElements: ({ elements, title, subtitle, }: CreateNestedElementsParams) => CreatedElementsResult;
-
 type DuplicateElementsParams = {
     elementIds: string[];
     title: string;
@@ -230,14 +215,68 @@ type DuplicatedElementsResult = {
 
 declare const duplicateElements: ({ elementIds, title, subtitle, }: DuplicateElementsParams) => DuplicatedElementsResult;
 
-type Options$1 = {
+declare const generateElementId: () => string;
+
+declare function getContainer(id: string): V1Element | null;
+declare const selectElement: (elementId: string) => void;
+
+declare function getCurrentDocumentContainer(): V1Element | null;
+
+declare function getCurrentDocumentId(): number | null;
+
+declare function getElementEditorSettings(elementId: ElementID): V1ElementEditorSettingsProps;
+
+declare function getElementLabel(elementId?: ElementID): string;
+
+declare const getElementSetting: <TValue>(elementId: ElementID, settingKey: string) => TValue | null;
+declare const getElementSettings: <TValue>(elementId: ElementID, settingKey: string[]) => Record<string, TValue | null>;
+
+declare const getElementStyles: (elementID: ElementID) => Record<string, StyleDefinition> | null;
+
+declare function getElementType(type: string): ElementType | null;
+
+declare function getElements(root?: ElementID): V1Element[];
+
+declare function getSelectedElements(): Element[];
+
+type WidgetsCache<T> = Record<string, T>;
+declare function getWidgetsCache<T extends V1ElementConfig>(): WidgetsCache<T> | null;
+
+type Options = {
     useHistory?: boolean;
     at?: number;
+    edit?: boolean;
 };
-declare function deleteElement({ elementId, options, }: {
+type MoveElementParams = {
     elementId: string;
-    options?: Options$1;
-}): Promise<void>;
+    targetContainerId: string;
+    options?: Options;
+};
+declare function moveElement({ elementId, targetContainerId, options }: MoveElementParams): V1Element;
+
+type MoveElementsParams = {
+    moves: MoveElementParams[];
+    title: string;
+    subtitle?: string;
+    onMoveElements?: () => void;
+    onRestoreElements?: () => void;
+};
+type OriginalPosition = {
+    elementId: string;
+    originalContainerId: string;
+    originalIndex: number;
+};
+type MovedElement = {
+    elementId: string;
+    originalPosition: OriginalPosition;
+    move: MoveElementParams;
+    element: V1Element;
+};
+type MovedElementsResult = {
+    movedElements: MovedElement[];
+};
+
+declare const moveElements: ({ moves: movesToMake, title, subtitle, onMoveElements, onRestoreElements, }: MoveElementsParams) => MovedElementsResult;
 
 type RemoveNestedElementsParams = {
     elementIds: string[];
@@ -259,37 +298,6 @@ type RemovedElementsResult = {
 
 declare const removeElements: ({ elementIds, title, subtitle, onRemoveElements, onRestoreElements, }: RemoveNestedElementsParams) => RemovedElementsResult;
 
-declare function getContainer(id: string): V1Element | null;
-declare const selectElement: (elementId: string) => void;
-
-declare function getElementType(type: string): ElementType | null;
-
-declare const getElementSetting: <TValue>(elementId: ElementID, settingKey: string) => TValue | null;
-declare const getElementSettings: <TValue>(elementId: ElementID, settingKey: string[]) => Record<string, TValue | null>;
-
-declare function getElementEditorSettings(elementId: ElementID): V1ElementEditorSettingsProps;
-
-declare const getElementStyles: (elementID: ElementID) => Record<string, StyleDefinition> | null;
-
-declare function getElementLabel(elementId?: ElementID): string;
-
-declare function getElements(root?: ElementID): V1Element[];
-
-declare function getCurrentDocumentId(): number | null;
-
-declare function getSelectedElements(): Element[];
-
-declare function getWidgetsCache(): Record<string, V1ElementConfig> | null;
-
-type UpdateElementSettingsArgs = {
-    id: ElementID;
-    props: Props;
-    withHistory?: boolean;
-};
-declare const updateElementSettings: ({ id, props, withHistory }: UpdateElementSettingsArgs) => void;
-
-declare const generateElementId: () => string;
-
 type ReplaceElementArgs = {
     currentElement: V1ElementData;
     newElement: Omit<V1ElementModelProps, 'id'>;
@@ -297,22 +305,31 @@ type ReplaceElementArgs = {
 };
 declare const replaceElement: ({ currentElement, newElement, withHistory }: ReplaceElementArgs) => void;
 
-declare function getCurrentDocumentContainer(): V1Element | null;
+declare const updateElementEditorSettings: ({ elementId, settings, }: {
+    elementId: string;
+    settings: V1ElementModelProps["editor_settings"];
+}) => void;
 
-type Options = {
-    useHistory?: boolean;
-    at?: number;
-    scrollIntoView: boolean;
+type UpdateElementSettingsArgs = {
+    id: ElementID;
+    props: Props;
+    withHistory?: boolean;
 };
-type DropElementParams = {
-    containerId: string;
-    options?: Options;
-    model?: Omit<V1ElementModelProps, 'settings' | 'id'> & {
-        settings?: V1ElementSettingsProps;
-        id?: string;
-    };
+declare const updateElementSettings: ({ id, props, withHistory }: UpdateElementSettingsArgs) => void;
+
+type LinkInLinkRestriction = {
+    shouldRestrict: true;
+    reason: 'ancestor' | 'descendant';
+    elementId: string | null;
+} | {
+    shouldRestrict: false;
+    reason?: never;
+    elementId?: never;
 };
-declare function dropElement({ containerId, model, options }: DropElementParams): V1Element;
+declare function getLinkInLinkRestriction(elementId: string): LinkInLinkRestriction;
+declare function getAnchoredDescendantId(elementId: string): string | null;
+declare function getAnchoredAncestorId(elementId: string): string | null;
+declare function isElementAnchored(elementId: string): boolean;
 
 declare const ELEMENT_STYLE_CHANGE_EVENT = "elementor/editor-v2/editor-elements/style";
 declare const styleRerenderEvents: (_elementor_editor_v1_adapters.CommandEventDescriptor | _elementor_editor_v1_adapters.WindowEventDescriptor)[];
@@ -333,6 +350,8 @@ declare function shouldCreateNewLocalStyle<T>(payload: {
     provider: T | null;
 } | null): boolean;
 
+declare function deleteElementStyle(elementId: ElementID, styleId: StyleDefinitionID): void;
+
 type UpdateElementStyleArgs = {
     elementId: ElementID;
     styleId: StyleDefinition['id'];
@@ -342,21 +361,7 @@ type UpdateElementStyleArgs = {
 };
 declare function updateElementStyle(args: UpdateElementStyleArgs): void;
 
-declare function deleteElementStyle(elementId: ElementID, styleId: StyleDefinitionID): void;
-
-type LinkInLinkRestriction = {
-    shouldRestrict: true;
-    reason: 'ancestor' | 'descendant';
-    elementId: string | null;
-} | {
-    shouldRestrict: false;
-    reason?: never;
-    elementId?: never;
-};
-declare function getLinkInLinkRestriction(elementId: string): LinkInLinkRestriction;
-declare function getAnchoredDescendantId(elementId: string): string | null;
-declare function getAnchoredAncestorId(elementId: string): string | null;
-declare function isElementAnchored(elementId: string): boolean;
+declare const useElementInteractions: (elementId: ElementID) => string;
 
 declare function getElementInteractions(elementId: ElementID): string;
 
@@ -366,8 +371,6 @@ declare const updateElementInteractions: ({ elementId, interactions, }: {
 }) => void;
 declare const playElementInteractions: (elementId: string) => void;
 
-declare const useElementInteractions: (elementId: ElementID) => string;
-
 declare function initMcp(): void;
 
 export { type Control, type ControlItem, type ControlLayout, type ControlsSection, type CreateElementParams, type CreateElementStyleArgs, type DropElementParams, type DuplicateElementParams, type DuplicateElementsParams, type DuplicatedElement, type DuplicatedElementsResult, ELEMENT_STYLE_CHANGE_EVENT, type Element, type ElementChildren, type ElementControl, type ElementID, type ElementModel, type ElementType, type LinkInLinkRestriction, type MoveElementParams, type MoveElementsParams, type MovedElement, type MovedElementsResult, type UpdateElementSettingsArgs, type UpdateElementStyleArgs, type V1Element, type V1ElementConfig, type V1ElementData, type V1ElementModelProps, type V1ElementSettingsProps, createElement, createElementStyle, createElements, deleteElement, deleteElementStyle, dropElement, duplicateElement, duplicateElements, generateElementId, getAnchoredAncestorId, getAnchoredDescendantId, getContainer, getCurrentDocumentContainer, getCurrentDocumentId, getElementEditorSettings, getElementInteractions, getElementLabel, getElementSetting, getElementSettings, getElementStyles, getElementType, getElements, getLinkInLinkRestriction, getSelectedElements, getWidgetsCache, initMcp as initElementsMcp, isElementAnchored, moveElement, moveElements, playElementInteractions, removeElements, replaceElement, selectElement, shouldCreateNewLocalStyle, styleRerenderEvents, updateElementEditorSettings, updateElementInteractions, updateElementSettings, updateElementStyle, useElementChildren, useElementEditorSettings, useElementInteractions, useElementSetting, useElementSettings, useParentElement, useSelectedElement };