roosterjs-content-model-types - npm Package Compare versions

Comparing version 9.1.0 to 9.2.0

lib-amd/editor/EditorCore.d.ts

@@ -0,1 +1,2 @@
+import type { AnnounceData } from '../parameter/AnnounceData';
 import type { DOMHelper } from '../parameter/DOMHelper';
@@ -125,2 +126,8 @@ import type { PluginEvent } from '../event/PluginEvent';
 /**
+ * Announce the given data
+ * @param core The EditorCore object
+ * @param announceData Data to announce
+ */
+export declare type Announce = (core: EditorCore, announceData: AnnounceData) => void;
+/**
  * The interface for the map of core API for Editor.
@@ -232,2 +239,8 @@ * Editor can call call API from this map under EditorCore object
     setEditorStyle: SetEditorStyle;
+    /**
+     * Announce the given data
+     * @param core The EditorCore object
+     * @param announceData Data to announce
+     */
+    announce: Announce;
 }
@@ -234,0 +247,0 @@ /**

lib-amd/editor/EditorOptions.d.ts

@@ -0,1 +1,2 @@
+import type { KnownAnnounceStrings } from '../parameter/AnnounceData';
 import type { PasteType } from '../enum/PasteType';
@@ -102,2 +103,8 @@ import type { Colors, ColorTransformFunction } from '../context/DarkColorHandler';
     defaultPasteType?: PasteType;
+    /**
+     * A callback to help get string template to announce, used for accessibility
+     * @param key The key of known announce data
+     * @returns A template string to announce, use placeholder such as "{0}" for variables if necessary
+     */
+    announcerStringGetter?: (key: KnownAnnounceStrings) => string;
 }

lib-amd/editor/IEditor.d.ts

@@ -0,1 +1,2 @@
+import type { AnnounceData } from '../parameter/AnnounceData';
 import type { DomToModelOptionForCreateModel } from '../context/DomToModelOption';
@@ -178,2 +179,7 @@ import type { DOMHelper } from '../parameter/DOMHelper';
     setEditorStyle(key: string, cssRule: string | null, subSelectors?: 'before' | 'after' | string[]): void;
+    /**
+     * Announce the given data
+     * @param announceData Data to announce
+     */
+    announce(announceData: AnnounceData): void;
 }

lib-amd/event/ContentChangedEvent.d.ts

@@ -58,5 +58,5 @@ import type { AnnounceData } from '../parameter/AnnounceData';
     /**
-     * @optional Announce data from this content changed event.
+     * @deprecated Call editor.announce(announceData) directly insteaad
      */
     readonly announceData?: AnnounceData;
 }

lib-amd/group/ContentModelDocument.d.ts

@@ -8,2 +8,6 @@ import type { ContentModelBlockGroupBase } from './ContentModelBlockGroupBase';
 export interface ContentModelDocument extends ContentModelBlockGroupBase<'Document'>, Partial<ContentModelWithFormat<ContentModelSegmentFormat>> {
+    /**
+     * Whether the selection in model (if any) is a revert selection (end is before start)
+     */
+    hasRevertedRangeSelection?: boolean;
 }

lib-amd/index.d.ts

@@ -118,3 +118,3 @@ export { ContentModelSegmentFormat } from './format/ContentModelSegmentFormat';
 export { EditorOptions } from './editor/EditorOptions';
-export { CreateContentModel, CreateEditorContext, GetDOMSelection, SetContentModel, SetDOMSelection, SetLogicalRoot, FormatContentModel, CoreApiMap, EditorCore, SwitchShadowEdit, TriggerEvent, AddUndoSnapshot, Focus, AttachDomEvent, RestoreUndoSnapshot, GetVisibleViewport, SetEditorStyle, } from './editor/EditorCore';
+export { CreateContentModel, CreateEditorContext, GetDOMSelection, SetContentModel, SetDOMSelection, SetLogicalRoot, FormatContentModel, CoreApiMap, EditorCore, SwitchShadowEdit, TriggerEvent, AddUndoSnapshot, Focus, AttachDomEvent, RestoreUndoSnapshot, GetVisibleViewport, SetEditorStyle, Announce, } from './editor/EditorCore';
 export { EditorCorePlugins } from './editor/EditorCorePlugins';
@@ -121,0 +121,0 @@ export { EditorPlugin } from './editor/EditorPlugin';

lib-amd/parameter/DOMHelper.d.ts

