roosterjs 8.47.0 → 8.48.0

package/dist/rooster.d.ts

@@ -1,4 +1,4 @@
-// Type definitions for roosterjs (Version 8.47.0)
+// Type definitions for roosterjs (Version 8.48.0)
 // Generated by dts tool from roosterjs
 // Project: https://github.com/Microsoft/roosterjs
 
@@ -1316,8 +1316,9 @@ function getRegionsFromRange(root: HTMLElement, range: Range, type: RegionType |
  * @param regionBase The region to get block elements from
  * @param createBlockIfEmpty When set to true, a new empty block element will be created if there is not
  * any blocks in the region. Default value is false
+ * @param deprecated Deprecated parameter, not used
  */
-function getSelectedBlockElementsInRegion(regionBase: RegionBase, createBlockIfEmpty?: boolean, shouldApplyFormatToSpan?: boolean): BlockElement[];
+function getSelectedBlockElementsInRegion(regionBase: RegionBase, createBlockIfEmpty?: boolean, deprecated?: boolean): BlockElement[];
 
     /**
  * Collapse nodes within this region to their common ancestor node under this region
@@ -3774,6 +3775,14 @@ const enum ExperimentalFeatures {
      * Align list elements elements to left, center and right using setAlignment API
      */
     ListItemAlignment = "ListItemAlignment",
+    /**
+     * @deprecated
+     */
+    DefaultFormatInSpan = "DefaultFormatInSpan",
+    /**
+     * @deprecated
+     */
+    DefaultFormatOnContainer = "DefaultFormatOnContainer",
     /**
      * Provide additional Tab Key Features. Requires Text Features Content Editable Features
      */
@@ -3789,11 +3798,6 @@ const enum ExperimentalFeatures {
      * is the one closest to the item.
      */
     ReuseAllAncestorListElements = "ReuseAllAncestorListElements",
-    /**
-     * When apply default format when initialize or user type, apply the format on a SPAN element rather than
-     * the block element (In most case, the DIV element) so keep the block element clean.
-     */
-    DefaultFormatInSpan = "DefaultFormatInSpan",
     /**
      * Reuse existing DOM structure if possible when convert Content Model back to DOM tree
      */
@@ -3802,10 +3806,6 @@ const enum ExperimentalFeatures {
      * Handle keyboard editing event with Content Model
      */
     EditWithContentModel = "EditWithContentModel",
-    /**
-     * Apply default format on editor container
-     */
-    DefaultFormatOnContainer = "DefaultFormatOnContainer",
     /**
      * Delete table with Backspace key with the whole was selected with table selector
      */
@@ -4186,7 +4186,7 @@ const enum KnownCreateElementDataIndex {
      */
     TableSelector = 11,
     /**
-     * An empty line without format with span inside of it.
+     * @deprecated
      */
     EmptyLineFormatInSpan = 12
 }
@@ -6702,7 +6702,7 @@ interface IEditor {
      * If it is not cached before, query from DOM and cache the result into the event object
      * @returns A content traverser, or null if editor never got focus before
      */
-    getContentSearcherOfCursor(event?: PluginEvent): IPositionContentSearcher | null;
+    getContentSearcherOfCursor(event?: PluginEvent | null): IPositionContentSearcher | null;
     /**
      * Run a callback function asynchronously
      * @param callback The callback function to run
@@ -7165,8 +7165,7 @@ interface CoreApiMap {
      * @param core The EditorCore object.
      * @param position The position that user is about to type to
      * @param keyboardEvent Optional keyboard event object
-     * @param applyFormatToSpan Optional When set to true, default format (if any) will be applied to
-     * a SPAN element inside the block element instead of the block element itself.
+     * @param deprecated Deprecated parameter, not used
      */
     ensureTypeInContainer: EnsureTypeInContainer;
     /**
@@ -7314,10 +7313,9 @@ type CreatePasteFragment = (core: EditorCore, clipboardData: ClipboardData, posi
  * @param core The EditorCore object.
  * @param position The position that user is about to type to
  * @param keyboardEvent Optional keyboard event object
- * @param applyFormatToSpan Optional When set to true, default format (if any) will be applied to
- * a SPAN element inside the block element instead of the block element itself.
+ * @param deprecated Deprecated parameter, not used
  */
-type EnsureTypeInContainer = (core: EditorCore, position: NodePosition, keyboardEvent?: KeyboardEvent, applyFormatToSpan?: boolean) => void;
+type EnsureTypeInContainer = (core: EditorCore, position: NodePosition, keyboardEvent?: KeyboardEvent, deprecated?: boolean) => void;
 
     /**
  * Focus to editor. If there is a cached selection range, use it as current selection
@@ -8494,6 +8492,14 @@ enum CompatibleExperimentalFeatures {
      * Align list elements elements to left, center and right using setAlignment API
      */
     ListItemAlignment = "ListItemAlignment",
+    /**
+     * @deprecated
+     */
+    DefaultFormatInSpan = "DefaultFormatInSpan",
+    /**
+     * @deprecated
+     */
+    DefaultFormatOnContainer = "DefaultFormatOnContainer",
     /**
      * Provide additional Tab Key Features. Requires Text Features Content Editable Features
      */
@@ -8509,11 +8515,6 @@ enum CompatibleExperimentalFeatures {
      * is the one closest to the item.
      */
     ReuseAllAncestorListElements = "ReuseAllAncestorListElements",
-    /**
-     * When apply default format when initialize or user type, apply the format on a SPAN element rather than
-     * the block element (In most case, the DIV element) so keep the block element clean.
-     */
-    DefaultFormatInSpan = "DefaultFormatInSpan",
     /**
      * Reuse existing DOM structure if possible when convert Content Model back to DOM tree
      */
@@ -8522,10 +8523,6 @@ enum CompatibleExperimentalFeatures {
      * Handle keyboard editing event with Content Model
      */
     EditWithContentModel = "EditWithContentModel",
-    /**
-     * Apply default format on editor container
-     */
-    DefaultFormatOnContainer = "DefaultFormatOnContainer",
     /**
      * Delete table with Backspace key with the whole was selected with table selector
      */
@@ -9655,7 +9652,7 @@ enum CompatibleKnownCreateElementDataIndex {
      */
     TableSelector = 11,
     /**
-     * An empty line without format with span inside of it.
+     * @deprecated
      */
     EmptyLineFormatInSpan = 12
 }