-
Notifications
You must be signed in to change notification settings - Fork 474
/
base.js
258 lines (222 loc) · 5.03 KB
/
base.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
/* global _, $ */
/**
* WordPress dependencies
*/
import { focus } from '@wordpress/dom';
/**
* Internal dependencies
*/
import { getChosenVars } from 'utils/chosen.js';
// Set noconflict when using Lodash (@wordpress packages) and Underscores.
// @todo Find a better place to set this up. Webpack?
window.lodash = _.noConflict();
/**
* Base
*
* Supplies additional functionality and helpers beyond
* what is provided by `wp.Backbone.View`.
*
* - Maintains focus and caret positioning on rendering.
* - Extends events via `addEvents()`.
*
* @since 3.0
*
* @class Base
* @augments wp.Backbone.View
*/
export const Base = wp.Backbone.View.extend( {
/**
* Defines base events to help maintain focus and caret position.
*
* @since 3.0
*/
events: {
'keydown input': 'handleTabBehavior',
'keydown textarea': 'handleTabBehavior',
'focus input': 'onFocus',
'focus textarea': 'onFocus',
'focus select': 'onFocus',
'change input': 'onChange',
'change textarea': 'onChange',
'change select': 'onChange',
},
/**
* Sets up additional properties.
*
* @since 3.0
*/
preinitialize() {
this.focusedEl = null;
this.focusedElCaretPos = 0;
wp.Backbone.View.prototype.preinitialize.apply( this, arguments );
},
/**
* Merges additional events with existing events.
*
* @since 3.0
*
* @param {Object} events Hash of events to add.
*/
addEvents( events ) {
this.delegateEvents( {
...this.events,
...events,
} );
},
/**
* Moves the focus when dealing with tabbing.
*
* @since 3.0
*
* @param {Object} e Keydown event.
*/
handleTabBehavior( e ) {
const { keyCode, shiftKey, target } = e;
// 9 = TAB
if ( 9 !== keyCode ) {
return;
}
const tabbables = focus.tabbable.find( this.el );
if ( ! tabbables.length ) {
return;
}
const firstTabbable = tabbables[ 0 ];
const lastTabbable = tabbables[ tabbables.length - 1 ];
let toFocus;
if ( shiftKey && target === firstTabbable ) {
toFocus = lastTabbable;
} else if ( ! shiftKey && target === lastTabbable ) {
toFocus = firstTabbable;
} else if ( shiftKey ) {
toFocus = focus.tabbable.findPrevious( target );
} else {
toFocus = focus.tabbable.findNext( target );
}
if ( 'undefined' !== typeof toFocus ) {
this.focusedEl = toFocus;
this.focusedElCartetPos = toFocus.value.length;
} else {
this.focusedEl = null;
this.focusedElCartetPos = 0;
}
},
/**
* Tracks the current element when focusing.
*
* @since 3.0
*
* @param {Object} e Change event.
*/
onFocus( e ) {
this.focusedEl = e.target;
},
/**
* Tracks the current cursor position when editing.
*
* @since 3.0
*
* @param {Object} e Change event.
*/
onChange( e ) {
const { target, keyCode } = e;
// 9 = TAB
if ( undefined !== typeof keyCode && 9 === keyCode ) {
return;
}
// Attempt to find the caret position.
if ( ! target.selectionStart ) {
return;
}
try {
this.focusedElCaretPos = target.selectionStart;
} catch ( error ) {
this.focusedElCaretPos = target.value.length;
}
},
/**
* Prepares data to be used in `render` method.
*
* @since 3.0
*
* @see wp.Backbone.View
* @see https://github.com/WordPress/WordPress/blob/master/wp-includes/js/wp-backbone.js
*
* @return {Object} The data for this view.
*/
prepare() {
return this.model
? {
...this.model.toJSON(),
state: this.model.get( 'state' ).toJSON(),
}
: {};
},
/**
* Adds additional handling after initial render.
*
* @since 3.0
*/
render() {
wp.Backbone.View.prototype.render.apply( this, arguments );
this.initializeSelects();
this.setFocus();
return this;
},
/**
* Reinitializes special <select> fields.
*
* @since 3.0
*/
initializeSelects() {
const selects = this.el.querySelectorAll( '.edd-select-chosen' );
// Reinialize Chosen.js
_.each( selects, ( el ) => {
$( el ).chosen( {
...getChosenVars( $( el ) ),
width: '100%',
} );
} );
},
/**
* Sets the focus and caret position.
*
* @since 3.0
*/
setFocus() {
const { el, focusedEl, focusedElCaretPos } = this;
// Do nothing extra if nothing is focused.
if ( null === focusedEl || 'undefined' === typeof focusedEl ) {
return;
}
// Convert full element in to a usable selector.
// We can't search for the actual HTMLElement because
// the DOM has since changed.
let selector = null;
if ( '' !== focusedEl.id ) {
selector = `#${ focusedEl.id }`;
} else if ( '' !== focusedEl.name ) {
selector = `[name="${ focusedEl.name }"]`;
} else if ( focusedEl.classList.length > 0 ) {
selector = `.${ [ ...focusedEl.classList ].join( '.' ) }`;
}
// Do nothing if we can't generate a selector.
if ( null === selector ) {
return;
}
// Focus element.
const elToFocus = el.querySelector( selector );
if ( ! elToFocus ) {
return;
}
elToFocus.focus();
// Attempt to set the caret position.
try {
if ( elToFocus.setSelectionRange ) {
elToFocus.setSelectionRange(
focusedElCaretPos,
focusedElCaretPos
);
}
} catch ( error ) {}
},
} );