@@ -69,2 +69,10 @@ /**
     hasFocus(): boolean;
+    /**
+     * Check if the root element is in RTL mode
+     */
+    isRightToLeft(): boolean;
+    /**
+     * Get the width of the editable area of the editor content div
+     */
+    getClientWidth(): number;
 }

lib-amd/parameter/FormatContentModelContext.d.ts

@@ -0,1 +1,2 @@
+import type { AnnounceData } from './AnnounceData';
 import type { ContentModelEntity } from '../entity/ContentModelEntity';
@@ -86,2 +87,6 @@ import type { ContentModelImage } from '../segment/ContentModelImage';
     canUndoByBackspace?: boolean;
+    /**
+     * @optional Set this value to tell AnnouncePlugin to announce the given information
+     */
+    announceData?: AnnounceData | null;
 }

lib-amd/pluginState/LifecyclePluginState.d.ts

@@ -0,1 +1,2 @@
+import type { KnownAnnounceStrings } from '../parameter/AnnounceData';
 /**
@@ -14,2 +15,12 @@ * The state object for LifecyclePlugin
     /**
+     * The HTML container for announced string
+     */
+    announceContainer?: HTMLElement;
+    /**
+     * A callback to help get string template to announce, used for accessibility
+     * @param key The key of known announce data
+     * @returns A template string to announce, use placeholder such as "{0}" for variables if necessary
+     */
+    readonly announcerStringGetter?: (key: KnownAnnounceStrings) => string;
+    /**
      * Style elements used for adding CSS rules for editor
@@ -16,0 +27,0 @@ */

lib-mjs/editor/EditorCore.d.ts

@@ -0,1 +1,2 @@
+import type { AnnounceData } from '../parameter/AnnounceData';
 import type { DOMHelper } from '../parameter/DOMHelper';
@@ -125,2 +126,8 @@ import type { PluginEvent } from '../event/PluginEvent';
 /**
+ * Announce the given data
+ * @param core The EditorCore object
+ * @param announceData Data to announce
+ */
+export declare type Announce = (core: EditorCore, announceData: AnnounceData) => void;
+/**
  * The interface for the map of core API for Editor.
@@ -232,2 +239,8 @@ * Editor can call call API from this map under EditorCore object
     setEditorStyle: SetEditorStyle;
+    /**
+     * Announce the given data
+     * @param core The EditorCore object
+     * @param announceData Data to announce
+     */
+    announce: Announce;
 }
@@ -234,0 +247,0 @@ /**

lib-mjs/editor/EditorOptions.d.ts

@@ -0,1 +1,2 @@
+import type { KnownAnnounceStrings } from '../parameter/AnnounceData';
 import type { PasteType } from '../enum/PasteType';
@@ -102,2 +103,8 @@ import type { Colors, ColorTransformFunction } from '../context/DarkColorHandler';
     defaultPasteType?: PasteType;
+    /**
+     * A callback to help get string template to announce, used for accessibility
+     * @param key The key of known announce data
+     * @returns A template string to announce, use placeholder such as "{0}" for variables if necessary
+     */
+    announcerStringGetter?: (key: KnownAnnounceStrings) => string;
 }

lib-mjs/editor/IEditor.d.ts

@@ -0,1 +1,2 @@
+import type { AnnounceData } from '../parameter/AnnounceData';
 import type { DomToModelOptionForCreateModel } from '../context/DomToModelOption';
@@ -178,2 +179,7 @@ import type { DOMHelper } from '../parameter/DOMHelper';
     setEditorStyle(key: string, cssRule: string | null, subSelectors?: 'before' | 'after' | string[]): void;
+    /**
+     * Announce the given data
+     * @param announceData Data to announce
+     */
+    announce(announceData: AnnounceData): void;
 }

lib-mjs/event/ContentChangedEvent.d.ts

@@ -58,5 +58,5 @@ import type { AnnounceData } from '../parameter/AnnounceData';
     /**
-     * @optional Announce data from this content changed event.
+     * @deprecated Call editor.announce(announceData) directly insteaad
      */
     readonly announceData?: AnnounceData;
 }

lib-mjs/group/ContentModelDocument.d.ts

@@ -8,2 +8,6 @@ import type { ContentModelBlockGroupBase } from './ContentModelBlockGroupBase';
 export interface ContentModelDocument extends ContentModelBlockGroupBase<'Document'>, Partial<ContentModelWithFormat<ContentModelSegmentFormat>> {
+    /**
+     * Whether the selection in model (if any) is a revert selection (end is before start)
+     */
+    hasRevertedRangeSelection?: boolean;
 }

