All files / components/Dialog Dialog.tsx

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
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
import _ from 'lodash';
import React from 'react';
import PropTypes from 'react-peek/prop-types';
import Overlay, { IOverlayProps } from '../Overlay/Overlay';
import { lucidClassNames } from '../../util/style-helpers';
import { StandardProps, getFirst, omitProps } from '../../util/component-types';
import Button, { IButtonProps } from '../Button/Button';
import CloseIcon from '../Icon/CloseIcon/CloseIcon';
 
const cx = lucidClassNames.bind('&-Dialog');
 
const { node, oneOf, bool, func } = PropTypes;
 
enum EnumSize {
	small = 'small',
	medium = 'medium',
	large = 'large',
}
type Size = keyof typeof EnumSize;
 
interface IDialogHeaderProps extends StandardProps {
	description?: string;
}
const DialogHeader = (_props: IDialogHeaderProps): null => null;
DialogHeader.displayName = 'Dialog.Header';
DialogHeader.peek = {
	description: `
		Renders a \`<div>\`.
	`,
};
DialogHeader.propName = 'Header';
 
interface IDialogFooterProps extends StandardProps {
	description?: string;
}
const DialogFooter = (_props: IDialogFooterProps): null => null;
DialogFooter.displayName = 'Dialog.Footer';
DialogFooter.peek = {
	description: `
		Renders a \`<footer>\`.
	`,
};
DialogFooter.propName = 'Footer';
 
const defaultProps = {
	...Overlay.defaultProps,
	size: EnumSize.medium,
	isComplex: false,
	hasGutters: true,
};
 
export interface IDialogProps extends IOverlayProps {
	/** Size variations that only affect the width of the dialog. All the sizes
		will grow in height until they get too big, at which point they will
		scroll inside. */
	size: Size;
 
	/** If this is truthy (if a function is provided). the close button will show.
		The function that is called when the close button is triggered. */
	handleClose?: ({
		event,
		props,
	}: {
		event: React.MouseEvent;
		props: IButtonProps;
	}) => void;
 
	/** Provides a more segregated design to organize more content in the Dialog.
	 * @default = false */
	isComplex: boolean;
 
	/** A true or false value that dictates whether or not the Body has padding. */
	hasGutters: boolean;
 
	/** *Child Element* - Header contents. Only one \`Header\` is used. */
	Header?: string | React.ReactNode & { props: IDialogHeaderProps };
 
	/** *Child Element* - Footer contents. Only one \`Footer\` is used. */
	Footer?: string | React.ReactNode & { props: IDialogFooterProps };
}
 
export const Dialog = (props: IDialogProps): React.ReactElement => {
	const {
		className,
		size,
		handleClose,
		hasGutters,
		isShown,
		isComplex,
		...passThroughs
	} = props;
 
	const headerChildProp = _.get(getFirst(props, Dialog.Header), 'props', {});
	const footerChildProp = _.get(getFirst(props, Dialog.Footer), 'props', null);
 
	return (
		<Overlay
			{...omitProps(passThroughs, undefined, _.keys(Dialog.propTypes), false)}
			{..._.pick<any>(passThroughs, _.keys(Overlay.propTypes))}
			isShown={isShown}
			className={cx('&', className)}
		>
			<div
				className={cx('&-window', {
					'&-window-is-small': size === EnumSize.small,
					'&-window-is-medium': size === EnumSize.medium,
					'&-window-is-large': size === EnumSize.large,
					'&-is-complex': isComplex,
					'&-no-footer': !footerChildProp,
				})}
			>
				<header className={cx('&-header')}>
					{headerChildProp.children}
 
					{handleClose && (
						<Button
							kind='invisible'
							hasOnlyIcon
							className={cx('&-close-button')}
							onClick={handleClose}
						>
							<CloseIcon />
						</Button>
					)}
				</header>
 
				<section
					className={cx('&-body', hasGutters ? '' : '&-body-no-gutters')}
				>
					{props.children}
				</section>
 
				{footerChildProp && (
					<footer {...footerChildProp} className={cx('&-footer')} />
				)}
			</div>
		</Overlay>
	);
};
 
Dialog.displayName = 'Dialog';
 
Dialog.defaultProps = defaultProps;
 
Dialog.peek = {
	description: `
		Dialog is used to pop open a window so the user doesn't lose the
		context of the page behind it. Extra props are spread through to the
		underlying \`Overlay\`
	`,
	categories: ['layout'],
	extend: 'Overlay',
	madeFrom: ['Portal', 'Overlay'],
};
 
Dialog.propTypes = {
	...Overlay.propTypes,
 
	size: oneOf(['small', 'medium', 'large'])`
		Size variations that only affect the width of the dialog. All the sizes
		will grow in height until they get too big, at which point they will
		scroll inside.
	`,
 
	handleClose: func`
		If this is truthy (if a function is provided). the close button will show.
		The function that is called when the close button is triggered.
	`,
 
	isComplex: bool`
		Defaults to false.
		Provides a more segregated design to organize more content in the Dialog.
	`,
 
	hasGutters: bool`
		A true or false value that dictates whether or not the Body has padding.
	`,
 
	Header: node`
		*Child Element* - Header contents. Only one \`Header\` is used.
	`,
 
	Footer: node`
		*Child Element* - Footer contents. Only one \`Footer\` is used.
	`,
};
Dialog.Header = DialogHeader;
Dialog.Footer = DialogFooter;
 
export default Dialog;