@cesdk/node 1.72.0-nightly.20260316 → 1.72.0-nightly.20260318

package/index.d.ts

@@ -4326,6 +4326,95 @@ export declare class BlockAPI {
      * @param to - The end index of the UTF-16 range. Defaults to the end of the current selection or text.
      */
     setTextCase(id: DesignBlockId, textCase: TextCase, from?: number, to?: number): void;
+    /**
+     * Gets the unique text decoration configurations within a range of text.
+     *
+     * Each element of the returned array is a decoration configuration representing
+     * a unique combination of lines, style, color, and thickness found in the range.
+     *
+     * ```javascript
+     * const decorations = engine.block.getTextDecorations(text);
+     * // e.g., [{ lines: ['None'] }, { lines: ['Underline'], style: 'Dashed' }]
+     * ```
+     *
+     * @category Block Text
+     * @param id - The text block whose text decorations should be returned.
+     * @param from - The start index of the UTF-16 range. Defaults to the start of the current selection or text.
+     * @param to - The end index of the UTF-16 range. Defaults to the end of the current selection or text.
+     * @returns The ordered list of unique decoration configurations.
+     */
+    getTextDecorations(id: DesignBlockId, from?: number, to?: number): TextDecorationConfig[];
+    /**
+     * Sets the text decoration for a range of text.
+     *
+     * The config specifies which decoration lines, style, underline color, thickness, and offset to apply.
+     * Use `{ lines: ['None'] }` to remove all decorations.
+     *
+     * ```javascript
+     * engine.block.setTextDecoration(text, { lines: ['Underline'] });
+     * engine.block.setTextDecoration(text, { lines: ['Underline', 'Strikethrough'], style: 'Dashed' });
+     * engine.block.setTextDecoration(text, { lines: ['Overline'], style: 'Wavy', underlineThickness: 2.0 });
+     * engine.block.setTextDecoration(text, { lines: ['None'] }); // Remove decorations
+     * ```
+     *
+     * @category Block Text
+     * @param id - The text block whose text decoration should be changed.
+     * @param config - The decoration configuration to apply.
+     * @param from - The start index of the UTF-16 range. Defaults to the start of the current selection or text.
+     * @param to - The end index of the UTF-16 range. Defaults to the end of the current selection or text.
+     */
+    setTextDecoration(id: DesignBlockId, config: TextDecorationConfig, from?: number, to?: number): void;
+    /**
+     * Toggles the underline decoration for a text range.
+     *
+     * If any part of the range does not have underline, the entire range gets underline.
+     * If the entire range already has underline, it is removed.
+     * Other decoration lines (strikethrough, overline) on each text run are preserved.
+     *
+     * ```javascript
+     * engine.block.toggleTextDecorationUnderline(text);
+     * ```
+     *
+     * @category Block Text
+     * @param id - The text block to modify.
+     * @param from - The start index of the UTF-16 range. Defaults to the start of the current selection or text.
+     * @param to - The end index of the UTF-16 range. Defaults to the end of the current selection or text.
+     */
+    toggleTextDecorationUnderline(id: DesignBlockId, from?: number, to?: number): void;
+    /**
+     * Toggles the strikethrough decoration for a text range.
+     *
+     * If any part of the range does not have strikethrough, the entire range gets strikethrough.
+     * If the entire range already has strikethrough, it is removed.
+     * Other decoration lines (underline, overline) on each text run are preserved.
+     *
+     * ```javascript
+     * engine.block.toggleTextDecorationStrikethrough(text);
+     * ```
+     *
+     * @category Block Text
+     * @param id - The text block to modify.
+     * @param from - The start index of the UTF-16 range. Defaults to the start of the current selection or text.
+     * @param to - The end index of the UTF-16 range. Defaults to the end of the current selection or text.
+     */
+    toggleTextDecorationStrikethrough(id: DesignBlockId, from?: number, to?: number): void;
+    /**
+     * Toggles the overline decoration for a text range.
+     *
+     * If any part of the range does not have overline, the entire range gets overline.
+     * If the entire range already has overline, it is removed.
+     * Other decoration lines (underline, strikethrough) on each text run are preserved.
+     *
+     * ```javascript
+     * engine.block.toggleTextDecorationOverline(text);
+     * ```
+     *
+     * @category Block Text
+     * @param id - The text block to modify.
+     * @param from - The start index of the UTF-16 range. Defaults to the start of the current selection or text.
+     * @param to - The end index of the UTF-16 range. Defaults to the end of the current selection or text.
+     */
+    toggleTextDecorationOverline(id: DesignBlockId, from?: number, to?: number): void;
     /**
      * Gets the list style for a specific paragraph of a text block.
      *
@@ -8502,7 +8591,7 @@ export declare const SceneModeValues: readonly ["Design", "Video"];
 export declare type Scope = 'text/edit' | 'text/character' | 'fill/change' | 'fill/changeType' | 'stroke/change' | 'shape/change' | 'layer/move' | 'layer/resize' | 'layer/rotate' | 'layer/flip' | 'layer/crop' | 'layer/opacity' | 'layer/blendMode' | 'layer/visibility' | 'layer/clipping' | 'appearance/adjustments' | 'appearance/filter' | 'appearance/effect' | 'appearance/blur' | 'appearance/shadow' | 'appearance/animation' | 'lifecycle/destroy' | 'lifecycle/duplicate' | 'editor/add' | 'editor/select';
 
 /** @public */
-export declare type SettingBoolPropertyName = 'alwaysHighlightPlaceholders' | 'doubleClickToCropEnabled' | 'showBuildVersion' | 'placeholderControls/showButton' | 'placeholderControls/showOverlay' | 'blockAnimations/enabled' | 'renderTextCursorAndSelectionInEngine' | 'touch/dragStartCanSelect' | 'touch/singlePointPanning' | 'mouse/enableZoom' | 'mouse/enableScroll' | 'controlGizmo/showCropHandles' | 'controlGizmo/showMoveHandles' | 'controlGizmo/showResizeHandles' | 'controlGizmo/showScaleHandles' | 'controlGizmo/showRotateHandles' | 'controlGizmo/showCropScaleHandles' | 'page/title/show' | 'page/title/showPageTitleTemplate' | 'page/title/appendPageName' | 'page/title/showOnSinglePage' | 'page/dimOutOfPageAreas' | 'page/allowCropInteraction' | 'page/allowResizeInteraction' | 'page/restrictResizeInteractionToFixedAspectRatio' | 'page/allowRotateInteraction' | 'page/allowMoveInteraction' | 'page/moveChildrenWhenCroppingFill' | 'page/selectWhenNoBlocksSelected' | 'page/highlightWhenCropping' | 'colorMaskingSettings/secondPass' | 'clampThumbnailTextureSizes' | 'useSystemFontFallback' | 'forceSystemEmojis' | 'features/textEditModeTransformHandlesEnabled' | 'features/videoStreamingEnabled' | (string & {});
+export declare type SettingBoolPropertyName = 'alwaysHighlightPlaceholders' | 'doubleClickToCropEnabled' | 'showBuildVersion' | 'placeholderControls/showButton' | 'placeholderControls/showOverlay' | 'blockAnimations/enabled' | 'renderTextCursorAndSelectionInEngine' | 'touch/dragStartCanSelect' | 'touch/singlePointPanning' | 'mouse/enableZoom' | 'mouse/enableScroll' | 'controlGizmo/showCropHandles' | 'controlGizmo/showMoveHandles' | 'controlGizmo/showResizeHandles' | 'controlGizmo/showScaleHandles' | 'controlGizmo/showRotateHandles' | 'controlGizmo/showCropScaleHandles' | 'page/title/canEdit' | 'page/title/show' | 'page/title/showPageTitleTemplate' | 'page/title/appendPageName' | 'page/title/showOnSinglePage' | 'page/dimOutOfPageAreas' | 'page/allowCropInteraction' | 'page/allowResizeInteraction' | 'page/restrictResizeInteractionToFixedAspectRatio' | 'page/allowRotateInteraction' | 'page/allowMoveInteraction' | 'page/moveChildrenWhenCroppingFill' | 'page/selectWhenNoBlocksSelected' | 'page/highlightWhenCropping' | 'page/highlightDropTarget' | 'page/reparentBlocksToSceneWhenOutOfPage' | 'page/clipped' | 'colorMaskingSettings/secondPass' | 'clampThumbnailTextureSizes' | 'useSystemFontFallback' | 'forceSystemEmojis' | 'features/textEditModeTransformHandlesEnabled' | 'features/videoStreamingEnabled' | 'features/enableAutomaticEnumerations' | (string & {});
 
 /** @public */
 export declare type SettingColorPropertyName = 'clearColor' | 'handleFillColor' | 'highlightColor' | 'pageHighlightColor' | 'placeholderHighlightColor' | 'snappingGuideColor' | 'rotationSnappingGuideColor' | 'cropOverlayColor' | 'textVariableHighlightColor' | 'borderOutlineColor' | 'progressColor' | 'errorStateColor' | 'page/title/color' | 'page/marginFillColor' | 'page/marginFrameColor' | 'page/innerBorderColor' | 'page/outerBorderColor' | 'colorMaskingSettings/maskColor' | (string & {});
@@ -8596,6 +8685,8 @@ export declare interface Settings {
     'page/moveChildrenWhenCroppingFill': boolean;
     /** Whether to append the page name to the title even if not specified in the template. */
     'page/title/appendPageName': boolean;
+    /** Whether double-clicking a page title enters text edit mode to rename the page. */
+    'page/title/canEdit': boolean;
     /** Whether to show titles above each page. */
     'page/title/show': boolean;
     /** Whether to hide the page title when only a single page exists. */
@@ -8622,6 +8713,14 @@ export declare interface Settings {
     'page/selectWhenNoBlocksSelected': boolean;
     /** Whether highlighting should be automatically enabled on the current page when entering crop mode. */
     'page/highlightWhenCropping': boolean;
+    /** Whether to highlight the page under a dragged element as a drop target. */
+    'page/highlightDropTarget': boolean;
+    /** Whether blocks should be reparented to the scene when dragged outside all pages,
+     * and reparented back to a page when dragged over one. */
+    'page/reparentBlocksToSceneWhenOutOfPage': boolean;
+    /** Whether pages should clip their contents to their bounds.
+     * Applies to newly created pages and, when changed, immediately updates all existing pages. */
+    'page/clipped': boolean;
     /** Clamp thumbnail texture sizes to the platform's GPU texture limit. */
     clampThumbnailTextureSizes: boolean;
     /** Toggle the dock components visibility */
@@ -8740,6 +8839,7 @@ export declare interface Settings {
 
 
 
+
 
 
 }
@@ -8992,6 +9092,58 @@ export declare const TextAnimationWritingStyleValues: readonly ["Block", "Line",
  */
 export declare type TextCase = 'Normal' | 'Uppercase' | 'Lowercase' | 'Titlecase';
 
+/**
+ * Configuration for text decorations on a text run.
+ *
+ * All active decoration lines share the same style and thickness.
+ * An optional underline color override can be set; overline and strikethrough
+ * always use the text color.
+ *
+ * @public
+ */
+export declare interface TextDecorationConfig {
+    /** The active decoration line types. Use `['None']` to clear all decorations.
+     * When `'None'` is present, all other values are ignored. */
+    lines: TextDecorationLine[];
+    /** The style of the decoration lines. Defaults to 'Solid'. */
+    style?: TextDecorationStyle;
+    /** Optional color override for underlines only. Uses the text color if not set.
+     * Overline and strikethrough always use the text color. */
+    underlineColor?: Color;
+    /** Multiplier for the underline thickness. Defaults to 1.0. */
+    underlineThickness?: number;
+    /** Relative offset applied to the underline position as a multiplier on the font-default distance. 0 = font default, positive = proportionally further from baseline, negative = proportionally closer. The actual position is computed as `fontDefault * (1 + underlineOffset)`. Defaults to 0.0. */
+    underlineOffset?: number;
+    /** When true, underlines skip over glyph descenders (skip-ink). Defaults to true. */
+    skipInk?: boolean;
+}
+
+/**
+ * Represents a line type for text decoration.
+ *
+ * Text decoration lines are combinable — a range of text can have multiple decoration lines.
+ * - 'None': No decoration.
+ * - 'Underline': The text is underlined.
+ * - 'Strikethrough': The text has a line through it.
+ * - 'Overline': The text has a line above it.
+ *
+ * @public
+ */
+export declare type TextDecorationLine = 'None' | 'Underline' | 'Strikethrough' | 'Overline';
+
+/**
+ * Represents the style of a text decoration line.
+ *
+ * - 'Solid': A solid line (default).
+ * - 'Double': Two parallel lines.
+ * - 'Dotted': A series of dots.
+ * - 'Dashed': A series of dashes.
+ * - 'Wavy': A wavy line.
+ *
+ * @public
+ */
+export declare type TextDecorationStyle = 'Solid' | 'Double' | 'Dotted' | 'Dashed' | 'Wavy';
+
 /**
  * Options for text font size operations with unit support.
  * @public