roosterjs 8.53.0 → 8.55.0

package/dist/rooster.d.ts

@@ -1,4 +1,4 @@
-// Type definitions for roosterjs (Version 8.53.0)
+// Type definitions for roosterjs (Version 8.55.0)
 // Generated by dts tool from roosterjs
 // Project: https://github.com/Microsoft/roosterjs
 
@@ -2341,8 +2341,9 @@ class EditorBase<TEditorCore extends EditorCore, TEditorOptions extends EditorOp
     /**
      * Transform the given node and all its child nodes to dark mode color if editor is in dark mode
      * @param node The node to transform
+     * @param direction The transform direction. @default ColorTransformDirection.LightToDark
      */
-    transformToDarkColor(node: Node): void;
+    transformToDarkColor(node: Node, direction?: ColorTransformDirection | CompatibleColorTransformDirection): void;
     /**
      * Get a darkColorHandler object for this editor.
      */
@@ -2470,7 +2471,7 @@ function createLink(editor: IEditor, link: string, altText?: string, displayText
  * bold, italic, underline, font name, font size, etc.
  * @param editor The editor instance
  * @param event (Optional) The plugin event, it stores the event cached data for looking up.
- * In this function the event cache is used to get list state and header level. If not passed,
+ * In this function the event cache is used to get list state and heading level. If not passed,
  * it will query the node within selection to get the info
  * @returns The format state at cursor
  */
@@ -2480,7 +2481,7 @@ function getFormatState(editor: IEditor, event?: PluginEvent): FormatState;
  * Get element based Format State at cursor
  * @param editor The editor instance
  * @param event (Optional) The plugin event, it stores the event cached data for looking up.
- * In this function the event cache is used to get list state and header level. If not passed,
+ * In this function the event cache is used to get list state and heading level. If not passed,
  * it will query the node within selection to get the info
  * @returns An ElementBasedFormatState object
  */
@@ -2776,13 +2777,19 @@ function toggleSuperscript(editor: IEditor): void;
 function toggleUnderline(editor: IEditor): void;
 
     /**
- * Toggle header at selection
+ * Set heading level at selection
  * @param editor The editor instance
- * @param level The header level, can be a number from 0 to 6, in which 1 ~ 6 refers to
- * the HTML header element &lt;H1&gt; to &lt;H6&gt;, 0 means no header
+ * @param level The heading level, can be a number from 0 to 6, in which 1 ~ 6 refers to
+ * the HTML heading element &lt;H1&gt; to &lt;H6&gt;, 0 means no heading
  * if passed in param is outside the range, will be rounded to nearest number in the range
  */
-function toggleHeader(editor: IEditor, level: number): void;
+function setHeadingLevel(editor: IEditor, level: number): void;
+
+    /**
+ * @deprecated Use setHeadingLevel instead
+ * Keep this for compatibility only, will be removed in next major release
+ */
+const toggleHeader: typeof setHeadingLevel;
 
     /**
  * Set background color of cells.
@@ -5580,7 +5587,12 @@ interface ElementBasedFormatState {
      */
     canAddImageAltText?: boolean;
     /**
-     * Header level (0-6, 0 means no header)
+     * Heading level (0-6, 0 means no heading)
+     */
+    headingLevel?: number;
+    /**
+     * @deprecated Use headingLevel instead
+     * Heading level (0-6, 0 means no heading)
      */
     headerLevel?: number;
     /**
@@ -6877,8 +6889,9 @@ interface IEditor {
     /**
      * Transform the given node and all its child nodes to dark mode color if editor is in dark mode
      * @param node The node to transform
+     * @param direction The transform direction. @default ColorTransformDirection.LightToDark
      */
-    transformToDarkColor(node: Node): void;
+    transformToDarkColor(node: Node, direction?: ColorTransformDirection | CompatibleColorTransformDirection): void;
     /**
      * Get a darkColorHandler object for this editor.
      */