/
index.tsx
245 lines (210 loc) · 5.53 KB
/
index.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
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
/**
* Copyright IBM Corp. 2016, 2023
*
* This source code is licensed under the Apache-2.0 license found in the
* LICENSE file in the root directory of this source tree.
*/
import PropTypes, { ReactNodeLike } from 'prop-types';
import React, { ForwardedRef } from 'react';
import Button, { ButtonSize } from '../Button';
import classNames from 'classnames';
import { Tooltip } from '../Tooltip';
import { usePrefix } from '../../internal/usePrefix';
export const IconButtonKinds = [
'primary',
'secondary',
'ghost',
'tertiary',
] as const;
export type IconButtonKind = (typeof IconButtonKinds)[number];
interface IconButtonProps
extends React.ButtonHTMLAttributes<HTMLButtonElement> {
/**
* Specify how the trigger should align with the tooltip
*/
align?:
| 'top'
| 'top-left'
| 'top-start'
| 'top-right'
| 'top-end'
| 'bottom'
| 'bottom-left'
| 'bottom-start'
| 'bottom-right'
| 'bottom-end'
| 'left'
| 'right';
/**
* Provide an icon or asset to be rendered inside of the IconButton
*/
children?: React.ReactNode;
/**
* Specify an optional className to be added to your Button
*/
className?: string;
/**
* Determines whether the tooltip should close when inner content is activated (click, Enter or Space)
*/
closeOnActivation?: boolean;
/**
* Specify whether the tooltip should be open when it first renders
*/
defaultOpen?: boolean;
/**
* Specify whether the Button should be disabled, or not
*/
disabled?: boolean;
/**
* Specify the duration in milliseconds to delay before displaying the tooltip
*/
enterDelayMs?: number;
/**
* Specify whether the IconButton is currently selected
*/
isSelected?: boolean;
/**
* Specify the type of button to be used as the base for the IconButton
*/
kind?: IconButtonKind;
/**
* Provide the label to be rendered inside of the Tooltip. The label will use
* `aria-labelledby` and will fully describe the child node that is provided.
* This means that if you have text in the child node it will not be
* announced to the screen reader.
*/
label: ReactNodeLike;
/**
* Specify the duration in milliseconds to delay before hiding the tooltip
*/
leaveDelayMs?: number;
/**
* Specify the size of the Button. Defaults to `md`.
*/
size?: ButtonSize;
/**
* Specify an optional className to be added to your Tooltip wrapper
*/
wrapperClasses?: string;
}
const IconButton = React.forwardRef(function IconButton(
{
align,
children,
className,
closeOnActivation = true,
defaultOpen = false,
disabled,
enterDelayMs = 100,
kind,
label,
leaveDelayMs = 100,
wrapperClasses,
size,
isSelected,
...rest
}: IconButtonProps,
ref: ForwardedRef<unknown> // TODO: this is unknown on Button, so should it be here as well?
) {
const prefix = usePrefix();
const tooltipClasses = classNames(wrapperClasses, `${prefix}--icon-tooltip`, {
[`${prefix}--icon-tooltip--disabled`]: disabled,
});
return (
<Tooltip
align={align}
closeOnActivation={closeOnActivation}
className={tooltipClasses}
defaultOpen={defaultOpen}
enterDelayMs={enterDelayMs}
label={label}
leaveDelayMs={leaveDelayMs}>
<Button
{...rest}
disabled={disabled}
kind={kind}
ref={ref}
size={size}
className={classNames(
`${prefix}--btn--icon-only`,
{
[`${prefix}--btn--selected`]: isSelected,
},
className
)}>
{children}
</Button>
</Tooltip>
);
});
IconButton.propTypes = {
/**
* Specify how the trigger should align with the tooltip
*/
align: PropTypes.oneOf([
'top',
'top-left',
'top-start',
'top-right',
'top-end',
'bottom',
'bottom-left',
'bottom-start',
'bottom-right',
'bottom-end',
'left',
'right',
]),
/**
* Provide an icon or asset to be rendered inside of the IconButton
*/
children: PropTypes.node,
/**
* Specify an optional className to be added to your Button
*/
className: PropTypes.string,
/**
* Determines whether the tooltip should close when inner content is activated (click, Enter or Space)
*/
closeOnActivation: PropTypes.bool,
/**
* Specify whether the tooltip should be open when it first renders
*/
defaultOpen: PropTypes.bool,
/**
* Specify whether the Button should be disabled, or not
*/
disabled: PropTypes.bool,
/**
* Specify the duration in milliseconds to delay before displaying the tooltip
*/
enterDelayMs: PropTypes.number,
/**
* Specify whether the IconButton is currently selected
*/
isSelected: PropTypes.bool,
/**
* Specify the type of button to be used as the base for the IconButton
*/
kind: PropTypes.oneOf(IconButtonKinds),
/**
* Provide the label to be rendered inside of the Tooltip. The label will use
* `aria-labelledby` and will fully describe the child node that is provided.
* This means that if you have text in the child node it will not be
* announced to the screen reader.
*/
label: PropTypes.node.isRequired,
/**
* Specify the duration in milliseconds to delay before hiding the tooltip
*/
leaveDelayMs: PropTypes.number,
/**
* Specify the size of the Button. Defaults to `md`.
*/
size: PropTypes.oneOf(['sm', 'md', 'lg']),
/**
* Specify an optional className to be added to your Tooltip wrapper
*/
wrapperClasses: PropTypes.string,
};
export { IconButton };