roosterjs 8.35.2 → 8.37.0

package/dist/rooster.d.ts

@@ -1,4 +1,4 @@
-// Type definitions for roosterjs (Version 8.35.2)
+// Type definitions for roosterjs (Version 8.37.0)
 // Generated by dts tool from roosterjs
 // Project: https://github.com/Microsoft/roosterjs
 
@@ -1237,8 +1237,9 @@ class VListChain {
  * If the child inline elements have different styles, it will not modify the styles of the list item
  * @param element the LI Element to set the styles
  * @param styles The styles that should be applied to the element.
+ * @param isCssStyle True means the given styles are CSS style names, false means they are HTML attributes @default true
  */
-function setListItemStyle(element: HTMLLIElement, styles: string[]): void;
+function setListItemStyle(element: HTMLLIElement, styles: string[], isCssStyle?: boolean): void;
 
     /**
  * Get the format info of a table
@@ -1657,6 +1658,35 @@ function getEntityFromElement(element: HTMLElement): Entity | null;
  */
 function getEntitySelector(type?: string, id?: string): string;
 
+    /**
+ * Create a placeholder comment node for entity
+ * @param entity The entity to create placeholder from
+ * @returns A placeholder comment node as
+ */
+function createEntityPlaceholder(entity: Entity): HTMLElement;
+
+    /**
+ * Move content from a container into a new Document fragment, and try keep entities to be reusable by creating placeholder
+ * for them in the document fragment.
+ * If an entity is directly under root container, the whole entity can be reused and no need to move it at all.
+ * If an entity is not directly under root container, it is still reusable, but it may need some movement.
+ * In any case, entities will be replaced with a placeholder in the target document fragment.
+ * We will use an entity map (the "entities" parameter) to save the map from entity id to its wrapper element.
+ * @param root The root element
+ * @param entities A map from entity id to entity wrapper element
+ * @returns A new document fragment contains all the content and entity placeholders
+ */
+function moveContentWithEntityPlaceholders(root: HTMLDivElement, entities: Record<string, HTMLElement>): DocumentFragment;
+
+    /**
+ * Restore HTML content from a document fragment that may contain entity placeholders.
+ * @param source Source document fragment that contains HTML content and entity placeholders
+ * @param target Target container, usually to be editor root container
+ * @param entities A map from entity id to entity wrapper, used for reusing existing DOM structure for entity
+ * @param insertClonedNode When pass true, merge with a cloned copy of the nodes from source fragment rather than the nodes themselves @default false
+ */
+function restoreContentWithEntityPlaceholder(source: DocumentFragment, target: HTMLElement, entities: Record<string, HTMLElement> | null, insertClonedNode?: boolean): void;
+
     /**
  * Gets the cached event data by cache key from event object if there is already one.
  * Otherwise, call getter function to create one, and cache it.
@@ -1715,6 +1745,22 @@ function setStyles(element: HTMLElement, styles: Record<string, string>): void;
  */
 function removeImportantStyleRule(element: HTMLElement, styleProperties: string[]): void;
 
+    /**
+ * Add global css styles
+ * @param doc The document object
+ * @param cssRule The css rule that must added to the selection
+ * @param editorId Te id of the editor
+ * @param styleId the ID of the style tag
+ */
+function setGlobalCssStyles(doc: Document, cssRule: string, styleId: string): void;
+
+    /**
+ * Remove a css rule style from a style sheet
+ * @param doc The document object
+ * @param styleId the ID of the style tag
+ */
+function removeGlobalCssStyle(doc: Document, styleId: string): void;
+
     /**
  *
  * @param root the contentDiv of the ditor
@@ -2669,8 +2715,9 @@ const experimentCommitListChains: typeof commitListChains;
     /**
  * Get dark mode color for a given color
  * @param color The color to calculate from
+ * @param baseLValue The Light value for base dark color in LAB format. @default the Light value for #333333
  */
-function getDarkColor(color: string): string;
+function getDarkColor(color: string, baseLValue?: number): string;
 
     /**
  * Information of current OS and web browser
@@ -2852,6 +2899,10 @@ interface LifecyclePluginState {
      * Cached document fragment for original content
      */
     shadowEditFragment: DocumentFragment | null;
+    /**
+     * Cached entity pairs for original content
+     */
+    shadowEditEntities: Record<string, HTMLElement> | null;
     /**
      * Cached selection path for original content
      */
@@ -3579,6 +3630,7 @@ const enum ExperimentalFeatures {
      */
     ConvertSingleImageBody = "ConvertSingleImageBody",
     /**
+     * @deprecated This feature is always enabled
      * Align table elements to left, center and right using setAlignment API
      */
     TableAlignment = "TableAlignment",
@@ -3587,6 +3639,7 @@ const enum ExperimentalFeatures {
      */
     TabKeyTextFeatures = "TabKeyTextFeatures",
     /**
+     * @deprecated this feature is always enabled
      * Provide a circular resize handles that adaptive the number od handles to the size of the image
      */
     AdaptiveHandlesResizer = "AdaptiveHandlesResizer",
@@ -3615,6 +3668,7 @@ const enum ExperimentalFeatures {
      */
     NormalizeList = "NormalizeList",
     /**
+     * @deprecated this feature is always enabled
      * When a html image is selected, the selected image data will be stored by editor core.
      */
     ImageSelection = "ImageSelection",
@@ -3624,7 +3678,12 @@ const enum ExperimentalFeatures {
      * listTypes array for that item. The only list that we will ensure is correct
      * is the one closest to the item.
      */
-    ReuseAllAncestorListElements = "ReuseAllAncestorListElements"
+    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"
 }
 
     /**
@@ -6658,6 +6717,10 @@ interface CorePlugins {
      * Entity Plugin handles all operations related to an entity and generate entity specified events
      */
     readonly entity: PluginWithState<EntityPluginState>;
+    /**
+     * Image selection Plugin detects image selection and help highlight the image
+     */
+    readonly imageSelection: EditorPlugin;
     /**
      * NormalizeTable plugin makes sure each table in editor has TBODY/THEAD/TFOOT tag around TR tags
      */
@@ -6798,6 +6861,8 @@ 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.
      */
     ensureTypeInContainer: EnsureTypeInContainer;
     /**
@@ -6934,8 +6999,10 @@ 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.
  */
-type EnsureTypeInContainer = (core: EditorCore, position: NodePosition, keyboardEvent?: KeyboardEvent) => void;
+type EnsureTypeInContainer = (core: EditorCore, position: NodePosition, keyboardEvent?: KeyboardEvent, applyFormatToSpan?: boolean) => void;
 
     /**
  * Focus to editor. If there is a cached selection range, use it as current selection
@@ -7296,6 +7363,11 @@ interface ListFeatureSettings {
      * @default true
      */
     autoNumberingList: boolean;
+    /**
+     * MergeListOnBackspaceAfterList edit feature, provides the ability to merge list on backspace on block after a list.
+     * @default true
+     */
+    mergeListOnBackspaceAfterList: boolean;
 }
 
     /**
@@ -7999,6 +8071,7 @@ enum CompatibleExperimentalFeatures {
      */
     ConvertSingleImageBody = "ConvertSingleImageBody",
     /**
+     * @deprecated This feature is always enabled
      * Align table elements to left, center and right using setAlignment API
      */
     TableAlignment = "TableAlignment",
@@ -8007,6 +8080,7 @@ enum CompatibleExperimentalFeatures {
      */
     TabKeyTextFeatures = "TabKeyTextFeatures",
     /**
+     * @deprecated this feature is always enabled
      * Provide a circular resize handles that adaptive the number od handles to the size of the image
      */
     AdaptiveHandlesResizer = "AdaptiveHandlesResizer",
@@ -8035,6 +8109,7 @@ enum CompatibleExperimentalFeatures {
      */
     NormalizeList = "NormalizeList",
     /**
+     * @deprecated this feature is always enabled
      * When a html image is selected, the selected image data will be stored by editor core.
      */
     ImageSelection = "ImageSelection",
@@ -8044,7 +8119,12 @@ enum CompatibleExperimentalFeatures {
      * listTypes array for that item. The only list that we will ensure is correct
      * is the one closest to the item.
      */
-    ReuseAllAncestorListElements = "ReuseAllAncestorListElements"
+    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"
 }
 
     /**
@@ -9640,6 +9720,8 @@ class ImageEdit implements EditorPlugin  {
     private disposer;
     private allowedOperations;
     private image;
+    private clonedImage;
+    private wrapper;
     private editInfo;
     private lastSrc;
     private dndHelpers;
@@ -9647,6 +9729,10 @@ class ImageEdit implements EditorPlugin  {
      * Identify if the image was resized by the user.
      */
     private wasResized;
+    /**
+     * Editor zoom scale
+     */
+    private zoomWrapper;
     /**
      * Create a new instance of ImageEdit
      * @param options Image editing options
@@ -9670,11 +9756,11 @@ class ImageEdit implements EditorPlugin  {
     dispose(): void;
     /**
      * Handle events triggered from editor
-     * @param event PluginEvent object
+     * @param e PluginEvent object
      */
     onPluginEvent(e: PluginEvent): void;
     /**
-     * Check if the given image edit operation is allowed by this pluign
+     * Check if the given image edit operation is allowed by this plugin
      * @param operation The image edit operation to check
      * @returns True means it is allowed, otherwise false
      */
@@ -9701,14 +9787,13 @@ class ImageEdit implements EditorPlugin  {
      * Create editing wrapper for the image
      */
     private createWrapper;
-    /**
-     * Get image wrapper from image
-     * @param image The image to get wrapper from
-     */
-    private getImageWrapper;
+    private toggleImageVisibility;
+    private createZoomWrapper;
+    private copyImageSize;
+    private insertImageWrapper;
+    private getStylePropertyValue;
     /**
      * Remove the temp wrapper of the image
-     * @param wrapper The wrapper object to remove. If not specified, remove all existing wrappers.
      */
     private removeWrapper;
     /**
@@ -10077,27 +10162,4 @@ class AutoFormat implements EditorPlugin  {
     onPluginEvent(event: PluginEvent): void;
 }
 
-    /**
- * Requires @see ExperimentalFeatures.ImageSelection to be enabled.
- * Detect image selection and help highlight the image
- */
-class ImageSelection implements EditorPlugin  {
-    private editor;
-    constructor();
-    /**
-     * Get a friendly name of  this plugin
-     */
-    getName(): string;
-    /**
-     * Initialize this plugin. This should only be called from Editor
-     * @param editor Editor instance
-     */
-    initialize(editor: IEditor): void;
-    /**
-     * Dispose this plugin
-     */
-    dispose(): void;
-    onPluginEvent(event: PluginEvent): void;
-}
-
 }