@elementor/editor-elements 4.2.0-beta1 → 4.3.0-1000

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-import { PropsSchema, PropValue, SizePropValue, AnyTransformable, Props, LinkPropValue } from '@elementor/editor-props';
+import { PropsSchema, Dependency, PropValue, SizePropValue, AnyTransformable, Props, LinkPropValue } from '@elementor/editor-props';
 import { ClassState, StyleDefinitionID, StyleDefinition, StyleDefinitionVariant } from '@elementor/editor-styles';
 import * as _elementor_editor_v1_adapters from '@elementor/editor-v1-adapters';
 
@@ -58,6 +58,15 @@ type ElementControl = {
 type ControlItem = ControlsSection | Control | ElementControl;
 type ControlLayout = 'full' | 'two-columns' | 'custom';
 
+type ChildDependencyRule = {
+    child_type: string;
+    when: Dependency;
+    position: ElementPosition;
+    stash: boolean;
+    default_model: V1ElementData | null;
+};
+type ChildDependenciesConfig = ChildDependencyRule[];
+
 type ExtendedWindow = Window & {
     $e?: {
         components?: {
@@ -203,14 +212,21 @@ type V1ElementModelProps = {
     interactions?: string | ElementInteractions;
     isGlobal?: boolean;
     skipDefaultChildren?: boolean;
+    hydrateDefaultChildren?: boolean;
 };
 type V1ElementData = Omit<V1ElementModelProps, 'elements'> & {
     elements?: V1ElementData[];
 };
+type ElementPositionKind = 'last' | 'first' | 'index' | 'after_type' | 'before_type';
+type ElementPosition = {
+    kind: ElementPositionKind;
+    value: number | string | null;
+};
 type V1ElementEditorSettingsProps = {
     title?: string;
     initial_position?: number;
     component_uid?: string;
+    grid_outline?: boolean;
 };
 type V1ElementSettingsProps = Record<string, PropValue>;
 type V1ElementConfig<T = object, TChild = unknown> = {
@@ -233,6 +249,7 @@ type V1ElementConfig<T = object, TChild = unknown> = {
     show_in_panel?: boolean;
     allowed_child_types?: string[];
     default_children?: Array<Record<string, TChild>>;
+    children_dependencies?: ChildDependencyRule[];
     meta?: {
         [key: string]: string | number | boolean | null | NonNullable<V1ElementConfig['meta']>;
     };
@@ -244,7 +261,31 @@ type V1Model$1<T> = {
         remove?: string[];
     }) => T;
     trigger?: (event: string, ...args: unknown[]) => void;
+    on?: (event: string, callback: (...args: unknown[]) => void, context?: unknown) => void;
+    off?: (event: string, callback?: (...args: unknown[]) => void, context?: unknown) => void;
+};
+
+type ReactiveModel = {
+    get: (key: string) => unknown;
+};
+type BindSettingsReconcileArgs = {
+    model: ReactiveModel;
+    elementConfig: V1ElementConfig | undefined;
+};
+type Detach = () => void;
+declare function bindSettingsReconcile({ model, elementConfig }: BindSettingsReconcileArgs): Detach;
+
+declare function evaluateWhen(when: Dependency | undefined, settings: Record<string, PropValue>): boolean;
+
+type ReconcileInitialChildrenArgs = {
+    elementId: string;
+    elementConfig: V1ElementConfig | undefined;
+    attributes: {
+        elements?: V1ElementData[];
+        settings?: V1ElementSettingsProps;
+    };
 };
+declare function reconcileInitialChildren({ elementId, elementConfig, attributes, }: ReconcileInitialChildrenArgs): void;
 
 type ElementModel = {
     id: string;
@@ -385,8 +426,12 @@ declare function getCurrentDocumentId(): number | null;
 
 declare function getElementEditorSettings(elementId: ElementID): V1ElementEditorSettingsProps;
 
+declare function getElementIcon(elementId: ElementID): string | null;
+
 declare function getElementLabel(elementId?: ElementID): string;
 
+declare function getElementTitle(elementId: ElementID): string | null;
+
 declare const getElementSetting: <TValue>(elementId: ElementID, settingKey: string) => TValue | null;
 declare const getElementSettings: <TValue>(elementId: ElementID, settingKey: string[]) => Record<string, TValue | null>;
 
@@ -482,6 +527,8 @@ type ReplaceElementArgs = {
 };
 declare const replaceElement: ({ currentElementId, newElement, withHistory }: ReplaceElementArgs) => V1Element;
 
+declare function resolveInsertIndex(position: ElementPosition, elements: V1ElementData[]): number;
+
 declare const updateElementEditorSettings: ({ elementId, settings, }: {
     elementId: string;
     settings: V1ElementModelProps["editor_settings"];
@@ -547,4 +594,4 @@ declare const updateElementInteractions: ({ elementId, interactions, }: {
 }) => void;
 declare const playElementInteractions: (elementId: string, interactionId: string) => void;
 
-export { type AnimationPresetPropValue, type BackboneCollection, type BackboneModel, type BooleanPropValue, type ConfigPropValue, 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 ElementInteractions, type ElementModel, type ElementType, type ExcludedBreakpointsPropValue, type ExtendedWindow, type InteractionBreakpointsPropValue, type InteractionItemPropValue, type LinkInLinkRestriction, type ModelResult, type MoveElementParams, type NumberPropValue, type PseudoState, type StringPropValue, type TimingConfigPropValue, type UpdateElementSettingsArgs, type UpdateElementStyleArgs, type V1Element, type V1ElementConfig, type V1ElementData, type V1ElementEditorSettingsProps, type V1ElementModelProps, type V1ElementSettingsProps, addModelToParent, createElement, createElementStyle, createElements, deleteElement, deleteElementStyle, dropElement, duplicateElement, duplicateElements, findChildRecursive, findModelInDocument, generateElementId, getAllDescendants, getAnchoredAncestorId, getAnchoredDescendantId, getContainer, getCurrentDocumentContainer, getCurrentDocumentId, getElementChildren as getElementChildrenWithFallback, getElementEditorSettings, getElementInteractions, getElementLabel, getElementSetting, getElementSettings, getElementStyles, getElementType, getElements, getLinkInLinkRestriction, getSelectedElements, getWidgetsCache, isElementAnchored, moveElement, moveElements, playElementInteractions, removeElements, removeModelFromParent, replaceElement, resolveContainer, selectElement, shouldCreateNewLocalStyle, styleRerenderEvents, updateElementEditorSettings, updateElementInteractions, updateElementSettings, updateElementStyle, useElementChildren, useElementEditorSettings, useParentElement, useSelectedElement, useSelectedElementSettings };
+export { type AnimationPresetPropValue, type BackboneCollection, type BackboneModel, type BooleanPropValue, type ChildDependenciesConfig, type ChildDependencyRule, type ConfigPropValue, 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 ElementInteractions, type ElementModel, type ElementPosition, type ElementPositionKind, type ElementType, type ExcludedBreakpointsPropValue, type ExtendedWindow, type InteractionBreakpointsPropValue, type InteractionItemPropValue, type LinkInLinkRestriction, type ModelResult, type MoveElementParams, type NumberPropValue, type PseudoState, type StringPropValue, type TimingConfigPropValue, type UpdateElementSettingsArgs, type UpdateElementStyleArgs, type V1Element, type V1ElementConfig, type V1ElementData, type V1ElementEditorSettingsProps, type V1ElementModelProps, type V1ElementSettingsProps, addModelToParent, bindSettingsReconcile, createElement, createElementStyle, createElements, deleteElement, deleteElementStyle, dropElement, duplicateElement, duplicateElements, evaluateWhen, findChildRecursive, findModelInDocument, generateElementId, getAllDescendants, getAnchoredAncestorId, getAnchoredDescendantId, getContainer, getCurrentDocumentContainer, getCurrentDocumentId, getElementChildren as getElementChildrenWithFallback, getElementEditorSettings, getElementIcon, getElementInteractions, getElementLabel, getElementSetting, getElementSettings, getElementStyles, getElementTitle, getElementType, getElements, getLinkInLinkRestriction, getSelectedElements, getWidgetsCache, isElementAnchored, moveElement, moveElements, playElementInteractions, reconcileInitialChildren, removeElements, removeModelFromParent, replaceElement, resolveContainer, resolveInsertIndex, selectElement, shouldCreateNewLocalStyle, styleRerenderEvents, updateElementEditorSettings, updateElementInteractions, updateElementSettings, updateElementStyle, useElementChildren, useElementEditorSettings, useParentElement, useSelectedElement, useSelectedElementSettings };

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { PropsSchema, PropValue, SizePropValue, AnyTransformable, Props, LinkPropValue } from '@elementor/editor-props';
+import { PropsSchema, Dependency, PropValue, SizePropValue, AnyTransformable, Props, LinkPropValue } from '@elementor/editor-props';
 import { ClassState, StyleDefinitionID, StyleDefinition, StyleDefinitionVariant } from '@elementor/editor-styles';
 import * as _elementor_editor_v1_adapters from '@elementor/editor-v1-adapters';
 
@@ -58,6 +58,15 @@ type ElementControl = {
 type ControlItem = ControlsSection | Control | ElementControl;
 type ControlLayout = 'full' | 'two-columns' | 'custom';
 
+type ChildDependencyRule = {
+    child_type: string;
+    when: Dependency;
+    position: ElementPosition;
+    stash: boolean;
+    default_model: V1ElementData | null;
+};
+type ChildDependenciesConfig = ChildDependencyRule[];
+
 type ExtendedWindow = Window & {
     $e?: {
         components?: {
@@ -203,14 +212,21 @@ type V1ElementModelProps = {
     interactions?: string | ElementInteractions;
     isGlobal?: boolean;
     skipDefaultChildren?: boolean;
+    hydrateDefaultChildren?: boolean;
 };
 type V1ElementData = Omit<V1ElementModelProps, 'elements'> & {
     elements?: V1ElementData[];
 };
+type ElementPositionKind = 'last' | 'first' | 'index' | 'after_type' | 'before_type';
+type ElementPosition = {
+    kind: ElementPositionKind;
+    value: number | string | null;
+};
 type V1ElementEditorSettingsProps = {
     title?: string;
     initial_position?: number;
     component_uid?: string;
+    grid_outline?: boolean;
 };
 type V1ElementSettingsProps = Record<string, PropValue>;
 type V1ElementConfig<T = object, TChild = unknown> = {
@@ -233,6 +249,7 @@ type V1ElementConfig<T = object, TChild = unknown> = {
     show_in_panel?: boolean;
     allowed_child_types?: string[];
     default_children?: Array<Record<string, TChild>>;
+    children_dependencies?: ChildDependencyRule[];
     meta?: {
         [key: string]: string | number | boolean | null | NonNullable<V1ElementConfig['meta']>;
     };
@@ -244,7 +261,31 @@ type V1Model$1<T> = {
         remove?: string[];
     }) => T;
     trigger?: (event: string, ...args: unknown[]) => void;
+    on?: (event: string, callback: (...args: unknown[]) => void, context?: unknown) => void;
+    off?: (event: string, callback?: (...args: unknown[]) => void, context?: unknown) => void;
+};
+
+type ReactiveModel = {
+    get: (key: string) => unknown;
+};
+type BindSettingsReconcileArgs = {
+    model: ReactiveModel;
+    elementConfig: V1ElementConfig | undefined;
+};
+type Detach = () => void;
+declare function bindSettingsReconcile({ model, elementConfig }: BindSettingsReconcileArgs): Detach;
+
+declare function evaluateWhen(when: Dependency | undefined, settings: Record<string, PropValue>): boolean;
+
+type ReconcileInitialChildrenArgs = {
+    elementId: string;
+    elementConfig: V1ElementConfig | undefined;
+    attributes: {
+        elements?: V1ElementData[];
+        settings?: V1ElementSettingsProps;
+    };
 };
+declare function reconcileInitialChildren({ elementId, elementConfig, attributes, }: ReconcileInitialChildrenArgs): void;
 
 type ElementModel = {
     id: string;
@@ -385,8 +426,12 @@ declare function getCurrentDocumentId(): number | null;
 
 declare function getElementEditorSettings(elementId: ElementID): V1ElementEditorSettingsProps;
 
+declare function getElementIcon(elementId: ElementID): string | null;
+
 declare function getElementLabel(elementId?: ElementID): string;
 
+declare function getElementTitle(elementId: ElementID): string | null;
+
 declare const getElementSetting: <TValue>(elementId: ElementID, settingKey: string) => TValue | null;
 declare const getElementSettings: <TValue>(elementId: ElementID, settingKey: string[]) => Record<string, TValue | null>;
 
@@ -482,6 +527,8 @@ type ReplaceElementArgs = {
 };
 declare const replaceElement: ({ currentElementId, newElement, withHistory }: ReplaceElementArgs) => V1Element;
 
+declare function resolveInsertIndex(position: ElementPosition, elements: V1ElementData[]): number;
+
 declare const updateElementEditorSettings: ({ elementId, settings, }: {
     elementId: string;
     settings: V1ElementModelProps["editor_settings"];
@@ -547,4 +594,4 @@ declare const updateElementInteractions: ({ elementId, interactions, }: {
 }) => void;
 declare const playElementInteractions: (elementId: string, interactionId: string) => void;
 
-export { type AnimationPresetPropValue, type BackboneCollection, type BackboneModel, type BooleanPropValue, type ConfigPropValue, 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 ElementInteractions, type ElementModel, type ElementType, type ExcludedBreakpointsPropValue, type ExtendedWindow, type InteractionBreakpointsPropValue, type InteractionItemPropValue, type LinkInLinkRestriction, type ModelResult, type MoveElementParams, type NumberPropValue, type PseudoState, type StringPropValue, type TimingConfigPropValue, type UpdateElementSettingsArgs, type UpdateElementStyleArgs, type V1Element, type V1ElementConfig, type V1ElementData, type V1ElementEditorSettingsProps, type V1ElementModelProps, type V1ElementSettingsProps, addModelToParent, createElement, createElementStyle, createElements, deleteElement, deleteElementStyle, dropElement, duplicateElement, duplicateElements, findChildRecursive, findModelInDocument, generateElementId, getAllDescendants, getAnchoredAncestorId, getAnchoredDescendantId, getContainer, getCurrentDocumentContainer, getCurrentDocumentId, getElementChildren as getElementChildrenWithFallback, getElementEditorSettings, getElementInteractions, getElementLabel, getElementSetting, getElementSettings, getElementStyles, getElementType, getElements, getLinkInLinkRestriction, getSelectedElements, getWidgetsCache, isElementAnchored, moveElement, moveElements, playElementInteractions, removeElements, removeModelFromParent, replaceElement, resolveContainer, selectElement, shouldCreateNewLocalStyle, styleRerenderEvents, updateElementEditorSettings, updateElementInteractions, updateElementSettings, updateElementStyle, useElementChildren, useElementEditorSettings, useParentElement, useSelectedElement, useSelectedElementSettings };
+export { type AnimationPresetPropValue, type BackboneCollection, type BackboneModel, type BooleanPropValue, type ChildDependenciesConfig, type ChildDependencyRule, type ConfigPropValue, 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 ElementInteractions, type ElementModel, type ElementPosition, type ElementPositionKind, type ElementType, type ExcludedBreakpointsPropValue, type ExtendedWindow, type InteractionBreakpointsPropValue, type InteractionItemPropValue, type LinkInLinkRestriction, type ModelResult, type MoveElementParams, type NumberPropValue, type PseudoState, type StringPropValue, type TimingConfigPropValue, type UpdateElementSettingsArgs, type UpdateElementStyleArgs, type V1Element, type V1ElementConfig, type V1ElementData, type V1ElementEditorSettingsProps, type V1ElementModelProps, type V1ElementSettingsProps, addModelToParent, bindSettingsReconcile, createElement, createElementStyle, createElements, deleteElement, deleteElementStyle, dropElement, duplicateElement, duplicateElements, evaluateWhen, findChildRecursive, findModelInDocument, generateElementId, getAllDescendants, getAnchoredAncestorId, getAnchoredDescendantId, getContainer, getCurrentDocumentContainer, getCurrentDocumentId, getElementChildren as getElementChildrenWithFallback, getElementEditorSettings, getElementIcon, getElementInteractions, getElementLabel, getElementSetting, getElementSettings, getElementStyles, getElementTitle, getElementType, getElements, getLinkInLinkRestriction, getSelectedElements, getWidgetsCache, isElementAnchored, moveElement, moveElements, playElementInteractions, reconcileInitialChildren, removeElements, removeModelFromParent, replaceElement, resolveContainer, resolveInsertIndex, selectElement, shouldCreateNewLocalStyle, styleRerenderEvents, updateElementEditorSettings, updateElementInteractions, updateElementSettings, updateElementStyle, useElementChildren, useElementEditorSettings, useParentElement, useSelectedElement, useSelectedElementSettings };