roosterjs 9.0.0 → 9.1.0

package/dist/rooster-amd.d.ts

@@ -1,4 +1,4 @@
-// Type definitions for roosterjs (Version 9.0.0)
+// Type definitions for roosterjs (Version 9.1.0)
 // Generated by dts tool from roosterjs
 // Project: https://github.com/Microsoft/roosterjs
 
@@ -7015,6 +7015,13 @@ export function insertTableRow(table: ContentModelTable, operation: TableVertica
  */
 export function insertTableColumn(table: ContentModelTable, operation: TableHorizontalInsertOperation): void;
 
+/**
+ * Clear selection of a table.
+ * @param table The table model where the selection is to be cleared
+ * @param sel The selection coordinates to be cleared
+ */
+export function clearSelectedCells(table: ContentModelTable, sel: TableSelectionCoordinates): void;
+
 /**
  * Invoke a callback to format the selected table using Content Model
  * @param editor The editor object
@@ -7051,6 +7058,13 @@ export function formatParagraphWithContentModel(editor: IEditor, apiName: string
  */
 export function formatSegmentWithContentModel(editor: IEditor, apiName: string, toggleStyleCallback: (format: ContentModelSegmentFormat, isTuringOn: boolean, segment: ContentModelSegment | null, paragraph: ContentModelParagraph | null) => void, segmentHasStyleCallback?: (format: ContentModelSegmentFormat, segment: ContentModelSegment | null, paragraph: ContentModelParagraph | null) => boolean, includingFormatHolder?: boolean, afterFormatCallback?: (model: ContentModelDocument) => void): void;
 
+/**
+ * Invoke a callback to format the text segment before the selection marker using Content Model
+ * @param editor The editor object
+ * @param callback The callback to format the text segment.
+ */
+export function formatTextSegmentBeforeSelectionMarker(editor: IEditor, callback: (model: ContentModelDocument, previousSegment: ContentModelText, paragraph: ContentModelParagraph, markerFormat: ContentModelSegmentFormat, context: FormatContentModelContext) => boolean): void;
+
 /**
  * Set a list type to content model
  * @param model the model document
@@ -7241,6 +7255,7 @@ export class AutoFormatPlugin implements EditorPlugin  {
      *  - autoNumbering: A boolean that enables or disables automatic numbering formatting. Defaults to false.
      *  - autoLink: A boolean that enables or disables automatic hyperlink creation when pasting or typing content. Defaults to false.
      *  - autoUnlink: A boolean that enables or disables automatic hyperlink removal when pressing backspace. Defaults to false.
+     *  - autoHyphen: A boolean that enables or disables automatic hyphen transformation. Defaults to false.
      */
     constructor(options?: AutoFormatOptions);
     /**
@@ -7292,6 +7307,10 @@ export type AutoFormatOptions = {
      * When paste content, create hyperlink for the pasted link
      */
     autoLink: boolean;
+    /**
+     * Transform -- into hyphen, if typed between two words
+     */
+    autoHyphen: boolean;
 };
 
 /**
@@ -7318,7 +7337,7 @@ export const ShortcutUnderline: ShortcutCommand;
 /**
  * Shortcut command for Clear Format
  * Windows: Ctrl + Space
- * MacOS: Meta + Space
+ * MacOS: N/A
  */
 export const ShortcutClearFormat: ShortcutCommand;
 
@@ -7381,14 +7400,14 @@ export const ShortcutDecreaseFont: ShortcutCommand;
 /**
  * Shortcut command for Intent list
  * Windows: Alt + Shift + Arrow Right
- * MacOS: Option + Shift+ Arrow Right
+ * MacOS: N/A
  */
 export const ShortcutIndentList: ShortcutCommand;
 
 /**
  * Shortcut command for Outdent list
  * Windows: Alt + Shift + Arrow Left
- * MacOS: Option + Shift+ Arrow Left
+ * MacOS: N/A
  */
 export const ShortcutOutdentList: ShortcutCommand;
 
