@soomo/text-annotator 3.2.0-staging.9 → 3.4.0-staging.0

package/dist/src/TextAnnotatorOptions.d.ts

@@ -5,6 +5,18 @@ import { HighlightStyleExpression } from './highlight';
 export interface TextAnnotatorOptions<I extends TextAnnotation = TextAnnotation, E extends unknown = TextAnnotation> {
     adapter?: FormatAdapter<I, E> | null;
     annotatingEnabled?: boolean;
+    /**
+     * Determines whether an active selection should be dismissed
+     * when a user ends their interaction (click, selection)
+     * on a non-annotatable element.
+     * - NEVER - don't dismiss the selection, ignore the action.
+     * - ALWAYS - dismiss the selection.
+     * - function - a custom matcher that takes an event and container as arguments.
+     *              Returns `true` if the selection should be dismissed.
+     *
+     * @defaut NEVER
+     */
+    dismissOnNotAnnotatable?: DismissOnNotAnnotatableExpression;
     renderer?: RendererType;
     offsetReferenceSelector?: string;
     userSelectAction?: UserSelectActionExpression<E>;
@@ -14,4 +26,5 @@ export interface TextAnnotatorOptions<I extends TextAnnotation = TextAnnotation,
     user?: User;
 }
 export type RendererType = 'SPANS' | 'CANVAS' | 'CSS_HIGHLIGHTS';
+export type DismissOnNotAnnotatableExpression = 'NEVER' | 'ALWAYS' | ((event: Event, container: HTMLElement) => boolean);
 export declare const fillDefaults: <I extends TextAnnotation = TextAnnotation, E extends unknown = TextAnnotation>(opts: TextAnnotatorOptions<I, E>, defaults: TextAnnotatorOptions<I, E>) => TextAnnotatorOptions<I, E>;

package/dist/src/utils/isNotAnnotatable.d.ts

@@ -1,4 +1,4 @@
 export declare const NOT_ANNOTATABLE_CLASS = "not-annotatable";
 export declare const NOT_ANNOTATABLE_SELECTOR = ".not-annotatable";
-export declare const isNotAnnotatable: (node: Node) => boolean;
-export declare const isRangeAnnotatable: (range: Range) => boolean;
+export declare const isNotAnnotatable: (container: Node, node: Node) => boolean;
+export declare const isRangeAnnotatable: (container: Node, range: Range) => boolean;

package/dist/src/utils/splitAnnotatableRanges.d.ts

@@ -1,5 +1,5 @@
 /**
  * Splits a DOM Range into one or more ranges that span annotatable content only.
  */
-export declare const splitAnnotatableRanges: (range: Range) => Range[];
+export declare const splitAnnotatableRanges: (container: Node, range: Range) => Range[];
 export declare const getRangeAnnotatableContents: (range: Range) => DocumentFragment;