-
-
Notifications
You must be signed in to change notification settings - Fork 3.7k
/
minimapview.js
221 lines (192 loc) · 6.04 KB
/
minimapview.js
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
/**
* @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
*/
/**
* @module minimap/minimapview
*/
import { View } from 'ckeditor5/src/ui';
import { Rect } from 'ckeditor5/src/utils';
import MinimapIframeView from './minimapiframeview';
import MinimapPositionTrackerView from './minimappositiontrackerview';
/**
* The main view of the minimap. It renders the original content but scaled down with a tracker element
* visualizing the subset of the content visible to the user and allowing interactions (scrolling, dragging).
*
* @private
* @extends module:ui/view~View
*/
export default class MinimapView extends View {
/**
* Creates an instance of the minimap view.
*
* @param {module:utils/locale~Locale} locale
* @param {Object} options
* @param {HTMLElement} options.domRootClone
* @param {Array} options.pageStyles
* @param {Number} options.scaleRatio
* @param {Boolean} [options.useSimplePreview]
* @param {String} [options.extraClasses]
*/
constructor( { locale, scaleRatio, pageStyles, extraClasses, useSimplePreview, domRootClone } ) {
super( locale );
const bind = this.bindTemplate;
/**
* An instance of the tracker view displayed over the minimap.
*
* @protected
* @readonly
* @member {module:minimap/minimappositiontrackerview~MinimapPositionTrackerView}
*/
this._positionTrackerView = new MinimapPositionTrackerView( locale );
this._positionTrackerView.delegate( 'drag' ).to( this );
/**
* The scale ratio of the minimap relative to the original editing DOM root with the content.
*
* @protected
* @readonly
* @member {Number}
*/
this._scaleRatio = scaleRatio;
/**
* An instance of the iframe view that hosts the minimap.
*
* @protected
* @readonly
* @member {module:minimap/minimapiframeview~MinimapIframeView}
*/
this._minimapIframeView = new MinimapIframeView( locale, {
useSimplePreview,
pageStyles,
extraClasses,
scaleRatio,
domRootClone
} );
this.setTemplate( {
tag: 'div',
attributes: {
class: [
'ck',
'ck-minimap'
]
},
children: [
this._positionTrackerView
],
on: {
click: bind.to( this._handleMinimapClick.bind( this ) ),
wheel: bind.to( this._handleMinimapMouseWheel.bind( this ) )
}
} );
/**
* Fired when the minimap view is clicked.
*
* @event click
* @param {Number} progress The number between 0 and 1 representing a place in the minimap (its height) that was clicked.
*/
/**
* Fired when the position tracker is dragged or the minimap is scrolled via mouse wheel.
*
* @event drag
* @param {Number} movementY The vertical movement of the minimap as a result of dragging or scrolling.
*/
}
/**
* @inheritDoc
*/
destroy() {
this._minimapIframeView.destroy();
super.destroy();
}
/**
* Returns the DOM {@link module:utils/dom/rect~Rect} height of the minimap.
*
* @readonly
* @member {Number}
*/
get height() {
return new Rect( this.element ).height;
}
/**
* Returns the number of available space (pixels) the position tracker (visible subset of the content) can use to scroll vertically.
*
* @readonly
* @member {Number}
*/
get scrollHeight() {
return Math.max( 0, Math.min( this.height, this._minimapIframeView.height ) - this._positionTrackerView.height );
}
/**
* @inheritDoc
*/
render() {
super.render();
this._minimapIframeView.render();
this.element.appendChild( this._minimapIframeView.element );
}
/**
* Sets the new height of the minimap (in px) to respond to the changes in the original editing DOM root.
*
* **Note**:The provided value should be the `offsetHeight` of the original editing DOM root.
*
* @param {Number} newHeight
*/
setContentHeight( newHeight ) {
this._minimapIframeView.setHeight( newHeight * this._scaleRatio );
}
/**
* Sets the minimap scroll progress.
*
* The minimap scroll progress is linked to the original editing DOM root and its scrollable container (ancestor).
* Changing the progress will alter the vertical position of the minimap (and its position tracker) and give the user an accurate
* overview of the visible document.
*
* **Note**: The value should be between 0 and 1. 0 when the DOM root has not been scrolled, 1 when the
* scrolling has reached the end.
*
* @param {Number} newScrollProgress
*/
setScrollProgress( newScrollProgress ) {
const iframeView = this._minimapIframeView;
const positionTrackerView = this._positionTrackerView;
// The scrolling should end when the bottom edge of the iframe touches the bottom edge of the minimap.
if ( iframeView.height < this.height ) {
iframeView.setTopOffset( 0 );
positionTrackerView.setTopOffset( ( iframeView.height - positionTrackerView.height ) * newScrollProgress );
} else {
const totalOffset = iframeView.height - this.height;
iframeView.setTopOffset( -totalOffset * newScrollProgress );
positionTrackerView.setTopOffset( ( this.height - positionTrackerView.height ) * newScrollProgress );
}
positionTrackerView.setScrollProgress( Math.round( newScrollProgress * 100 ) );
}
/**
* Sets the new height of the tracker (in px) to visualize the subset of the content visible to the user.
*
* @param {Number} trackerHeight
*/
setPositionTrackerHeight( trackerHeight ) {
this._positionTrackerView.setHeight( trackerHeight * this._scaleRatio );
}
/**
* @private
* @param {Event} data DOM event data
*/
_handleMinimapClick( data ) {
const positionTrackerView = this._positionTrackerView;
if ( data.target === positionTrackerView.element ) {
return;
}
const trackerViewRect = new Rect( positionTrackerView.element );
const diff = data.clientY - trackerViewRect.top - trackerViewRect.height / 2;
const percentage = diff / this._minimapIframeView.height;
this.fire( 'click', percentage );
}
/**
* @private
* @param {Event} data DOM event data
*/
_handleMinimapMouseWheel( data ) {
this.fire( 'drag', data.deltaY * this._scaleRatio );
}
}