-
Notifications
You must be signed in to change notification settings - Fork 349
/
Button.tsx
206 lines (195 loc) · 7.06 KB
/
Button.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
import * as React from 'react';
import styles from '@patternfly/react-styles/css/components/Button/button';
import { css } from '@patternfly/react-styles';
import { Spinner, spinnerSize } from '../Spinner';
import { useOUIAProps, OUIAProps } from '../../helpers/OUIA/ouia';
import { Badge } from '../Badge';
export enum ButtonVariant {
primary = 'primary',
secondary = 'secondary',
tertiary = 'tertiary',
danger = 'danger',
warning = 'warning',
link = 'link',
plain = 'plain',
control = 'control'
}
export enum ButtonType {
button = 'button',
submit = 'submit',
reset = 'reset'
}
export enum ButtonSize {
default = 'default',
sm = 'sm',
lg = 'lg'
}
export interface BadgeCountObject {
/** Adds styling to the badge to indicate it has been read */
isRead?: boolean;
/** Adds count number right of button */
count?: number;
/** Additional classes added to the badge count */
className?: string;
}
export interface ButtonProps extends Omit<React.HTMLProps<HTMLButtonElement>, 'ref' | 'size'>, OUIAProps {
/** Content rendered inside the button */
children?: React.ReactNode;
/** Additional classes added to the button */
className?: string;
/** Sets the base component to render. defaults to button */
component?: React.ElementType<any> | React.ComponentType<any>;
/** Adds active styling to button. */
isActive?: boolean;
/** Adds block styling to button */
isBlock?: boolean;
/** Adds disabled styling and disables the button using the disabled html attribute */
isDisabled?: boolean;
/** Adds disabled styling and communicates that the button is disabled using the aria-disabled html attribute */
isAriaDisabled?: boolean;
/** Adds progress styling to button */
isLoading?: boolean;
/** Text describing that current loading status or progress */
spinnerAriaValueText?: string;
/** Accessible label for the spinner to describe what is loading */
spinnerAriaLabel?: string;
/** Id of element which describes what is being loaded */
spinnerAriaLabelledBy?: string;
/** Events to prevent when the button is in an aria-disabled state */
inoperableEvents?: string[];
/** Adds inline styling to a link button */
isInline?: boolean;
/** Adds styling which affects the size of the button */
size?: 'default' | 'sm' | 'lg';
/** Sets button type */
type?: 'button' | 'submit' | 'reset';
/** Adds button variant styles */
variant?: 'primary' | 'secondary' | 'tertiary' | 'danger' | 'warning' | 'link' | 'plain' | 'control';
/** Sets position of the icon. Note: "left" and "right" are deprecated. Use "start" and "end" instead */
iconPosition?: 'start' | 'end' | 'left' | 'right';
/** Adds accessible text to the button. */
'aria-label'?: string;
/** Icon for the button. Usable by all variants except for plain. */
icon?: React.ReactNode | null;
/** Sets the button tabindex. */
tabIndex?: number;
/** Adds danger styling to secondary or link button variants */
isDanger?: boolean;
/** @hide Forwarded ref */
innerRef?: React.Ref<any>;
/** Adds count number to button */
countOptions?: BadgeCountObject;
/** Value to overwrite the randomly generated data-ouia-component-id.*/
ouiaId?: number | string;
/** Set the value of data-ouia-safe. Only set to true when the component is in a static state, i.e. no animations are occurring. At all other times, this value must be false. */
ouiaSafe?: boolean;
}
const ButtonBase: React.FunctionComponent<ButtonProps> = ({
children = null,
className = '',
component = 'button',
isActive = false,
isBlock = false,
isDisabled = false,
isAriaDisabled = false,
isLoading = null,
isDanger = false,
spinnerAriaValueText,
spinnerAriaLabelledBy,
spinnerAriaLabel,
size = ButtonSize.default,
inoperableEvents = ['onClick', 'onKeyPress'],
isInline = false,
type = ButtonType.button,
variant = ButtonVariant.primary,
iconPosition = 'start',
'aria-label': ariaLabel = null,
icon = null,
ouiaId,
ouiaSafe = true,
tabIndex = null,
innerRef,
countOptions,
...props
}: ButtonProps) => {
const ouiaProps = useOUIAProps(Button.displayName, ouiaId, ouiaSafe, variant);
const Component = component as any;
const isButtonElement = Component === 'button';
const isInlineSpan = isInline && Component === 'span';
const preventedEvents = inoperableEvents.reduce(
(handlers, eventToPrevent) => ({
...handlers,
[eventToPrevent]: (event: React.SyntheticEvent<HTMLButtonElement>) => {
event.preventDefault();
}
}),
{}
);
const getDefaultTabIdx = () => {
if (isDisabled) {
return isButtonElement ? null : -1;
} else if (isAriaDisabled) {
return null;
} else if (isInlineSpan) {
return 0;
}
};
return (
<Component
{...props}
{...(isAriaDisabled ? preventedEvents : null)}
aria-disabled={isDisabled || isAriaDisabled}
aria-label={ariaLabel}
className={css(
styles.button,
styles.modifiers[variant],
isBlock && styles.modifiers.block,
isDisabled && styles.modifiers.disabled,
isAriaDisabled && styles.modifiers.ariaDisabled,
isActive && styles.modifiers.active,
isInline && variant === ButtonVariant.link && styles.modifiers.inline,
isDanger && (variant === ButtonVariant.secondary || variant === ButtonVariant.link) && styles.modifiers.danger,
isLoading !== null && variant !== ButtonVariant.plain && styles.modifiers.progress,
isLoading && styles.modifiers.inProgress,
size === ButtonSize.sm && styles.modifiers.small,
size === ButtonSize.lg && styles.modifiers.displayLg,
className
)}
disabled={isButtonElement ? isDisabled : null}
tabIndex={tabIndex !== null ? tabIndex : getDefaultTabIdx()}
type={isButtonElement || isInlineSpan ? type : null}
role={isInlineSpan ? 'button' : null}
ref={innerRef}
{...ouiaProps}
>
{isLoading && (
<span className={css(styles.buttonProgress)}>
<Spinner
size={spinnerSize.md}
isInline={isInline}
aria-valuetext={spinnerAriaValueText}
aria-label={spinnerAriaLabel}
aria-labelledby={spinnerAriaLabelledBy}
/>
</span>
)}
{variant === ButtonVariant.plain && children === null && icon ? icon : null}
{variant !== ButtonVariant.plain && icon && (iconPosition === 'start' || iconPosition === 'left') && (
<span className={css(styles.buttonIcon, styles.modifiers.start)}>{icon}</span>
)}
{children}
{variant !== ButtonVariant.plain && icon && (iconPosition === 'end' || iconPosition === 'right') && (
<span className={css(styles.buttonIcon, styles.modifiers.end)}>{icon}</span>
)}
{countOptions && (
<span className={css(styles.buttonCount, countOptions.className)}>
<Badge isRead={countOptions.isRead}>{countOptions.count}</Badge>
</span>
)}
</Component>
);
};
export const Button = React.forwardRef((props: ButtonProps, ref: React.Ref<any>) => (
<ButtonBase innerRef={ref} {...props} />
));
Button.displayName = 'Button';