-
-
Notifications
You must be signed in to change notification settings - Fork 3.4k
/
QTooltip.js
300 lines (245 loc) · 8.41 KB
/
QTooltip.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
287
288
289
290
291
292
293
294
295
296
297
298
299
300
import { h, ref, computed, watch, onBeforeUnmount, Transition, getCurrentInstance } from 'vue'
import useAnchor, { useAnchorStaticProps } from '../../composables/private.use-anchor/use-anchor.js'
import useScrollTarget from '../../composables/private.use-scroll-target/use-scroll-target.js'
import useModelToggle, { useModelToggleProps, useModelToggleEmits } from '../../composables/private.use-model-toggle/use-model-toggle.js'
import usePortal from '../../composables/private.use-portal/use-portal.js'
import useTransition, { useTransitionProps } from '../../composables/private.use-transition/use-transition.js'
import useTick from '../../composables/use-tick/use-tick.js'
import useTimeout from '../../composables/use-timeout/use-timeout.js'
import { createComponent } from '../../utils/private.create/create.js'
import { getScrollTarget } from '../../utils/scroll/scroll.js'
import { stopAndPrevent, addEvt, cleanEvt } from '../../utils/event/event.js'
import { clearSelection } from '../../utils/private.selection/selection.js'
import { hSlot } from '../../utils/private.render/render.js'
import { addClickOutside, removeClickOutside } from '../../utils/private.click-outside/click-outside.js'
import {
validatePosition, validateOffset, setPosition, parsePosition
} from '../../utils/private.position-engine/position-engine.js'
export default createComponent({
name: 'QTooltip',
inheritAttrs: false,
props: {
...useAnchorStaticProps,
...useModelToggleProps,
...useTransitionProps,
maxHeight: {
type: String,
default: null
},
maxWidth: {
type: String,
default: null
},
transitionShow: {
default: 'jump-down'
},
transitionHide: {
default: 'jump-up'
},
anchor: {
type: String,
default: 'bottom middle',
validator: validatePosition
},
self: {
type: String,
default: 'top middle',
validator: validatePosition
},
offset: {
type: Array,
default: () => [ 14, 14 ],
validator: validateOffset
},
scrollTarget: {
default: void 0
},
delay: {
type: Number,
default: 0
},
hideDelay: {
type: Number,
default: 0
},
persistent: Boolean
},
emits: [
...useModelToggleEmits
],
setup (props, { slots, emit, attrs }) {
let unwatchPosition, observer
const vm = getCurrentInstance()
const { proxy: { $q } } = vm
const innerRef = ref(null)
const showing = ref(false)
const anchorOrigin = computed(() => parsePosition(props.anchor, $q.lang.rtl))
const selfOrigin = computed(() => parsePosition(props.self, $q.lang.rtl))
const hideOnRouteChange = computed(() => props.persistent !== true)
const { registerTick, removeTick } = useTick()
const { registerTimeout } = useTimeout()
const { transitionProps, transitionStyle } = useTransition(props)
const { localScrollTarget, changeScrollEvent, unconfigureScrollTarget } = useScrollTarget(props, configureScrollTarget)
const { anchorEl, canShow, anchorEvents } = useAnchor({ showing, configureAnchorEl })
const { show, hide } = useModelToggle({
showing, canShow, handleShow, handleHide,
hideOnRouteChange,
processOnMount: true
})
Object.assign(anchorEvents, { delayShow, delayHide })
const { showPortal, hidePortal, renderPortal } = usePortal(vm, innerRef, renderPortalContent, 'tooltip')
// if we're on mobile, let's improve the experience
// by closing it when user taps outside of it
if ($q.platform.is.mobile === true) {
const clickOutsideProps = {
anchorEl,
innerRef,
onClickOutside (e) {
hide(e)
// prevent click if it's on a dialog backdrop
if (e.target.classList.contains('q-dialog__backdrop')) {
stopAndPrevent(e)
}
return true
}
}
const hasClickOutside = computed(() =>
// it doesn't has external model
// (null is the default value)
props.modelValue === null
// and it's not persistent
&& props.persistent !== true
&& showing.value === true
)
watch(hasClickOutside, val => {
const fn = val === true ? addClickOutside : removeClickOutside
fn(clickOutsideProps)
})
onBeforeUnmount(() => {
removeClickOutside(clickOutsideProps)
})
}
function handleShow (evt) {
showPortal()
// should removeTick() if this gets removed
registerTick(() => {
observer = new MutationObserver(() => updatePosition())
observer.observe(innerRef.value, { attributes: false, childList: true, characterData: true, subtree: true })
updatePosition()
configureScrollTarget()
})
if (unwatchPosition === void 0) {
unwatchPosition = watch(
() => $q.screen.width + '|' + $q.screen.height + '|' + props.self + '|' + props.anchor + '|' + $q.lang.rtl,
updatePosition
)
}
// should removeTimeout() if this gets removed
registerTimeout(() => {
showPortal(true) // done showing portal
emit('show', evt)
}, props.transitionDuration)
}
function handleHide (evt) {
removeTick()
hidePortal()
anchorCleanup()
// should removeTimeout() if this gets removed
registerTimeout(() => {
hidePortal(true) // done hiding, now destroy
emit('hide', evt)
}, props.transitionDuration)
}
function anchorCleanup () {
if (observer !== void 0) {
observer.disconnect()
observer = void 0
}
if (unwatchPosition !== void 0) {
unwatchPosition()
unwatchPosition = void 0
}
unconfigureScrollTarget()
cleanEvt(anchorEvents, 'tooltipTemp')
}
function updatePosition () {
setPosition({
targetEl: innerRef.value,
offset: props.offset,
anchorEl: anchorEl.value,
anchorOrigin: anchorOrigin.value,
selfOrigin: selfOrigin.value,
maxHeight: props.maxHeight,
maxWidth: props.maxWidth
})
}
function delayShow (evt) {
if ($q.platform.is.mobile === true) {
clearSelection()
document.body.classList.add('non-selectable')
const target = anchorEl.value
const evts = [ 'touchmove', 'touchcancel', 'touchend', 'click' ]
.map(e => ([ target, e, 'delayHide', 'passiveCapture' ]))
addEvt(anchorEvents, 'tooltipTemp', evts)
}
registerTimeout(() => { show(evt) }, props.delay)
}
function delayHide (evt) {
if ($q.platform.is.mobile === true) {
cleanEvt(anchorEvents, 'tooltipTemp')
clearSelection()
// delay needed otherwise selection still occurs
setTimeout(() => {
document.body.classList.remove('non-selectable')
}, 10)
}
// should removeTimeout() if this gets removed
registerTimeout(() => { hide(evt) }, props.hideDelay)
}
function configureAnchorEl () {
if (props.noParentEvent === true || anchorEl.value === null) return
const evts = $q.platform.is.mobile === true
? [
[ anchorEl.value, 'touchstart', 'delayShow', 'passive' ]
]
: [
[ anchorEl.value, 'mouseenter', 'delayShow', 'passive' ],
[ anchorEl.value, 'mouseleave', 'delayHide', 'passive' ]
]
addEvt(anchorEvents, 'anchor', evts)
}
function configureScrollTarget () {
if (anchorEl.value !== null || props.scrollTarget !== void 0) {
localScrollTarget.value = getScrollTarget(anchorEl.value, props.scrollTarget)
const fn = props.noParentEvent === true
? updatePosition
: hide
changeScrollEvent(localScrollTarget.value, fn)
}
}
function getTooltipContent () {
return showing.value === true
? h('div', {
...attrs,
ref: innerRef,
class: [
'q-tooltip q-tooltip--style q-position-engine no-pointer-events',
attrs.class
],
style: [
attrs.style,
transitionStyle.value
],
role: 'tooltip'
}, hSlot(slots.default))
: null
}
function renderPortalContent () {
return h(Transition, transitionProps.value, getTooltipContent)
}
onBeforeUnmount(anchorCleanup)
// expose public methods
Object.assign(vm.proxy, { updatePosition })
return renderPortal
}
})