-
-
Notifications
You must be signed in to change notification settings - Fork 3.7k
/
balloonpanelview.ts
1193 lines (1091 loc) · 33.7 KB
/
balloonpanelview.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
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/**
* @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
*/
/**
* @module ui/panel/balloon/balloonpanelview
*/
import View from '../../view';
import type ViewCollection from '../../viewcollection';
import {
getOptimalPosition,
global,
isRange,
toUnit,
type Locale,
type ObservableChangeEvent,
type Position,
type PositionOptions,
type PositioningFunction,
type Rect
} from '@ckeditor/ckeditor5-utils';
import { isElement } from 'lodash-es';
import '../../../theme/components/panel/balloonpanel.css';
const toPx = toUnit( 'px' );
const defaultLimiterElement = global.document.body;
// A static balloon panel positioning function that moves the balloon far off the viewport.
// It is used as a fallback when there is no way to position the balloon using provided
// positioning functions (see: `getOptimalPosition()`), for instance, when the target the
// balloon should be attached to gets obscured by scrollable containers or the viewport.
//
// It prevents the balloon from being attached to the void and possible degradation of the UX.
// At the same time, it keeps the balloon physically visible in the DOM so the focus remains
// uninterrupted.
const POSITION_OFF_SCREEN: Position = {
top: -99999,
left: -99999,
name: 'arrowless',
config: {
withArrow: false
}
};
/**
* The balloon panel view class.
*
* A floating container which can
* {@link module:ui/panel/balloon/balloonpanelview~BalloonPanelView#pin pin} to any
* {@link module:utils/dom/position~Options#target target} in the DOM and remain in that position
* e.g. when the web page is scrolled.
*
* The balloon panel can be used to display contextual, non-blocking UI like forms, toolbars and
* the like in its {@link module:ui/panel/balloon/balloonpanelview~BalloonPanelView#content} view
* collection.
*
* There is a number of {@link module:ui/panel/balloon/balloonpanelview~BalloonPanelView.defaultPositions}
* that the balloon can use, automatically switching from one to another when the viewport space becomes
* scarce to keep the balloon visible to the user as long as it is possible. The balloon will also
* accept any custom position set provided by the user compatible with the
* {@link module:utils/dom/position~Options options}.
*
* ```ts
* const panel = new BalloonPanelView( locale );
* const childView = new ChildView();
* const positions = BalloonPanelView.defaultPositions;
*
* panel.render();
*
* // Add a child view to the panel's content collection.
* panel.content.add( childView );
*
* // Start pinning the panel to an element with the "target" id DOM.
* // The balloon will remain pinned until unpin() is called.
* panel.pin( {
* target: document.querySelector( '#target' ),
* positions: [
* positions.northArrowSouth,
* positions.southArrowNorth
* ]
* } );
* ```
*/
export default class BalloonPanelView extends View {
/**
* A collection of the child views that creates the balloon panel contents.
*/
public readonly content: ViewCollection;
/**
* The absolute top position of the balloon panel in pixels.
*
* @observable
* @default 0
*/
declare public top: number;
/**
* The absolute left position of the balloon panel in pixels.
*
* @observable
* @default 0
*/
declare public left: number;
/**
* The balloon panel's current position. The position name is reflected in the CSS class set
* to the balloon, i.e. `.ck-balloon-panel_arrow_nw` for the "arrow_nw" position. The class
* controls the minor aspects of the balloon's visual appearance like the placement
* of an {@link #withArrow arrow}. To support a new position, an additional CSS must be created.
*
* Default position names correspond with
* {@link module:ui/panel/balloon/balloonpanelview~BalloonPanelView.defaultPositions}.
*
* See the {@link #attachTo} and {@link #pin} methods to learn about custom balloon positions.
*
* @observable
* @default 'arrow_nw'
*/
declare public position: 'arrow_nw' | 'arrow_ne' | 'arrow_sw' | 'arrow_se';
/**
* Controls whether the balloon panel is visible or not.
*
* @observable
* @default false
*/
declare public isVisible: boolean;
/**
* Controls whether the balloon panel has an arrow. The presence of the arrow
* is reflected in the `ck-balloon-panel_with-arrow` CSS class.
*
* @observable
* @default true
*/
declare public withArrow: boolean;
/**
* An additional CSS class added to the {@link #element}.
*
* @observable
*/
declare public class: string | undefined;
/**
* A callback that starts pinning the panel when {@link #isVisible} gets
* `true`. Used by {@link #pin}.
*
* @private
*/
private _pinWhenIsVisibleCallback: ( () => void ) | null;
/**
* @inheritDoc
*/
constructor( locale?: Locale ) {
super( locale );
const bind = this.bindTemplate;
this.set( 'top', 0 );
this.set( 'left', 0 );
this.set( 'position', 'arrow_nw' );
this.set( 'isVisible', false );
this.set( 'withArrow', true );
this.set( 'class', undefined );
this._pinWhenIsVisibleCallback = null;
this.content = this.createCollection();
this.setTemplate( {
tag: 'div',
attributes: {
class: [
'ck',
'ck-balloon-panel',
bind.to( 'position', value => `ck-balloon-panel_${ value }` ),
bind.if( 'isVisible', 'ck-balloon-panel_visible' ),
bind.if( 'withArrow', 'ck-balloon-panel_with-arrow' ),
bind.to( 'class' )
],
style: {
top: bind.to( 'top', toPx ),
left: bind.to( 'left', toPx )
}
},
children: this.content
} );
}
/**
* Shows the panel.
*
* See {@link #isVisible}.
*/
public show(): void {
this.isVisible = true;
}
/**
* Hides the panel.
*
* See {@link #isVisible}.
*/
public hide(): void {
this.isVisible = false;
}
/**
* Attaches the panel to a specified {@link module:utils/dom/position~Options#target} with a
* smart positioning heuristics that chooses from available positions to make sure the panel
* is visible to the user i.e. within the limits of the viewport.
*
* This method accepts configuration {@link module:utils/dom/position~Options options}
* to set the `target`, optional `limiter` and `positions` the balloon should choose from.
*
* ```ts
* const panel = new BalloonPanelView( locale );
* const positions = BalloonPanelView.defaultPositions;
*
* panel.render();
*
* // Attach the panel to an element with the "target" id DOM.
* panel.attachTo( {
* target: document.querySelector( '#target' ),
* positions: [
* positions.northArrowSouth,
* positions.southArrowNorth
* ]
* } );
* ```
*
* **Note**: Attaching the panel will also automatically {@link #show} it.
*
* **Note**: An attached panel will not follow its target when the window is scrolled or resized.
* See the {@link #pin} method for a more permanent positioning strategy.
*
* @param options Positioning options compatible with {@link module:utils/dom/position~getOptimalPosition}.
* Default `positions` array is {@link module:ui/panel/balloon/balloonpanelview~BalloonPanelView.defaultPositions}.
*/
public attachTo( options: Partial<PositionOptions> ): void {
this.show();
const defaultPositions = BalloonPanelView.defaultPositions;
const positionOptions = Object.assign( {}, {
element: this.element,
positions: [
defaultPositions.southArrowNorth,
defaultPositions.southArrowNorthMiddleWest,
defaultPositions.southArrowNorthMiddleEast,
defaultPositions.southArrowNorthWest,
defaultPositions.southArrowNorthEast,
defaultPositions.northArrowSouth,
defaultPositions.northArrowSouthMiddleWest,
defaultPositions.northArrowSouthMiddleEast,
defaultPositions.northArrowSouthWest,
defaultPositions.northArrowSouthEast,
defaultPositions.viewportStickyNorth
],
limiter: defaultLimiterElement,
fitInViewport: true
}, options ) as PositionOptions;
const optimalPosition = BalloonPanelView._getOptimalPosition( positionOptions ) || POSITION_OFF_SCREEN;
// Usually browsers make some problems with super accurate values like 104.345px
// so it is better to use int values.
const left = parseInt( optimalPosition.left as any );
const top = parseInt( optimalPosition.top as any );
const position = optimalPosition.name as this[ 'position' ];
const config: { withArrow?: boolean } = optimalPosition.config || {};
const { withArrow = true } = config;
this.top = top;
this.left = left;
this.position = position;
this.withArrow = withArrow;
}
/**
* Works the same way as the {@link #attachTo} method except that the position of the panel is
* continuously updated when:
*
* * any ancestor of the {@link module:utils/dom/position~Options#target}
* or {@link module:utils/dom/position~Options#limiter} is scrolled,
* * the browser window gets resized or scrolled.
*
* Thanks to that, the panel always sticks to the {@link module:utils/dom/position~Options#target}
* and is immune to the changing environment.
*
* ```ts
* const panel = new BalloonPanelView( locale );
* const positions = BalloonPanelView.defaultPositions;
*
* panel.render();
*
* // Pin the panel to an element with the "target" id DOM.
* panel.pin( {
* target: document.querySelector( '#target' ),
* positions: [
* positions.northArrowSouth,
* positions.southArrowNorth
* ]
* } );
* ```
*
* To leave the pinned state, use the {@link #unpin} method.
*
* **Note**: Pinning the panel will also automatically {@link #show} it.
*
* @param options Positioning options compatible with {@link module:utils/dom/position~getOptimalPosition}.
* Default `positions` array is {@link module:ui/panel/balloon/balloonpanelview~BalloonPanelView.defaultPositions}.
*/
public pin( options: Partial<PositionOptions> ): void {
this.unpin();
this._pinWhenIsVisibleCallback = () => {
if ( this.isVisible ) {
this._startPinning( options );
} else {
this._stopPinning();
}
};
this._startPinning( options );
// Control the state of the listeners depending on whether the panel is visible
// or not.
// TODO: Use on() (https://github.com/ckeditor/ckeditor5-utils/issues/144).
this.listenTo<ObservableChangeEvent>( this, 'change:isVisible', this._pinWhenIsVisibleCallback );
}
/**
* Stops pinning the panel, as set up by {@link #pin}.
*/
public unpin(): void {
if ( this._pinWhenIsVisibleCallback ) {
// Deactivate listeners attached by pin().
this._stopPinning();
// Deactivate the panel pin() control logic.
// TODO: Use off() (https://github.com/ckeditor/ckeditor5-utils/issues/144).
this.stopListening( this, 'change:isVisible', this._pinWhenIsVisibleCallback );
this._pinWhenIsVisibleCallback = null;
this.hide();
}
}
/**
* Starts managing the pinned state of the panel. See {@link #pin}.
*
* @param options Positioning options compatible with {@link module:utils/dom/position~getOptimalPosition}.
*/
private _startPinning( options: Partial<PositionOptions> ) {
this.attachTo( options );
const targetElement = getDomElement( options.target );
const limiterElement = options.limiter ? getDomElement( options.limiter ) : defaultLimiterElement;
// Then we need to listen on scroll event of eny element in the document.
this.listenTo( global.document, 'scroll', ( evt, domEvt ) => {
const scrollTarget = domEvt.target as Element;
// The position needs to be updated if the positioning target is within the scrolled element.
const isWithinScrollTarget = targetElement && scrollTarget.contains( targetElement );
// The position needs to be updated if the positioning limiter is within the scrolled element.
const isLimiterWithinScrollTarget = limiterElement && scrollTarget.contains( limiterElement );
// The positioning target and/or limiter can be a Rect, object etc..
// There's no way to optimize the listener then.
if ( isWithinScrollTarget || isLimiterWithinScrollTarget || !targetElement || !limiterElement ) {
this.attachTo( options );
}
}, { useCapture: true } );
// We need to listen on window resize event and update position.
this.listenTo( global.window, 'resize', () => {
this.attachTo( options );
} );
}
/**
* Stops managing the pinned state of the panel. See {@link #pin}.
*/
private _stopPinning(): void {
this.stopListening( global.document, 'scroll' );
this.stopListening( global.window, 'resize' );
}
/**
* A side offset of the arrow tip from the edge of the balloon. Controlled by CSS.
*
* ```
* ┌───────────────────────┐
* │ │
* │ Balloon │
* │ Content │
* │ │
* └──+ +───────────────┘
* | \ /
* | \/
* >┼─────┼< ─────────────────────── side offset
*
* ```
*
* @default 25
*/
public static arrowSideOffset = 25;
/**
* A height offset of the arrow from the edge of the balloon. Controlled by CSS.
*
* ```
* ┌───────────────────────┐
* │ │
* │ Balloon │
* │ Content │ ╱-- arrow height offset
* │ │ V
* └──+ +───────────────┘ --- ─┼───────
* \ / │
* \/ │
* ────────────────────────────────┼───────
* ^
*
*
* >┼────┼< arrow height offset
* │ │
* │ ┌────────────────────────┐
* │ │ │
* │ ╱ │
* │ ╱ Balloon │
* │ ╲ Content │
* │ ╲ │
* │ │ │
* │ └────────────────────────┘
* ```
*
* @default 10
*/
public static arrowHeightOffset = 10;
/**
* A vertical offset of the balloon panel from the edge of the viewport if sticky.
* It helps in accessing toolbar buttons underneath the balloon panel.
*
* ```
* ┌───────────────────────────────────────────────────┐
* │ Target │
* │ │
* │ /── vertical offset │
* ┌─────────────────────────────V─────────────────────────┐
* │ Toolbar ┌─────────────┐ │
* ├────────────────────│ Balloon │────────────────────┤
* │ │ └─────────────┘ │ │
* │ │ │ │
* │ │ │ │
* │ │ │ │
* │ └───────────────────────────────────────────────────┘ │
* │ Viewport │
* └───────────────────────────────────────────────────────┘
* ```
*
* @default 20
*/
public static stickyVerticalOffset = 20;
/**
* Function used to calculate the optimal position for the balloon.
*/
private static _getOptimalPosition = getOptimalPosition;
/**
* A default set of positioning functions used by the balloon panel view
* when attaching using the {@link module:ui/panel/balloon/balloonpanelview~BalloonPanelView#attachTo} method.
*
* The available positioning functions are as follows:
*
* **North west**
*
* * `northWestArrowSouthWest`
*
* ```
* +-----------------+
* | Balloon |
* +-----------------+
* V
* [ Target ]
* ```
*
* * `northWestArrowSouthMiddleWest`
*
* ```
* +-----------------+
* | Balloon |
* +-----------------+
* V
* [ Target ]
* ```
*
* * `northWestArrowSouth`
*
* ```
* +-----------------+
* | Balloon |
* +-----------------+
* V
* [ Target ]
* ```
*
* * `northWestArrowSouthMiddleEast`
*
* ```
* +-----------------+
* | Balloon |
* +-----------------+
* V
* [ Target ]
* ```
*
* * `northWestArrowSouthEast`
*
* ```
* +-----------------+
* | Balloon |
* +-----------------+
* V
* [ Target ]
* ```
*
* **North**
*
* * `northArrowSouthWest`
*
* ```
* +-----------------+
* | Balloon |
* +-----------------+
* V
* [ Target ]
* ```
*
* * `northArrowSouthMiddleWest`
*
* ```
* +-----------------+
* | Balloon |
* +-----------------+
* V
* [ Target ]
* ```
* * `northArrowSouth`
*
* ```
* +-----------------+
* | Balloon |
* +-----------------+
* V
* [ Target ]
* ```
*
* * `northArrowSouthMiddleEast`
*
* ```
* +-----------------+
* | Balloon |
* +-----------------+
* V
* [ Target ]
* ```
*
* * `northArrowSouthEast`
*
* ```
* +-----------------+
* | Balloon |
* +-----------------+
* V
* [ Target ]
* ```
*
* **North east**
*
* * `northEastArrowSouthWest`
*
* ```
* +-----------------+
* | Balloon |
* +-----------------+
* V
* [ Target ]
* ```
*
* * `northEastArrowSouthMiddleWest`
*
* ```
* +-----------------+
* | Balloon |
* +-----------------+
* V
* [ Target ]
* ```
*
* * `northEastArrowSouth`
*
* ```
* +-----------------+
* | Balloon |
* +-----------------+
* V
* [ Target ]
* ```
*
* * `northEastArrowSouthMiddleEast`
*
* ```
* +-----------------+
* | Balloon |
* +-----------------+
* V
* [ Target ]
* ```
*
* * `northEastArrowSouthEast`
*
* ```
* +-----------------+
* | Balloon |
* +-----------------+
* V
* [ Target ]
* ```
*
* **South**
*
* * `southArrowNorthWest`
*
* ```
* [ Target ]
* ^
* +-----------------+
* | Balloon |
* +-----------------+
* ```
*
* * `southArrowNorthMiddleWest`
*
* ```
* [ Target ]
* ^
* +-----------------+
* | Balloon |
* +-----------------+
* ```
*
* * `southArrowNorth`
*
* ```
* [ Target ]
* ^
* +-----------------+
* | Balloon |
* +-----------------+
* ```
*
* * `southArrowNorthMiddleEast`
*
* ```
* [ Target ]
* ^
* +-----------------+
* | Balloon |
* +-----------------+
* ```
*
* * `southArrowNorthEast`
*
* ```
* [ Target ]
* ^
* +-----------------+
* | Balloon |
* +-----------------+
* ```
*
* **South west**
*
* * `southWestArrowNorthWest`
*
*
* ```
* [ Target ]
* ^
* +-----------------+
* | Balloon |
* +-----------------+
* ```
*
* * `southWestArrowNorthMiddleWest`
*
* ```
* [ Target ]
* ^
* +-----------------+
* | Balloon |
* +-----------------+
* ```
*
* * `southWestArrowNorth`
*
* ```
* [ Target ]
* ^
* +-----------------+
* | Balloon |
* +-----------------+
* ```
*
* * `southWestArrowNorthMiddleEast`
*
* ```
* [ Target ]
* ^
* +-----------------+
* | Balloon |
* +-----------------+
* ```
*
* * `southWestArrowNorthEast`
*
* ```
* [ Target ]
* ^
* +-----------------+
* | Balloon |
* +-----------------+
* ```
*
* **South east**
*
* * `southEastArrowNorthWest`
*
* ```
* [ Target ]
* ^
* +-----------------+
* | Balloon |
* +-----------------+
* ```
*
* * `southEastArrowNorthMiddleWest`
*
* ```
* [ Target ]
* ^
* +-----------------+
* | Balloon |
* +-----------------+
* ```
*
* * `southEastArrowNorth`
*
* ```
* [ Target ]
* ^
* +-----------------+
* | Balloon |
* +-----------------+
* ```
*
* * `southEastArrowNorthMiddleEast`
*
* ```
* [ Target ]
* ^
* +-----------------+
* | Balloon |
* +-----------------+
* ```
*
* * `southEastArrowNorthEast`
*
* ```
* [ Target ]
* ^
* +-----------------+
* | Balloon |
* +-----------------+
* ```
*
* **West**
*
* * `westArrowEast`
*
* ```
* +-----------------+
* | Balloon |>[ Target ]
* +-----------------+
* ```
*
* **East**
*
* * `eastArrowWest`
*
* ```
* +-----------------+
* [ Target ]<| Balloon |
* +-----------------+
* ```
*
* **Sticky**
*
* * `viewportStickyNorth`
*
* ```
* +---------------------------+
* | [ Target ] |
* | |
* +-----------------------------------+
* | | +-----------------+ | |
* | | | Balloon | | |
* | | +-----------------+ | |
* | | | |
* | | | |
* | | | |
* | | | |
* | +---------------------------+ |
* | Viewport |
* +-----------------------------------+
* ```
*
* See {@link module:ui/panel/balloon/balloonpanelview~BalloonPanelView#attachTo}.
*
* Positioning functions must be compatible with {@link module:utils/dom/position~Position}.
*
* Default positioning functions with customized offsets can be generated using
* {@link module:ui/panel/balloon/balloonpanelview~generatePositions}.
*
* The name that the position function returns will be reflected in the balloon panel's class that
* controls the placement of the "arrow". See {@link #position} to learn more.
*/
public static defaultPositions = generatePositions();
}
/**
* Returns the DOM element for given object or null, if there is none,
* e.g. when the passed object is a Rect instance or so.
*/
function getDomElement( object: any ): HTMLElement | null {
if ( isElement( object ) ) {
return object;
}
if ( isRange( object ) ) {
return object.commonAncestorContainer as any;
}
if ( typeof object == 'function' ) {
return getDomElement( object() );
}
return null;
}
/**
* Returns available {@link module:ui/panel/balloon/balloonpanelview~BalloonPanelView}
* {@link module:utils/dom/position~PositioningFunction positioning functions} adjusted by the specific offsets.
*
* @internal
* @param options Options to generate positions. If not specified, this helper will simply return
* {@link module:ui/panel/balloon/balloonpanelview~BalloonPanelView.defaultPositions}.
* @param options.sideOffset A custom side offset (in pixels) of each position. If
* not specified, {@link module:ui/panel/balloon/balloonpanelview~BalloonPanelView.arrowSideOffset the default value}
* will be used.
* @param options.heightOffset A custom height offset (in pixels) of each position. If
* not specified, {@link module:ui/panel/balloon/balloonpanelview~BalloonPanelView.arrowHeightOffset the default value}
* will be used.
* @param options.stickyVerticalOffset A custom offset (in pixels) of the `viewportStickyNorth` positioning function.
* If not specified, {@link module:ui/panel/balloon/balloonpanelview~BalloonPanelView.stickyVerticalOffset the default value}
* will be used.
* @param options.config Additional configuration of the balloon balloon panel view.
* Currently only {@link module:ui/panel/balloon/balloonpanelview~BalloonPanelView#withArrow} is supported. Learn more
* about {@link module:utils/dom/position~PositioningFunction positioning functions}.
*/
export function generatePositions( options: {
sideOffset?: number;
heightOffset?: number;
stickyVerticalOffset?: number;
config?: object;
} = {} ): Record<string, PositioningFunction> {
const {
sideOffset = BalloonPanelView.arrowSideOffset,
heightOffset = BalloonPanelView.arrowHeightOffset,
stickyVerticalOffset = BalloonPanelView.stickyVerticalOffset,
config
} = options;
return {
// ------- North west
northWestArrowSouthWest: ( targetRect, balloonRect ) => ( {
top: getNorthTop( targetRect, balloonRect ),
left: targetRect.left - sideOffset,
name: 'arrow_sw',
...( config && { config } )
} ),
northWestArrowSouthMiddleWest: ( targetRect, balloonRect ) => ( {
top: getNorthTop( targetRect, balloonRect ),
left: targetRect.left - ( balloonRect.width * .25 ) - sideOffset,
name: 'arrow_smw',
...( config && { config } )
} ),
northWestArrowSouth: ( targetRect, balloonRect ) => ( {
top: getNorthTop( targetRect, balloonRect ),
left: targetRect.left - balloonRect.width / 2,
name: 'arrow_s',
...( config && { config } )
} ),
northWestArrowSouthMiddleEast: ( targetRect, balloonRect ) => ( {
top: getNorthTop( targetRect, balloonRect ),
left: targetRect.left - ( balloonRect.width * .75 ) + sideOffset,
name: 'arrow_sme',
...( config && { config } )
} ),
northWestArrowSouthEast: ( targetRect, balloonRect ) => ( {
top: getNorthTop( targetRect, balloonRect ),
left: targetRect.left - balloonRect.width + sideOffset,
name: 'arrow_se',
...( config && { config } )
} ),
// ------- North
northArrowSouthWest: ( targetRect, balloonRect ) => ( {
top: getNorthTop( targetRect, balloonRect ),
left: targetRect.left + targetRect.width / 2 - sideOffset,
name: 'arrow_sw',
...( config && { config } )
} ),
northArrowSouthMiddleWest: ( targetRect, balloonRect ) => ( {
top: getNorthTop( targetRect, balloonRect ),
left: targetRect.left + targetRect.width / 2 - ( balloonRect.width * .25 ) - sideOffset,
name: 'arrow_smw',
...( config && { config } )
} ),
northArrowSouth: ( targetRect, balloonRect ) => ( {
top: getNorthTop( targetRect, balloonRect ),
left: targetRect.left + targetRect.width / 2 - balloonRect.width / 2,
name: 'arrow_s',
...( config && { config } )
} ),
northArrowSouthMiddleEast: ( targetRect, balloonRect ) => ( {
top: getNorthTop( targetRect, balloonRect ),
left: targetRect.left + targetRect.width / 2 - ( balloonRect.width * .75 ) + sideOffset,
name: 'arrow_sme',
...( config && { config } )
} ),
northArrowSouthEast: ( targetRect, balloonRect ) => ( {
top: getNorthTop( targetRect, balloonRect ),
left: targetRect.left + targetRect.width / 2 - balloonRect.width + sideOffset,
name: 'arrow_se',
...( config && { config } )
} ),
// ------- North east
northEastArrowSouthWest: ( targetRect, balloonRect ) => ( {
top: getNorthTop( targetRect, balloonRect ),
left: targetRect.right - sideOffset,
name: 'arrow_sw',
...( config && { config } )
} ),
northEastArrowSouthMiddleWest: ( targetRect, balloonRect ) => ( {
top: getNorthTop( targetRect, balloonRect ),
left: targetRect.right - ( balloonRect.width * .25 ) - sideOffset,
name: 'arrow_smw',
...( config && { config } )
} ),
northEastArrowSouth: ( targetRect, balloonRect ) => ( {
top: getNorthTop( targetRect, balloonRect ),