forked from souly1/ng-walkthrough
-
Notifications
You must be signed in to change notification settings - Fork 0
/
ng-walkthrough.js
286 lines (260 loc) · 15 KB
/
ng-walkthrough.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
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
var scripts = document.getElementsByTagName("script");
var currentScriptPath = scripts[scripts.length-1].src;
var templateUrl = currentScriptPath.replace(new RegExp("ng-walkthrough.js.*"), 'ng-walkthrough.html');
var iconsUrl = currentScriptPath.replace(new RegExp("ng-walkthrough.js.*"), 'icons/');
angular.module('ng-walkthrough', [])
.directive("walkthrough", function($log, $timeout) {
var DOM_WALKTHROUGH_TRANSPARENCY_TEXT_CLASS = ".walkthrough-text";
var DOM_WALKTHROUGH_TIP_TEXT_CLASS = ".walkthrough-tip-text-box";
var DOM_WALKTHROUGH_HOLE_CLASS = ".walkthrough-hole";
var DOM_WALKTHROUGH_TRANSPARENCY_ICON_CLASS = ".walkthrough-icon";
var DOM_WALKTHROUGH_TIP_ICON_CLASS = ".walkthrough-tip-icon-text-box";
var DOM_WALKTHROUGH_ARROW_CLASS = ".walkthrough-arrow";
var DOM_WALKTHROUGH_BACKGROUND_CLASS = "walkthrough-background";
var DOM_WALKTHROUGH_DONE_BUTTON_CLASS = "walkthrough-done-button";
var BUTTON_CAPTION_DONE = "Got it!";
var PADDING_HOLE = 5;
var PADDING_ARROW_START = 5;
var gestureIcons = ["single_tap", "double_tap", "swipe_down", "swipe_left", "swipe_right", "swipe_up"];
return {
restrict: 'E',
transclude: true,
scope: {
walkthroughType: '@',
isActive: '=',
icon: '@',
focusElementId: '@',
mainCaption: '@',
captionOnBottom: '=',
isRound: '=',
useButton: '=',
iconPaddingLeft: '@',
iconPaddingTop: '@',
tipLocation: '@',
tipIconLocation: '@',
tipColor: '@',
onWalkthroughShow: '&',
onWalkthroughHide: '&'
},
link: function (scope, element, attrs, ctrl, $transclude) {
var getIcon = function(icon){
var retval = null;
switch (icon){
case ("single_tap"):
retval = iconsUrl + "Single_Tap.png";
break;
case ("double_tap"):
retval = iconsUrl + "Double_Tap.png";
break;
case ("swipe_down"):
retval = iconsUrl + "Swipe_Down.png";
break;
case ("swipe_left"):
retval = iconsUrl + "Swipe_Left.png";
break;
case ("swipe_right"):
retval = iconsUrl + "Swipe_Right.png";
break;
case ("swipe_up"):
retval = iconsUrl + "Swipe_Up.png";
break;
case ("arrow"):
retval = ""; //Return nothing, using other dom element for arrow
break;
}
if (retval == null && icon && icon.length > 0){
retval = icon;
}
return retval;
};
var init = function(scope){
scope.clickEvent = 'click';
//noinspection JSUnresolvedVariable
if (typeof ionic !== 'undefined') { //Might need to comment this out if fails build on angular only machine
scope.clickEvent = 'touch';
}
//Event to close the walkthrough
scope.closeWalkthrough = function(){
scope.isActive = false;
scope.onWalkthroughHide();
};
//Event used when background clicked, if we use button then do nothing
scope.onCloseClicked = function($event) {
//if Angular only
if (scope.clickEvent == 'click') {
if (($event.currentTarget.className.indexOf(DOM_WALKTHROUGH_BACKGROUND_CLASS) > -1 && !scope.useButton) ||
($event.currentTarget.className.indexOf(DOM_WALKTHROUGH_DONE_BUTTON_CLASS) > -1 && scope.useButton)) {
scope.closeWalkthrough();
$event.stopPropagation();
}
}
};
scope.onCloseTouched = function($event) {
if (scope.clickEvent == 'touch') {
if (($event.currentTarget.className.indexOf(DOM_WALKTHROUGH_BACKGROUND_CLASS) > -1 && !scope.useButton) ||
($event.currentTarget.className.indexOf(DOM_WALKTHROUGH_DONE_BUTTON_CLASS) > -1 && scope.useButton)) {
scope.closeWalkthrough();
$event.stopPropagation();
}
}
};
scope.closeIcon = iconsUrl + "Hotspot-close.png";
scope.walkthroughIcon = getIcon(scope.icon);
scope.buttonCaption = BUTTON_CAPTION_DONE;
};
//Sets the walkthrough focus hole on given params with padding
var setFocus = function(left, top, width, height){
var holeDimensions =
"left:" + (left - PADDING_HOLE) + "px;" +
"top:" + (top - PADDING_HOLE) + "px;" +
"width:" + (width + (2 * PADDING_HOLE)) + "px;" +
"height:" + (height + (2 * PADDING_HOLE)) + "px;";
scope.walkthroughHoleElement.attr('style', holeDimensions);
};
var moveTextToBottom = function(newTop){
var textLocation =
"top:" + newTop + "px;" +
"margin-top: 10px;";
scope.walkthroughTextElement.attr('style', textLocation);
};
//Check if given icon covers text
var isItemOnText = function(iconLeft, iconTop, iconRight, iconBottom) {
var retval = false;
var textLeft = scope.walkthroughTextElement[0].offsetLeft;
var textRight = scope.walkthroughTextElement[0].offsetLeft + scope.walkthroughTextElement[0].offsetWidth;
var textTop = scope.walkthroughTextElement[0].offsetTop;
var textBottom = scope.walkthroughTextElement[0].offsetTop + scope.walkthroughTextElement[0].offsetHeight;
if (!(textRight < iconLeft ||
textLeft > iconRight ||
textBottom < iconTop ||
textTop > iconBottom)) {
retval = true;
}
return retval;
};
//Sets the icon displayed according to directive argument
var setIconAndText = function(iconLeft, iconTop, paddingLeft, paddingTop){
var iconHeight = scope.walkthroughIconElement[0].offsetHeight;
var iconWidth = scope.walkthroughIconElement[0].offsetWidth;
var iconLeftWithPadding = iconLeft + paddingLeft;
var iconTopWithPadding = iconTop + paddingTop;
var iconRight = iconLeftWithPadding + iconWidth;
var iconBottom = iconTopWithPadding + iconHeight;
//Check if text overlaps icon, if does, move it to bottom
if (scope.captionOnBottom || isItemOnText(iconLeftWithPadding, iconTopWithPadding, iconRight, iconBottom)){
moveTextToBottom(iconBottom);
}
var iconLocation =
"position: absolute;" +
"left:" + iconLeftWithPadding + "px;" +
"top:" + iconTopWithPadding + "px;" +
"margin-top:-" + iconHeight/6 + "px;" +
"margin-left:-" + iconWidth/4 + "px;";
scope.walkthroughIconElement.attr('style', iconLocation);
};
var setArrowAndText = function(pointSubjectLeft, pointSubjectTop, pointSubjectWidth, pointSubjectHeight, paddingLeft){
var startLeft = scope.walkthroughTextElement[0].offsetLeft + scope.walkthroughTextElement[0].offsetWidth /2;
var startTop = scope.walkthroughTextElement[0].offsetTop + scope.walkthroughTextElement[0].offsetHeight + PADDING_ARROW_START;
var endTop = 0;
var endLeft = 0;
if (startLeft > pointSubjectLeft){//If hole left to text set arrow to point to middle right
endLeft = pointSubjectLeft + paddingLeft + pointSubjectWidth;
endTop = pointSubjectTop + (pointSubjectHeight/2);
} else if (startLeft < pointSubjectLeft){//If hole right to text set arrow to point to middle left
endLeft = pointSubjectLeft - paddingLeft;
endTop = pointSubjectTop + (pointSubjectHeight/2);
}
//Check if text overlaps icon, if does, move it to bottom
if (scope.captionOnBottom || isItemOnText(startLeft, startTop, endLeft, endTop)){
moveTextToBottom(startTop);
}
var arrowSvgDom =
'<svg width="100%" height="100%">' +
'<defs>' +
'<marker id="arrow" markerWidth="13" markerHeight="13" refx="2" refy="6" orient="auto">' +
'<path d="M2,1 L2,10 L10,6 L2,2" style="fill:#fff;" />' +
'</marker>' +
'</defs>' +
'<path d="M' + startLeft + ',' + startTop + ' Q' + startLeft + ',' + endTop + ' ' + endLeft + ',' + endTop + '"' +
'style="stroke:#fff; stroke-width: 2px; fill: none;' +
'marker-end: url(#arrow);"/>' +
'/>' +
'</svg>';
scope.walkthroughArrowElement.append(arrowSvgDom);
};
var setTipIconPadding = function(iconPaddingLeft, iconPaddingTop){
var iconLocation = "";
if (iconPaddingTop){
iconLocation += "margin-top:" + iconPaddingTop + "px;";
}
if (iconPaddingLeft){
iconLocation += "right:" + iconPaddingLeft + "%;";
}
scope.walkthroughIconElement.attr('style', iconLocation);
};
//Attempts to highlight the given element ID and set Icon to it if exists, if not use default - right under text
var setElementLocations = function(walkthroughIconWanted, focusElementId, iconPaddingLeft, iconPaddingTop){
var focusElement = document.querySelector('#' + focusElementId);
var angularElement = angular.element(focusElement);
if (angularElement.length > 0) {
var width = angularElement[0].offsetWidth;
var height = angularElement[0].offsetHeight;
var left = angularElement[0].offsetLeft;
var top = angularElement[0].offsetTop;
var parent = angularElement[0].offsetParent;
while (parent) {
left = left + parent.offsetLeft;
top = top + parent.offsetTop;
parent = parent.offsetParent;
}
setFocus(left, top, width, height);
var paddingLeft = parseFloat(iconPaddingLeft);
var paddingTop = parseFloat(iconPaddingTop);
if (!paddingLeft) { paddingLeft = 0;}
if (!paddingTop) { paddingTop = 0;}
//If Gesture icon given bind it to hole as well
if (walkthroughIconWanted && walkthroughIconWanted != "arrow"){
setIconAndText(left + width/2, top + height/2, paddingLeft, paddingTop);
}
if (walkthroughIconWanted == "arrow"){
setArrowAndText(left, top + paddingTop, width, height, paddingLeft);
}
} else {
if (focusElementId) {
$log.info('Unable to find element requested to be focused: #' + focusElementId);
} else{
//if tip mode with icon that we want to set padding to, set it
if (scope.walkthroughType== "tip" &&
walkthroughIconWanted && walkthroughIconWanted.length > 0 &&
(iconPaddingLeft || iconPaddingTop)){
setTipIconPadding(iconPaddingLeft, iconPaddingTop);
}
}
}
};
scope.walkthroughHoleElement = angular.element(element[0].querySelector(DOM_WALKTHROUGH_HOLE_CLASS));
var textClass = (scope.walkthroughType== "tip")? DOM_WALKTHROUGH_TIP_TEXT_CLASS: DOM_WALKTHROUGH_TRANSPARENCY_TEXT_CLASS;
scope.walkthroughTextElement = angular.element(element[0].querySelector(textClass));
var iconClass = (scope.walkthroughType== "tip")? DOM_WALKTHROUGH_TIP_ICON_CLASS: DOM_WALKTHROUGH_TRANSPARENCY_ICON_CLASS;
scope.walkthroughIconElement = angular.element(element[0].querySelector(iconClass));
scope.walkthroughArrowElement = angular.element(element[0].querySelector(DOM_WALKTHROUGH_ARROW_CLASS));
$transclude(function(clone){
init(scope);
var transcludeContent = clone.text().trim();
if (!(transcludeContent.length == 0 && clone.length <= 1)) { //Transcluding
scope.hasTransclude = true;
}
});
scope.$watch('isActive', function(newValue){
if(newValue){
if (!scope.hasTransclude){
//Must timeout to make sure we have final correct coordinates after screen totally load
$timeout(function() {setElementLocations(scope.icon, attrs.focusElementId, scope.iconPaddingLeft, scope.iconPaddingTop)},0);
}
scope.onWalkthroughShow();
}
});
},
templateUrl: templateUrl
};
});