lib-mjs/index.d.ts

@@ -118,3 +118,3 @@ export { ContentModelSegmentFormat } from './format/ContentModelSegmentFormat';
 export { EditorOptions } from './editor/EditorOptions';
-export { CreateContentModel, CreateEditorContext, GetDOMSelection, SetContentModel, SetDOMSelection, SetLogicalRoot, FormatContentModel, CoreApiMap, EditorCore, SwitchShadowEdit, TriggerEvent, AddUndoSnapshot, Focus, AttachDomEvent, RestoreUndoSnapshot, GetVisibleViewport, SetEditorStyle, } from './editor/EditorCore';
+export { CreateContentModel, CreateEditorContext, GetDOMSelection, SetContentModel, SetDOMSelection, SetLogicalRoot, FormatContentModel, CoreApiMap, EditorCore, SwitchShadowEdit, TriggerEvent, AddUndoSnapshot, Focus, AttachDomEvent, RestoreUndoSnapshot, GetVisibleViewport, SetEditorStyle, Announce, } from './editor/EditorCore';
 export { EditorCorePlugins } from './editor/EditorCorePlugins';
@@ -121,0 +121,0 @@ export { EditorPlugin } from './editor/EditorPlugin';

lib-mjs/parameter/DOMHelper.d.ts

@@ -69,2 +69,10 @@ /**
     hasFocus(): boolean;
+    /**
+     * Check if the root element is in RTL mode
+     */
+    isRightToLeft(): boolean;
+    /**
+     * Get the width of the editable area of the editor content div
+     */
+    getClientWidth(): number;
 }

lib-mjs/parameter/FormatContentModelContext.d.ts

@@ -0,1 +1,2 @@
+import type { AnnounceData } from './AnnounceData';
 import type { ContentModelEntity } from '../entity/ContentModelEntity';
@@ -86,2 +87,6 @@ import type { ContentModelImage } from '../segment/ContentModelImage';
     canUndoByBackspace?: boolean;
+    /**
+     * @optional Set this value to tell AnnouncePlugin to announce the given information
+     */
+    announceData?: AnnounceData | null;
 }

lib-mjs/pluginState/LifecyclePluginState.d.ts

@@ -0,1 +1,2 @@
+import type { KnownAnnounceStrings } from '../parameter/AnnounceData';
 /**
@@ -14,2 +15,12 @@ * The state object for LifecyclePlugin
     /**
+     * The HTML container for announced string
+     */
+    announceContainer?: HTMLElement;
+    /**
+     * A callback to help get string template to announce, used for accessibility
+     * @param key The key of known announce data
+     * @returns A template string to announce, use placeholder such as "{0}" for variables if necessary
+     */
+    readonly announcerStringGetter?: (key: KnownAnnounceStrings) => string;
+    /**
      * Style elements used for adding CSS rules for editor
@@ -16,0 +27,0 @@ */

lib/editor/EditorCore.d.ts

@@ -0,1 +1,2 @@
+import type { AnnounceData } from '../parameter/AnnounceData';
 import type { DOMHelper } from '../parameter/DOMHelper';
@@ -125,2 +126,8 @@ import type { PluginEvent } from '../event/PluginEvent';
 /**
+ * Announce the given data
+ * @param core The EditorCore object
+ * @param announceData Data to announce
+ */
+export declare type Announce = (core: EditorCore, announceData: AnnounceData) => void;
+/**
  * The interface for the map of core API for Editor.
@@ -232,2 +239,8 @@ * Editor can call call API from this map under EditorCore object
     setEditorStyle: SetEditorStyle;
+    /**
+     * Announce the given data
+     * @param core The EditorCore object
+     * @param announceData Data to announce
+     */
+    announce: Announce;
 }
@@ -234,0 +247,0 @@ /**

lib/editor/EditorOptions.d.ts

@@ -0,1 +1,2 @@
+import type { KnownAnnounceStrings } from '../parameter/AnnounceData';
 import type { PasteType } from '../enum/PasteType';
@@ -102,2 +103,8 @@ import type { Colors, ColorTransformFunction } from '../context/DarkColorHandler';
     defaultPasteType?: PasteType;
+    /**
+     * A callback to help get string template to announce, used for accessibility
+     * @param key The key of known announce data
+     * @returns A template string to announce, use placeholder such as "{0}" for variables if necessary
+     */
+    announcerStringGetter?: (key: KnownAnnounceStrings) => string;
 }

lib/editor/IEditor.d.ts