@@ -7596,12 +7615,14 @@ export class MarkdownPlugin implements EditorPlugin  {
     private shouldBold;
     private shouldItalic;
     private shouldStrikethrough;
+    private shouldCode;
     private lastKeyTyped;
     /**
      * @param options An optional parameter that takes in an object of type MarkdownOptions, which includes the following properties:
-     *  - strikethrough: If true text between ~ will receive strikethrough format. Defaults to true.
-     *  - bold: If true text between * will receive bold format. Defaults to true.
-     *  - italic: If true text between _ will receive italic format. Defaults to true.
+     *  - strikethrough: If true text between ~ will receive strikethrough format. Defaults to false.
+     *  - bold: If true text between * will receive bold format. Defaults to false.
+     *  - italic: If true text between _ will receive italic format. Defaults to false.
+     *  - codeFormat: If provided, text between ` will receive code format. Defaults to undefined.
      */
     constructor(options?: MarkdownOptions);
     /**
@@ -7632,17 +7653,79 @@ export class MarkdownPlugin implements EditorPlugin  {
     private handleKeyDownEvent;
     private handleBackspaceEvent;
     private handleContentChangedEvent;
+    private disableAllFeatures;
 }
 
 /**
+ *
  * Options for Markdown plugin
+ *  - strikethrough: If true text between ~ will receive strikethrough format.
+ *  - bold: If true text between * will receive bold format.
+ *  - italic: If true text between _ will receive italic format.
+ *  - codeFormat: If provided, text between ` will receive code format. If equal to {}, it will set the default code format.
  */
 export interface MarkdownOptions {
     strikethrough?: boolean;
     bold?: boolean;
     italic?: boolean;
+    codeFormat?: ContentModelCodeFormat;
 }
 
+/**
+ * Hyperlink plugin does the following jobs for a hyperlink in editor:
+ * 1. When hover on a link, show a tool tip
+ * 2. When Ctrl+Click on a link, open a new window with the link
+ * 3. When type directly on a link whose text matches its link url, update the link url with the link text
+ */
+export class HyperlinkPlugin implements EditorPlugin  {
+    private tooltip;
+    private target?;
+    private onLinkClick?;
+    private editor;
+    private domHelper;
+    private isMac;
+    private disposer;
+    private currentNode;
+    private currentLink;
+    /**
+     * Create a new instance of HyperLink class
+     * @param tooltip Tooltip to show when mouse hover over a link
+     * Default value is to return the href itself. If null, there will be no tooltip text.
+     * @param target (Optional) Target window name for hyperlink. If null, will use "_blank"
+     * @param onLinkClick (Optional) Open link callback (return false to use default behavior)
+     */
+    constructor(tooltip?: HyperlinkToolTip, target?: string | undefined, onLinkClick?: ((anchor: HTMLAnchorElement, mouseEvent: MouseEvent) => boolean | void) | undefined);
+    /**
+     * Get a friendly name of this plugin
+     */
+    getName(): string;
+    /**
+     * Initialize this plugin
+     * @param editor The editor instance
+     */
+    initialize(editor: IEditor): void;
+    /**
+     * Dispose this plugin
+     */
+    dispose(): void;
+    /**
+     * Handle events triggered from editor
+     * @param event PluginEvent object
+     */
+    onPluginEvent(event: PluginEvent): void;
+    protected onMouse: (e: Event) => void;
+    private runWithHyperlink;
+    private isCtrlOrMetaPressed;
+}
+
+/**
+ * A type to specify how to get a tool tip of hyperlink in editor
+ * string: Use this string as tooltip
+ * null: No tooltip
+ * function: Call this function to get a tooltip
+ */
+export type HyperlinkToolTip = string | null | ((url: string, anchor: HTMLAnchorElement) => string);
+
 /**
  * Get dark mode color for a given color
  * @param color The color to calculate from