-
Notifications
You must be signed in to change notification settings - Fork 4.1k
/
Modal.js
374 lines (302 loc) · 9.74 KB
/
Modal.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
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
import cx from 'classnames'
import _ from 'lodash'
import PropTypes from 'prop-types'
import React from 'react'
import {
AutoControlledComponent as Component,
childrenUtils,
customPropTypes,
getElementType,
getUnhandledProps,
isBrowser,
makeDebugger,
META,
useKeyOnly,
} from '../../lib'
import Icon from '../../elements/Icon'
import Portal from '../../addons/Portal'
import ModalHeader from './ModalHeader'
import ModalContent from './ModalContent'
import ModalActions from './ModalActions'
import ModalDescription from './ModalDescription'
const debug = makeDebugger('modal')
/**
* A modal displays content that temporarily blocks interactions with the main view of a site.
* @see Confirm
* @see Portal
*/
class Modal extends Component {
static propTypes = {
/** An element type to render as (string or function). */
as: customPropTypes.as,
/** Shorthand for Modal.Actions. Typically an array of button shorthand. */
actions: customPropTypes.itemShorthand,
/** A modal can reduce its complexity */
basic: PropTypes.bool,
/** Primary content. */
children: PropTypes.node,
/** Additional classes. */
className: PropTypes.string,
/** Shorthand for the close icon. Closes the modal on click. */
closeIcon: PropTypes.oneOfType([
PropTypes.node,
PropTypes.object,
PropTypes.bool,
]),
/** Whether or not the Modal should close when the dimmer is clicked. */
closeOnDimmerClick: PropTypes.bool,
/** Whether or not the Modal should close when the document is clicked. */
closeOnDocumentClick: PropTypes.bool,
/** Simple text content for the Modal. */
content: customPropTypes.itemShorthand,
/** Initial value of open. */
defaultOpen: PropTypes.bool,
/** A Modal can appear in a dimmer. */
dimmer: PropTypes.oneOfType([
PropTypes.bool,
PropTypes.oneOf(['inverted', 'blurring']),
]),
/** Event pool namespace that is used to handle component events */
eventPool: PropTypes.string,
/** Modal displayed above the content in bold. */
header: customPropTypes.itemShorthand,
/** The node where the modal should mount. Defaults to document.body. */
mountNode: PropTypes.any,
/**
* Action onClick handler when using shorthand `actions`.
*
* @param {SyntheticEvent} event - React's original SyntheticEvent.
* @param {object} data - All props.
*/
onActionClick: PropTypes.func,
/**
* Called when a close event happens.
*
* @param {SyntheticEvent} event - React's original SyntheticEvent.
* @param {object} data - All props.
*/
onClose: PropTypes.func,
/**
* Called when the portal is mounted on the DOM.
*
* @param {null}
* @param {object} data - All props.
*/
onMount: PropTypes.func,
/**
* Called when an open event happens.
*
* @param {SyntheticEvent} event - React's original SyntheticEvent.
* @param {object} data - All props.
*/
onOpen: PropTypes.func,
/**
* Called when the portal is unmounted from the DOM.
*
* @param {null}
* @param {object} data - All props.
*/
onUnmount: PropTypes.func,
/** Controls whether or not the Modal is displayed. */
open: PropTypes.bool,
/** A modal can vary in size */
size: PropTypes.oneOf(['fullscreen', 'large', 'mini', 'small', 'tiny']),
/** Custom styles. */
style: PropTypes.object,
/**
* NOTE: Any unhandled props that are defined in Portal are passed-through
* to the wrapping Portal.
*/
}
static defaultProps = {
dimmer: true,
closeOnDimmerClick: true,
closeOnDocumentClick: false,
eventPool: 'Modal',
}
static autoControlledProps = [
'open',
]
static _meta = {
name: 'Modal',
type: META.TYPES.MODULE,
}
static Header = ModalHeader
static Content = ModalContent
static Description = ModalDescription
static Actions = ModalActions
componentWillUnmount() {
debug('componentWillUnmount()')
this.handlePortalUnmount()
}
// Do not access document when server side rendering
getMountNode = () => (isBrowser ? this.props.mountNode || document.body : null)
handleActionsOverrides = predefinedProps => ({
onActionClick: (e, actionProps) => {
_.invoke(predefinedProps, 'onActionClick', e, actionProps)
_.invoke(this.props, 'onActionClick', e, this.props)
this.handleClose(e)
},
})
handleClose = (e) => {
debug('close()')
const { onClose } = this.props
if (onClose) onClose(e, this.props)
this.trySetState({ open: false })
}
handleIconOverrides = predefinedProps => ({
onClick: (e) => {
_.invoke(predefinedProps, 'onClick', e)
this.handleClose(e)
},
})
handleOpen = (e) => {
debug('open()')
const { onOpen } = this.props
if (onOpen) onOpen(e, this.props)
this.trySetState({ open: true })
}
handlePortalMount = (e) => {
debug('handlePortalMount()')
const { dimmer } = this.props
const mountNode = this.getMountNode()
if (dimmer) {
debug('adding dimmer')
mountNode.classList.add('dimmable')
mountNode.classList.add('dimmed')
if (dimmer === 'blurring') {
debug('adding blurred dimmer')
mountNode.classList.add('blurring')
}
}
this.setPosition()
const { onMount } = this.props
if (onMount) onMount(e, this.props)
}
handlePortalUnmount = (e) => {
debug('handlePortalUnmount()')
// Always remove all dimmer classes.
// If the dimmer value changes while the modal is open, then removing its
// current value could leave cruft classes previously added.
const mountNode = this.getMountNode()
// Heads up, IE doesn't support second argument in remove()
mountNode.classList.remove('blurring')
mountNode.classList.remove('dimmable')
mountNode.classList.remove('dimmed')
mountNode.classList.remove('scrolling')
cancelAnimationFrame(this.animationRequestId)
const { onUnmount } = this.props
if (onUnmount) onUnmount(e, this.props)
}
handleRef = c => (this.ref = c)
setPosition = () => {
if (this.ref) {
const mountNode = this.getMountNode()
const { height } = this.ref.getBoundingClientRect()
const marginTop = -Math.round(height / 2)
const scrolling = height >= window.innerHeight
const newState = {}
if (this.state.marginTop !== marginTop) {
newState.marginTop = marginTop
}
if (this.state.scrolling !== scrolling) {
newState.scrolling = scrolling
if (scrolling) {
mountNode.classList.add('scrolling')
} else {
mountNode.classList.remove('scrolling')
}
}
if (Object.keys(newState).length > 0) this.setState(newState)
}
this.animationRequestId = requestAnimationFrame(this.setPosition)
}
renderContent = (rest) => {
const {
actions,
basic,
children,
className,
closeIcon,
content,
header,
size,
style,
} = this.props
const { marginTop, scrolling } = this.state
const classes = cx(
'ui',
size,
useKeyOnly(basic, 'basic'),
useKeyOnly(scrolling, 'scrolling'),
'modal transition visible active',
className,
)
const ElementType = getElementType(Modal, this.props)
const closeIconName = closeIcon === true ? 'close' : closeIcon
const closeIconJSX = Icon.create(closeIconName, { overrideProps: this.handleIconOverrides })
if (!childrenUtils.isNil(children)) {
return (
<ElementType {...rest} className={classes} style={{ marginTop, ...style }} ref={this.handleRef}>
{closeIconJSX}
{children}
</ElementType>
)
}
return (
<ElementType {...rest} className={classes} style={{ marginTop, ...style }} ref={this.handleRef}>
{closeIconJSX}
{ModalHeader.create(header)}
{ModalContent.create(content)}
{ModalActions.create(actions, { overrideProps: this.handleActionsOverrides })}
</ElementType>
)
}
render() {
const { open } = this.state
const { closeOnDimmerClick, closeOnDocumentClick, dimmer, eventPool } = this.props
const mountNode = this.getMountNode()
// Short circuit when server side rendering
if (!isBrowser) return null
const unhandled = getUnhandledProps(Modal, this.props)
const portalPropNames = Portal.handledProps
const rest = _.omit(unhandled, portalPropNames)
const portalProps = _.pick(unhandled, portalPropNames)
// wrap dimmer modals
const dimmerClasses = !dimmer
? null
: cx(
'ui',
dimmer === 'inverted' && 'inverted',
'page modals dimmer transition visible active',
)
// Heads up!
//
// The SUI CSS selector to prevent the modal itself from blurring requires an immediate .dimmer child:
// .blurring.dimmed.dimmable>:not(.dimmer) { ... }
//
// The .blurring.dimmed.dimmable is the body, so that all body content inside is blurred.
// We need the immediate child to be the dimmer to :not() blur the modal itself!
// Otherwise, the portal div is also blurred, blurring the modal.
//
// We cannot them wrap the modalJSX in an actual <Dimmer /> instead, we apply the dimmer classes to the <Portal />.
return (
<Portal
closeOnDocumentClick={closeOnDocumentClick}
closeOnRootNodeClick={closeOnDimmerClick}
{...portalProps}
className={dimmerClasses}
eventPool={eventPool}
mountNode={mountNode}
open={open}
onClose={this.handleClose}
onMount={this.handlePortalMount}
onOpen={this.handleOpen}
onUnmount={this.handlePortalUnmount}
>
{this.renderContent(rest)}
</Portal>
)
}
}
export default Modal