@globalpayments/vega 2.47.0 → 2.48.0

package/dist/types/components/vega-nav/vega-left-nav-link/vega-left-nav-link.d.ts

@@ -6,12 +6,14 @@ import { LeftNavCounterBadgeConfig } from '../interface';
 import { EventEmitSlimmerBase } from '../../../helpers/event-manager/slimmers/event-emit-slimmer';
 import { DeprecatedPropertySlimmerBase } from '../../../helpers/slimmers/deprecated-property-slimmer';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../../helpers/slimmers/component-usage-runtime-metrics';
+import { VegaLeftNavHierarchyController } from '../slimmers/vega-left-nav-group-hierarchy-controller';
 /**
  * @vegaVersion 1.31.0
  */
 export declare class VegaLeftNavLink {
   protected readonly globalSlimmers: GlobalSlimmers;
   protected readonly renderer: VegaLeftNavLinkRenderer;
+  protected readonly vegaLeftNavHierarchyController: VegaLeftNavHierarchyController;
   protected readonly controller: VegaLeftNavLinkController;
   protected menuClickEventEmitter: EventEmitSlimmerBase;
   protected readonly deprecatedPropertySlimmer: DeprecatedPropertySlimmerBase<number>;

package/dist/types/components/vega-popover/vega-popover.d.ts

@@ -60,6 +60,9 @@ export declare class VegaPopover {
    *    you can modify this property to specify a different element
    *    as the container for the popover.
    *
+   * @VegaWarning The value of this property should be an element that is
+   * 		the parent of this component or an ancestor of the parent element.
+   * 		Using any other element may lead to unexpected behavior.
    * @vegaVersion 1.19.0
    */
   positionRelativeTo: string;

package/dist/types/components/vega-rich-text-editor/dto/annotations/block-annotation.abstract.d.ts

@@ -19,4 +19,5 @@ export declare abstract class BlockAnnotation extends Annotation {
    * @returns {Nullable<Record<string, unknown>>} JSON item of the annotation
    */
   abstract toJSON(): Nullable<Record<string, unknown>>;
+  abstract clone(): BlockAnnotation;
 }

package/dist/types/components/vega-rich-text-editor/dto/annotations/bold-annotation.d.ts

@@ -21,6 +21,10 @@ export declare class BoldAnnotation extends NodeAnnotation {
    * @returns {Record<string, unknown>} JSON representation of the annotation
    */
   toJSON(): Record<string, unknown>;
+  /**
+   * @inheritDoc
+   */
+  clone(): BoldAnnotation;
   /**
    * Generate the style for the annotation
    *

package/dist/types/components/vega-rich-text-editor/dto/annotations/code-annotation.d.ts

@@ -21,6 +21,10 @@ export declare class CodeAnnotation extends NodeAnnotation {
    * @returns {Record<string, unknown>} JSON representation of the annotation
    */
   toJSON(): Record<string, unknown>;
+  /**
+   * @inheritDoc
+   */
+  clone(): CodeAnnotation;
   /**
    * Generate the class for the annotation
    *

package/dist/types/components/vega-rich-text-editor/dto/annotations/horizontal-alignment-annotation.d.ts

@@ -27,6 +27,10 @@ export declare class HorizontalAlignmentAnnotation extends BlockAnnotation {
    * @returns {string} - Annotation class
    */
   renderClass(): string;
+  /**
+   * @inheritDoc
+   */
+  clone(): HorizontalAlignmentAnnotation;
   /**
    * Generate the style for the annotation
    *

package/dist/types/components/vega-rich-text-editor/dto/annotations/image-annotation.d.ts

@@ -24,6 +24,10 @@ export declare class ImageAnnotation extends NodeAnnotation {
    * @returns {Nullable<Record<string, unknown>>} JSON representation of the annotation
    */
   toJSON(): Nullable<Record<string, unknown>>;
+  /**
+   * @inheritDoc
+   */
+  clone(): ImageAnnotation;
   /**
    * Generate the style for the image
    *

package/dist/types/components/vega-rich-text-editor/dto/annotations/indent-annotation.d.ts

@@ -21,6 +21,10 @@ export declare class IndentAnnotation extends BlockAnnotation {
    * @returns {Nullable<Record<string, unknown>>} JSON representation of the annotation
    */
   toJSON(): Nullable<Record<string, unknown>>;
+  /**
+   * @inheritDoc
+   */
+  clone(): IndentAnnotation;
   /**
    * Generate the style for the annotation
    *

package/dist/types/components/vega-rich-text-editor/dto/annotations/italic-annotation.d.ts

@@ -21,6 +21,10 @@ export declare class ItalicAnnotation extends NodeAnnotation {
    * @returns {Record<string, unknown>} JSON representation of the annotation
    */
   toJSON(): Record<string, unknown>;
+  /**
+   * @inheritDoc
+   */
+  clone(): ItalicAnnotation;
   /**
    * Generate the style for the annotation
    *

package/dist/types/components/vega-rich-text-editor/dto/annotations/link-annotation.d.ts

@@ -21,6 +21,10 @@ export declare class LinkAnnotation extends NodeAnnotation {
    * @returns {Record<'link', VegaRTELink>} JSON representation of the annotation
    */
   toJSON(): Record<'link', VegaRTELink>;
+  /**
+   * @inheritDoc
+   */
+  clone(): LinkAnnotation;
   /**
    * Verify whether two link annotation is same or not
    *

package/dist/types/components/vega-rich-text-editor/dto/annotations/link-group-annotation.d.ts

@@ -7,4 +7,5 @@ export declare class LinkGroupAnnotation extends Annotation {
   readonly type: InternalAnnotationTypeEnum;
   linkGroups: Map<string, RTETextNode[]>;
   constructor(groupKey: string);
+  clone(): LinkGroupAnnotation;
 }

package/dist/types/components/vega-rich-text-editor/dto/annotations/node-annotation.abstract.d.ts

@@ -25,4 +25,5 @@ export declare abstract class NodeAnnotation extends Annotation {
    * @returns {Nullable<Record<string, unknown>>} JSON representation of the annotation
    */
   abstract toJSON(): Nullable<Record<string, unknown>>;
+  abstract clone(): NodeAnnotation;
 }

package/dist/types/components/vega-rich-text-editor/dto/annotations/selection-range-annotation.d.ts

@@ -6,4 +6,10 @@ export declare class SelectionRangeAnnotation extends Annotation {
   readonly type: InternalAnnotationTypeEnum;
   range: Range;
   constructor(range: Range);
+  /**
+   * Clone the selection range annotation
+   *
+   * @returns {SelectionRangeAnnotation} A cloned instance of the selection range annotation
+   */
+  clone(): SelectionRangeAnnotation;
 }

package/dist/types/components/vega-rich-text-editor/dto/annotations/strikethrough-annotation.d.ts

@@ -21,6 +21,10 @@ export declare class StrikethroughAnnotation extends NodeAnnotation {
    * @returns {Record<string, unknown>} JSON representation of the annotation
    */
   toJSON(): Record<string, unknown>;
+  /**
+   * @inheritDoc
+   */
+  clone(): StrikethroughAnnotation;
   /**
    * Generate the class for the annotation
    *

package/dist/types/components/vega-rich-text-editor/dto/annotations/text-color-annotation.d.ts

@@ -21,6 +21,10 @@ export declare class TextColorAnnotation extends NodeAnnotation {
    * @returns {Record<string, unknown>} JSON representation of the annotation
    */
   toJSON(): Record<string, unknown>;
+  /**
+   * @inheritDoc
+   */
+  clone(): TextColorAnnotation;
   /**
    * Generate the class for the annotation
    *

package/dist/types/components/vega-rich-text-editor/dto/annotations/text-style-annotation.d.ts

@@ -21,6 +21,10 @@ export declare class TextStyleAnnotation extends BlockAnnotation {
    * @returns {Nullable<Record<string, unknown>>} JSON representation of the annotation
    */
   toJSON(): Nullable<Record<string, unknown>>;
+  /**
+   * @inheritDoc
+   */
+  clone(): TextStyleAnnotation;
   /**
    * Render the styles by block type
    *

package/dist/types/components/vega-rich-text-editor/dto/annotations/underline-annotation.d.ts

@@ -21,6 +21,10 @@ export declare class UnderlineAnnotation extends NodeAnnotation {
    * @returns {Record<string, unknown>} JSON representation of the annotation
    */
   toJSON(): Record<string, unknown>;
+  /**
+   * @inheritDoc
+   */
+  clone(): UnderlineAnnotation;
   /**
    * Generate the class for the annotation
    *

package/dist/types/components/vega-rich-text-editor/dto/blocks/block.abstract.d.ts

@@ -7,12 +7,13 @@ import { VegaRTEContent } from '../content-state';
 import { InternalAnnotationTypeEnum } from '../annotations/annotation.abstract';
 import { LinkGroupAnnotation } from '../annotations/link-group-annotation';
 import { RTENode } from '../nodes/node.abstract';
+export declare type BlockAnnotations = Map<keyof typeof BlockAnnotationTypeEnum | InternalAnnotationTypeEnum.LINK_GROUP, BlockAnnotation | LinkGroupAnnotation>;
 /**
  * Abstract class for block
  */
 export declare abstract class RTEBlock {
   id: string;
-  annotationMap: Map<keyof typeof BlockAnnotationTypeEnum | InternalAnnotationTypeEnum.LINK_GROUP, BlockAnnotation | LinkGroupAnnotation>;
+  annotationMap: BlockAnnotations;
   abstract type: RTEBlockType;
   abstract parent: VegaRTEContent | RTEBlock;
   protected constructor(id: string);
@@ -67,6 +68,12 @@ export declare abstract class RTEBlock {
    * @param {AnnotationAction} action - Annotation action
    */
   protected doAnnotationActionApply?(action: AnnotationAction): void;
+  /**
+   * clone annotations of the block
+   *
+   * @returns {BlockAnnotations} - Cloned annotations
+   */
+  protected cloneAnnotations(): BlockAnnotations;
   /**
    * abstract method to be overridden in each block to verify whether the block is not empty
    *
@@ -74,4 +81,5 @@ export declare abstract class RTEBlock {
    */
   abstract isNotEmpty(): boolean;
   abstract getLastNode(): RTENode;
+  abstract clone(): RTEBlock;
 }

package/dist/types/components/vega-rich-text-editor/dto/blocks/image-block.d.ts

@@ -35,4 +35,8 @@ export declare class RTEImageBlock extends RTEBlock {
    * @returns {RTEImageBlock} - The empty image block.
    */
   createNewImageBlock(): RTEImageBlock;
+  /**
+   * @inheritDoc
+   */
+  clone(): RTEImageBlock;
 }

package/dist/types/components/vega-rich-text-editor/dto/blocks/list-block.d.ts

@@ -30,4 +30,8 @@ export declare class RTEListBlock extends RTEBlock {
    * @inheritDoc
    */
   getLastNode(): RTETextNode;
+  /**
+   * @inheritDoc
+   */
+  clone(): RTEListBlock;
 }

package/dist/types/components/vega-rich-text-editor/dto/blocks/list-item-block.d.ts

@@ -35,4 +35,8 @@ export declare class RTEListItemBlock extends RTETextBlock {
    * @returns {RTEListItemBlock} - A list item block.
    */
   createNewListItem(): RTEListItemBlock;
+  /**
+   * @inheritDoc
+   */
+  clone(): RTEListItemBlock;
 }

package/dist/types/components/vega-rich-text-editor/dto/blocks/text-block.d.ts

@@ -58,6 +58,10 @@ export declare class RTETextBlock extends RTEBlock {
    * @returns {RTEBlock} New block
    */
   cloneWithNodes(nodes: RTETextNode[]): RTEBlock;
+  /**
+   * @inheritDoc
+   */
+  clone(): RTETextBlock;
   /**
    * @inheritDoc
    */

package/dist/types/components/vega-rich-text-editor/dto/content-state.d.ts

@@ -3,6 +3,8 @@ import { RTEListBlock } from './blocks/list-block';
 import { RTETextBlock } from './blocks/text-block';
 import { ModifyContentAction } from './actions/modify-content-action.abstract';
 import { RTEListItemBlock } from './blocks/list-item-block';
+import { RTENode } from './nodes/node.abstract';
+import { Nullable } from '../../../types/general';
 /**
  * Class representing the content state of the rich text editor.
  */
@@ -25,9 +27,10 @@ export declare class VegaRTEContent {
   /**
    * Clones the content state.
    *
+   * @param {boolean} deep - If true, performs a deep clone of the content state.
    * @returns {VegaRTEContent} The cloned content state.
    */
-  clone(): VegaRTEContent;
+  clone(deep?: boolean): VegaRTEContent;
   /**
    * Converts the content state to a JSON array of blocks.
    *
@@ -54,4 +57,19 @@ export declare class VegaRTEContent {
    * @returns {RTEListBlock} list block dto.
    */
   createList(type: ListType): RTEListBlock;
+  /**
+   * Finds a node by its ID in the content.
+   *
+   * @param {string} id - The ID of the node to find.
+   * @returns {Nullable<RTENode>} The found node or null if not found.
+   */
+  findNodeById(id: string): Nullable<RTENode>;
+  /**
+   * Recursively searches for a node by its ID in the given blocks.
+   *
+   * @param {string} id - The ID of the node to find.
+   * @param {RTEContentBlock[]} blocks - The blocks to search within.
+   * @returns {Nullable<RTENode>} The found node or null if not found.
+   */
+  private findNodeInBlocksById;
 }

package/dist/types/components/vega-rich-text-editor/dto/editor-state.d.ts

@@ -0,0 +1,20 @@
+import { VegaRTEContent } from './content-state';
+import { RTESelectionState } from './selection-state';
+/**
+ * Represents the state of the RTE
+ */
+export declare class RTEEditorState {
+  content: VegaRTEContent;
+  selection: RTESelectionState;
+  constructor(content: VegaRTEContent, selection: RTESelectionState);
+  /**
+   * Clones the editor state, updating the content and selection based on the provided content.
+   *
+   * @returns {RTEEditorState} A new instance of RTEEditorState with the updated content and selection.
+   */
+  clone(): RTEEditorState;
+  /**
+   * Refreshes the selection nodes in the editor state.
+   */
+  private refreshSelectionNodes;
+}

package/dist/types/components/vega-rich-text-editor/dto/nodes/image-node.d.ts

@@ -23,6 +23,10 @@ export declare class RTEImageNode extends RTENode {
    * @inheritDoc
    */
   toJSON(): VegaRTEImageNode;
+  /**
+   * @inheritDoc
+   */
+  clone(): RTEImageNode;
   /**
    * @inheritDoc
    */

package/dist/types/components/vega-rich-text-editor/dto/nodes/node.abstract.d.ts

@@ -7,12 +7,13 @@ export declare enum NodeTypeEnum {
   TEXT = "TEXT",
   IMAGE = "IMAGE"
 }
+export declare type NodeAnnotations = Map<RTENodeAnnotationMapKey, RTENodeAnnotationMapValue>;
 /**
  * Abstract class for all nodes
  */
 export declare abstract class RTENode {
   id: string;
-  annotationMap: Map<RTENodeAnnotationMapKey, RTENodeAnnotationMapValue>;
+  annotationMap: NodeAnnotations;
   abstract readonly type: NodeTypeEnum;
   abstract parentBlock: RTEBlock;
   protected constructor(id: string, annotationMap?: Map<RTENodeAnnotationMapKey, RTENodeAnnotationMapValue>);
@@ -47,7 +48,14 @@ export declare abstract class RTENode {
    * Flush the value change
    */
   protected flushChange(): void;
+  /**
+   * Clones the annotations of the current RTETextNode.
+   *
+   * @returns {NodeAnnotations} A new Map containing cloned annotations.
+   */
+  protected cloneAnnotations(): NodeAnnotations;
   abstract toJSON(): VegaRTEBaseNode;
+  abstract clone(): RTENode;
   protected abstract doAnnotationActionApply(action: AnnotationAction): void;
   protected abstract doModifyActionApply(action: ModifyContentAction): void;
 }

package/dist/types/components/vega-rich-text-editor/dto/nodes/text-node.d.ts

@@ -42,6 +42,10 @@ export declare class RTETextNode extends RTENode {
    * @returns {RTETextNode} An new RTETextNode
    */
   cloneWithText(text: string): RTETextNode;
+  /**
+   * @inheritDoc
+   */
+  clone(): RTETextNode;
   /**
    * Checks if a node is empty
    *

package/dist/types/components/vega-rich-text-editor/dto/range.d.ts

@@ -77,6 +77,12 @@ export declare class RTERange {
    * @returns {RTERange} - The new RTERange instance
    */
   updateRTERange(options: RTERangeOptions, nativeRange?: Range): RTERange;
+  /**
+   * Creates a new instance of the `RTERange` class with the same properties as the current instance.
+   *
+   * @returns {RTERange} A new `RTERange` instance with the same start and end containers, offsets, and nodes.
+   */
+  clone(): RTERange;
   /**
    * Creates a Range object based on start and end nodes and offsets.
    * Invoke this method to get the future range state if the range content modified.

package/dist/types/components/vega-rich-text-editor/dto/selection-state.d.ts

@@ -0,0 +1,14 @@
+import { RTERange } from './range';
+/**
+ * Represents the state of the selection in the RTE.
+ */
+export declare class RTESelectionState {
+  range: RTERange;
+  constructor(range: RTERange);
+  /**
+   * Clones the selection state, updating the range nodes based on the provided content.
+   *
+   * @returns {RTESelectionState} A new instance of RTESelectionState with the updated range.
+   */
+  clone(): RTESelectionState;
+}

package/dist/types/components/vega-rich-text-editor/slimmers/controllers/helper/element-to-dto-strategy/element-to-dto-strategy.abstract.d.ts

@@ -26,7 +26,7 @@ export declare class ElementToDTOStrategyOutput {
   /**
    * Transform current output and children output to DTO
    *
-   * @returns {RTEContentBlock} - DTO.
+   * @returns {Nullable<RTEContentBlock>} - DTO.
    */
-  toDto(): RTEContentBlock;
+  toDto(): Nullable<RTEContentBlock>;
 }

package/dist/types/components/vega-rich-text-editor/slimmers/controllers/history-controller.d.ts

@@ -0,0 +1,54 @@
+import { RTEEditorState } from '../../dto/editor-state';
+import { VegaRichTextEditor } from '../../vega-rich-text-editor';
+import { KeyboardManagerSlimmer } from '../../../../helpers/slimmers/keyboard-manager-slimmer';
+/**
+ * History controller for RTE.
+ */
+export declare class HistoryController extends KeyboardManagerSlimmer {
+  protected host: VegaRichTextEditor['host'];
+  protected vegaRichTextEditorRenderer: VegaRichTextEditor['vegaRichTextEditorRenderer'];
+  protected valueController: VegaRichTextEditor['valueController'];
+  protected value: VegaRichTextEditor['value'];
+  protected selectionController: VegaRichTextEditor['selectionController'];
+  private redoStack;
+  private undoStack;
+  private readonly registerHistoryDelay;
+  private readonly registerHistoryDebounced;
+  constructor();
+  /**
+   * Component lifecycle - [componentDidLoad]
+   */
+  registerInitState(): void;
+  /**
+   * Restores the previous state from the undo stack.
+   */
+  undo(): Promise<void>;
+  /**
+   * Restores the next state from the redo stack.
+   */
+  redo(): Promise<void>;
+  /**
+   * Registers history based on the editor state.
+   *
+   * @param {RTEEditorState} editorState - The state to record in history.
+   */
+  registerHistory(editorState: RTEEditorState): void;
+  /**
+   * Internal function to register history immediately.
+   *
+   * @param {RTEEditorState} state - The state to record in history.
+   */
+  private internalRegisterHistory;
+  /**
+   * Restores the editor state based on the provided history state.
+   *
+   * @param {RTEEditorState} state - The state to restore to.
+   */
+  private restoreState;
+  /**
+   * Returns the keyboard shortcut options for undo/redo functionality.
+   *
+   * @returns {KeyboardEventListener[]} - An array of keyboard shortcut options.
+   */
+  private getKeyboardShortcutOptions;
+}

package/dist/types/components/vega-rich-text-editor/slimmers/controllers/selection-controller.d.ts

@@ -3,6 +3,7 @@ import { VegaRichTextEditor } from '../../vega-rich-text-editor';
 import { RTEBlock } from '../../dto/blocks/block.abstract';
 import { RTENode } from '../../dto/nodes/node.abstract';
 import { RTERange } from '../../dto/range';
+import { RTESelectionState } from '../../dto/selection-state';
 declare type SelectionStateType = {
   startNode: Node | RTENode;
   endNode: Node | RTENode;
@@ -21,11 +22,13 @@ export declare class SelectionController extends VegaSlimmer {
   protected readonly disabled: VegaRichTextEditor['disabled'];
   protected readonly valueController: VegaRichTextEditor['valueController'];
   protected insertCompositionTextController: VegaRichTextEditor['insertCompositionTextController'];
+  protected readonly historyController: VegaRichTextEditor['historyController'];
   private currentRange;
   private updateCaretPositionTaskQueue;
   private handleSelectionWithDebounce;
-  private selectedNodes;
+  private pendingRestoreSelectionNodes;
   private selectionRangeChangeObserver;
+  private selectionState;
   /**
    * Component lifecycle - [connectedCallback]{@link VegaRichTextEditor.connectedCallback}
    */
@@ -64,6 +67,12 @@ export declare class SelectionController extends VegaSlimmer {
    * @returns {RTEBlock[]} Selected rich text blocks
    */
   getSelectedBlocks(): RTEBlock[];
+  /**
+   * Set the selection state
+   *
+   * @param {RTESelectionState} state - The selection state to set
+   */
+  setSelectionState(state: RTESelectionState): void;
   /**
    * Sets the next selection state with specified start and end nodes, offsets, push the update task to a queue
    *
@@ -121,5 +130,9 @@ export declare class SelectionController extends VegaSlimmer {
    * Register the selection range change observer
    */
   private registerSelectionRangeChangeObserver;
+  /**
+   * Prepare the selection state to restore
+   */
+  private prepareRestoreSelectionState;
 }
 export {};

package/dist/types/components/vega-rich-text-editor/slimmers/controllers/value-controller.d.ts

@@ -10,6 +10,8 @@ export declare class ValueController extends VegaSlimmer {
   value: VegaRichTextEditor['value'];
   changeEventEmitter: VegaRichTextEditor['changeEventEmitter'];
   valueController: VegaRichTextEditor['valueController'];
+  historyController: VegaRichTextEditor['historyController'];
+  selectionController: VegaRichTextEditor['selectionController'];
   private flushChangeObserver;
   /**
    * Component lifecycle - [connectedCallback]{@link VegaRichTextEditor.connectedCallback}
@@ -31,8 +33,9 @@ export declare class ValueController extends VegaSlimmer {
    * Updates the value of the editor and restore the selection.
    *
    * @param {VegaRTEContent} newValue The new value to set.
+   * @param {boolean} recordHistory - Whether to record the change in history.
    */
-  flushChanges(newValue: VegaRTEContent): Promise<void>;
+  flushChanges(newValue: VegaRTEContent, recordHistory?: boolean): Promise<void>;
   /**
    * Determines whether the observer should accept changes.
    *

package/dist/types/components/vega-rich-text-editor/vega-rich-text-editor.d.ts

@@ -38,6 +38,7 @@ import { TextNodeColorController } from './slimmers/controllers/text-node-color-
 import { InsertCompositionTextController } from './slimmers/controllers/insert-composition-text-controller';
 import { DeleteSelectedNodesController } from './slimmers/controllers/delete-selected-nodes-controller';
 import { TranslationSlimmer } from '../../helpers/slimmers/translation';
+import { HistoryController } from './slimmers/controllers/history-controller';
 /**
  * @vegaVersion 2.34.0
  */
@@ -77,6 +78,7 @@ export declare class VegaRichTextEditor {
   protected changeEventPreventSlimmer: ChildNodesEventPreventSlimmer;
   protected readonly textNodeColorController: TextNodeColorController;
   protected readonly deleteSelectedNodesController: DeleteSelectedNodesController;
+  protected readonly historyController: HistoryController;
   host: HTMLVegaRichTextEditorElement;
   richTextContentEditable: boolean;
   watchRichTextContentEditable(): void;

package/dist/types/components/vega-tab-group/vega-tab-group.d.ts

@@ -99,6 +99,9 @@ export declare class VegaTabGroup {
    * - If not provided,
    *      the popup will be appended to the body element by default.
    *
+   * @VegaWarning The value of this property should be an element that is
+   * 		the parent of this component or an ancestor of the parent element.
+   *      Using any other element may lead to unexpected behavior.
    * @vegaVersion 1.3.0
    */
   positionRelativeTo: string;

package/dist/types/components/vega-time-picker/vega-time-picker.d.ts

@@ -157,6 +157,9 @@ export declare class VegaTimePicker {
    *    the body by default. Adjust this property
    *    when facing scrolling positioning problems.
    *
+   * @VegaWarning The value of this property should be an element that is
+   * 		the parent of this component or an ancestor of the parent element.
+   * 		Using any other element may lead to unexpected behavior.
    * @vegaVersion 1.12.0
    */
   positionRelativeTo: string;

package/dist/types/components/vega-tooltip/vega-tooltip.d.ts

@@ -95,6 +95,9 @@ export declare class VegaTooltip {
    *    body by default. Adjust this property if you
    *    encounter scrolling or positioning issues.
    *
+   * @VegaWarning The value of this property should be an element that is
+   * 		the parent of this component or an ancestor of the parent element.
+   * 		Using any other element may lead to unexpected behavior.
    * @vegaVersion 1.3.0
    */
   positionRelativeTo: string;