@@ -0,1 +1,2 @@
+import type { AnnounceData } from '../parameter/AnnounceData';
 import type { DomToModelOptionForCreateModel } from '../context/DomToModelOption';
@@ -178,2 +179,7 @@ import type { DOMHelper } from '../parameter/DOMHelper';
     setEditorStyle(key: string, cssRule: string | null, subSelectors?: 'before' | 'after' | string[]): void;
+    /**
+     * Announce the given data
+     * @param announceData Data to announce
+     */
+    announce(announceData: AnnounceData): void;
 }

lib/event/ContentChangedEvent.d.ts

@@ -58,5 +58,5 @@ import type { AnnounceData } from '../parameter/AnnounceData';
     /**
-     * @optional Announce data from this content changed event.
+     * @deprecated Call editor.announce(announceData) directly insteaad
      */
     readonly announceData?: AnnounceData;
 }

lib/group/ContentModelDocument.d.ts

@@ -8,2 +8,6 @@ import type { ContentModelBlockGroupBase } from './ContentModelBlockGroupBase';
 export interface ContentModelDocument extends ContentModelBlockGroupBase<'Document'>, Partial<ContentModelWithFormat<ContentModelSegmentFormat>> {
+    /**
+     * Whether the selection in model (if any) is a revert selection (end is before start)
+     */
+    hasRevertedRangeSelection?: boolean;
 }

lib/index.d.ts

@@ -118,3 +118,3 @@ export { ContentModelSegmentFormat } from './format/ContentModelSegmentFormat';
 export { EditorOptions } from './editor/EditorOptions';
-export { CreateContentModel, CreateEditorContext, GetDOMSelection, SetContentModel, SetDOMSelection, SetLogicalRoot, FormatContentModel, CoreApiMap, EditorCore, SwitchShadowEdit, TriggerEvent, AddUndoSnapshot, Focus, AttachDomEvent, RestoreUndoSnapshot, GetVisibleViewport, SetEditorStyle, } from './editor/EditorCore';
+export { CreateContentModel, CreateEditorContext, GetDOMSelection, SetContentModel, SetDOMSelection, SetLogicalRoot, FormatContentModel, CoreApiMap, EditorCore, SwitchShadowEdit, TriggerEvent, AddUndoSnapshot, Focus, AttachDomEvent, RestoreUndoSnapshot, GetVisibleViewport, SetEditorStyle, Announce, } from './editor/EditorCore';
 export { EditorCorePlugins } from './editor/EditorCorePlugins';
@@ -121,0 +121,0 @@ export { EditorPlugin } from './editor/EditorPlugin';

lib/parameter/DOMHelper.d.ts

@@ -69,2 +69,10 @@ /**
     hasFocus(): boolean;
+    /**
+     * Check if the root element is in RTL mode
+     */
+    isRightToLeft(): boolean;
+    /**
+     * Get the width of the editable area of the editor content div
+     */
+    getClientWidth(): number;
 }

lib/parameter/FormatContentModelContext.d.ts

@@ -0,1 +1,2 @@
+import type { AnnounceData } from './AnnounceData';
 import type { ContentModelEntity } from '../entity/ContentModelEntity';
@@ -86,2 +87,6 @@ import type { ContentModelImage } from '../segment/ContentModelImage';
     canUndoByBackspace?: boolean;
+    /**
+     * @optional Set this value to tell AnnouncePlugin to announce the given information
+     */
+    announceData?: AnnounceData | null;
 }

lib/pluginState/LifecyclePluginState.d.ts

@@ -0,1 +1,2 @@
+import type { KnownAnnounceStrings } from '../parameter/AnnounceData';
 /**
@@ -14,2 +15,12 @@ * The state object for LifecyclePlugin
     /**
+     * The HTML container for announced string
+     */
+    announceContainer?: HTMLElement;
+    /**
+     * A callback to help get string template to announce, used for accessibility
+     * @param key The key of known announce data
+     * @returns A template string to announce, use placeholder such as "{0}" for variables if necessary
+     */
+    readonly announcerStringGetter?: (key: KnownAnnounceStrings) => string;
+    /**
      * Style elements used for adding CSS rules for editor
@@ -16,0 +27,0 @@ */

package.json

@@ -5,3 +5,3 @@ {
     "dependencies": {},
-    "version": "9.1.0",
+    "version": "9.2.0",
     "main": "./lib/index.js",
@@ -8,0 +8,0 @@ "typings": "./lib/index.d.ts",

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

1454405

increased by0.88%

Lines of code

18252

increased by0.9%

No dependency changes