-
Notifications
You must be signed in to change notification settings - Fork 3.6k
/
utils.ts
70 lines (60 loc) · 2.4 KB
/
utils.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
/**
* @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
*/
/**
* @module widget/widgettypearound/utils
*/
import { isWidget } from '../utils.js';
import type {
DocumentSelection,
DomConverter,
Element,
Schema,
Selection,
ViewElement
} from '@ckeditor/ckeditor5-engine';
/**
* The name of the type around model selection attribute responsible for
* displaying a fake caret next to a selected widget.
*/
export const TYPE_AROUND_SELECTION_ATTRIBUTE = 'widget-type-around';
/**
* Checks if an element is a widget that qualifies to get the widget type around UI.
*/
export function isTypeAroundWidget( viewElement: ViewElement | undefined, modelElement: Element, schema: Schema ): boolean {
return !!viewElement && isWidget( viewElement ) && !schema.isInline( modelElement );
}
/**
* For the passed HTML element, this helper finds the closest widget type around button ancestor.
*/
export function getClosestTypeAroundDomButton( domElement: HTMLElement ): HTMLElement | null {
return domElement.closest( '.ck-widget__type-around__button' );
}
/**
* For the passed widget type around button element, this helper determines at which position
* the paragraph would be inserted into the content if, for instance, the button was
* clicked by the user.
*
* @returns The position of the button.
*/
export function getTypeAroundButtonPosition( domElement: HTMLElement ): 'before' | 'after' {
return domElement.classList.contains( 'ck-widget__type-around__button_before' ) ? 'before' : 'after';
}
/**
* For the passed HTML element, this helper returns the closest view widget ancestor.
*/
export function getClosestWidgetViewElement( domElement: HTMLElement, domConverter: DomConverter ): ViewElement {
const widgetDomElement = domElement.closest( '.ck-widget' );
return domConverter.mapDomToView( widgetDomElement as any ) as ViewElement;
}
/**
* For the passed selection instance, it returns the position of the fake caret displayed next to a widget.
*
* **Note**: If the fake caret is not currently displayed, `null` is returned.
*
* @returns The position of the fake caret or `null` when none is present.
*/
export function getTypeAroundFakeCaretPosition( selection: Selection | DocumentSelection ): 'before' | 'after' | null {
return selection.getAttribute( TYPE_AROUND_SELECTION_ATTRIBUTE ) as any;
}