|
1 | 1 | import * as React from 'react'; |
2 | 2 | import classNames from 'classnames'; |
| 3 | +import useMergedState from 'rc-util/lib/hooks/useMergedState'; |
| 4 | +import KeyCode from 'rc-util/lib/KeyCode'; |
3 | 5 |
|
4 | | -export type SwitchChangeEventHandler = (checked: boolean, event: MouseEvent) => void; |
| 6 | +export type SwitchChangeEventHandler = ( |
| 7 | + checked: boolean, |
| 8 | + event: React.MouseEvent<HTMLButtonElement> | React.KeyboardEvent<HTMLButtonElement>, |
| 9 | +) => void; |
5 | 10 | export type SwitchClickEventHandler = SwitchChangeEventHandler; |
6 | 11 |
|
7 | | -interface SwitchProps { |
| 12 | +interface SwitchProps |
| 13 | + extends Omit<React.HTMLAttributes<HTMLButtonElement>, 'onChange' | 'onClick'> { |
8 | 14 | className?: string; |
9 | 15 | prefixCls?: string; |
10 | 16 | disabled?: boolean; |
11 | 17 | checkedChildren?: React.ReactNode; |
12 | 18 | unCheckedChildren?: React.ReactNode; |
13 | 19 | onChange?: SwitchChangeEventHandler; |
14 | | - onMouseUp: React.MouseEventHandler<HTMLButtonElement>; |
| 20 | + onKeyDown?: React.KeyboardEventHandler<HTMLButtonElement>; |
15 | 21 | onClick?: SwitchClickEventHandler; |
16 | 22 | tabIndex?: number; |
17 | 23 | checked?: boolean; |
18 | 24 | defaultChecked?: boolean; |
19 | | - autoFocus?: boolean; |
20 | 25 | loadingIcon: React.ReactNode; |
21 | 26 | style?: React.CSSProperties; |
22 | 27 | title?: string; |
23 | 28 | } |
24 | 29 |
|
25 | | -const Switch = React.forwardRef<HTMLButtonElement, SwitchProps>((props, ref) => { |
26 | | - const mergedRef = (ref as any) || React.createRef<HTMLButtonElement>(); |
27 | | - |
28 | | - let initChecked = false; |
29 | | - if ('checked' in props) { |
30 | | - initChecked = !!props.checked; |
31 | | - } else { |
32 | | - initChecked = !!props.defaultChecked; |
33 | | - } |
34 | | - const [checked, setChecked] = React.useState(initChecked); |
35 | | - |
36 | | - React.useEffect(() => { |
37 | | - const { autoFocus, disabled } = props; |
38 | | - if (autoFocus && !disabled) { |
39 | | - (mergedRef.current as any).focus(); |
| 30 | +const Switch = React.forwardRef<HTMLButtonElement, SwitchProps>( |
| 31 | + ( |
| 32 | + { |
| 33 | + prefixCls = 'rc-switch', |
| 34 | + className, |
| 35 | + checked, |
| 36 | + defaultChecked, |
| 37 | + disabled, |
| 38 | + loadingIcon, |
| 39 | + checkedChildren, |
| 40 | + unCheckedChildren, |
| 41 | + onClick, |
| 42 | + onChange, |
| 43 | + onKeyDown, |
| 44 | + ...restProps |
| 45 | + }, |
| 46 | + ref, |
| 47 | + ) => { |
| 48 | + const [innerChecked, setInnerChecked] = useMergedState<boolean>(false, { |
| 49 | + value: checked, |
| 50 | + defaultValue: defaultChecked, |
| 51 | + }); |
| 52 | + |
| 53 | + function triggerChange( |
| 54 | + newChecked: boolean, |
| 55 | + event: React.MouseEvent<HTMLButtonElement> | React.KeyboardEvent<HTMLButtonElement>, |
| 56 | + ) { |
| 57 | + let mergedChecked = innerChecked; |
| 58 | + |
| 59 | + if (!disabled) { |
| 60 | + mergedChecked = newChecked; |
| 61 | + setInnerChecked(mergedChecked); |
| 62 | + onChange?.(mergedChecked, event); |
| 63 | + } |
| 64 | + |
| 65 | + return mergedChecked; |
40 | 66 | } |
41 | | - }, [props.autoFocus]); |
42 | 67 |
|
43 | | - React.useEffect(() => { |
44 | | - if ('checked' in props) { |
45 | | - setChecked(!!props.checked); |
| 68 | + function onInternalKeyDown(e: React.KeyboardEvent<HTMLButtonElement>) { |
| 69 | + if (e.which === KeyCode.LEFT) { |
| 70 | + triggerChange(false, e); |
| 71 | + } else if (e.which === KeyCode.RIGHT) { |
| 72 | + triggerChange(true, e); |
| 73 | + } |
| 74 | + onKeyDown?.(e); |
46 | 75 | } |
47 | | - }, [props.checked]); |
48 | 76 |
|
49 | | - const setInternalChecked = (checked, e) => { |
50 | | - const { disabled, onChange } = props; |
51 | | - if (disabled) { |
52 | | - return; |
53 | | - } |
54 | | - if (!('checked' in props)) { |
55 | | - setChecked(checked); |
56 | | - } |
57 | | - if (onChange) { |
58 | | - onChange(checked, e); |
| 77 | + function onInternalClick(e: React.MouseEvent<HTMLButtonElement>) { |
| 78 | + const ret = triggerChange(!innerChecked, e); |
| 79 | + // [Legacy] trigger onClick with value |
| 80 | + onClick?.(ret, e); |
59 | 81 | } |
60 | | - }; |
61 | 82 |
|
62 | | - const handleClick = e => { |
63 | | - const { onClick } = props; |
64 | | - const newChecked = !checked; |
65 | | - setInternalChecked(newChecked, e); |
66 | | - if (onClick) { |
67 | | - onClick(newChecked, e); |
68 | | - } |
69 | | - }; |
70 | | - |
71 | | - const handleKeyDown = e => { |
72 | | - if (e.keyCode === 37) { |
73 | | - // Left |
74 | | - setInternalChecked(false, e); |
75 | | - } else if (e.keyCode === 39) { |
76 | | - // Right |
77 | | - setInternalChecked(true, e); |
78 | | - } |
79 | | - }; |
80 | | - |
81 | | - // Handle auto focus when click switch in Chrome |
82 | | - const handleMouseUp = e => { |
83 | | - (mergedRef.current as any).blur(); |
84 | | - if (props.onMouseUp) { |
85 | | - props.onMouseUp(e); |
86 | | - } |
87 | | - }; |
88 | | - |
89 | | - const { |
90 | | - className, |
91 | | - prefixCls, |
92 | | - disabled, |
93 | | - loadingIcon, |
94 | | - checkedChildren, |
95 | | - unCheckedChildren, |
96 | | - onChange, |
97 | | - ...restProps |
98 | | - } = props; |
99 | | - |
100 | | - const switchClassName = classNames({ |
101 | | - [className]: !!className, |
102 | | - [prefixCls]: true, |
103 | | - [`${prefixCls}-checked`]: checked, |
104 | | - [`${prefixCls}-disabled`]: disabled, |
105 | | - }); |
106 | | - |
107 | | - return ( |
108 | | - <button |
109 | | - {...restProps} |
110 | | - type="button" |
111 | | - role="switch" |
112 | | - aria-checked={checked} |
113 | | - disabled={disabled} |
114 | | - className={switchClassName} |
115 | | - ref={mergedRef} |
116 | | - onKeyDown={handleKeyDown} |
117 | | - onClick={handleClick} |
118 | | - onMouseUp={handleMouseUp} |
119 | | - > |
120 | | - {loadingIcon} |
121 | | - <span className={`${prefixCls}-inner`}>{checked ? checkedChildren : unCheckedChildren}</span> |
122 | | - </button> |
123 | | - ); |
124 | | -}); |
| 83 | + const switchClassName = classNames(prefixCls, className, { |
| 84 | + [`${prefixCls}-checked`]: innerChecked, |
| 85 | + [`${prefixCls}-disabled`]: disabled, |
| 86 | + }); |
| 87 | + |
| 88 | + return ( |
| 89 | + <button |
| 90 | + {...restProps} |
| 91 | + type="button" |
| 92 | + role="switch" |
| 93 | + aria-checked={innerChecked} |
| 94 | + disabled={disabled} |
| 95 | + className={switchClassName} |
| 96 | + ref={ref} |
| 97 | + onKeyDown={onInternalKeyDown} |
| 98 | + onClick={onInternalClick} |
| 99 | + > |
| 100 | + {loadingIcon} |
| 101 | + <span className={`${prefixCls}-inner`}> |
| 102 | + {innerChecked ? checkedChildren : unCheckedChildren} |
| 103 | + </span> |
| 104 | + </button> |
| 105 | + ); |
| 106 | + }, |
| 107 | +); |
125 | 108 |
|
126 | 109 | Switch.displayName = 'Switch'; |
127 | 110 |
|
128 | | -Switch.defaultProps = { |
129 | | - prefixCls: 'rc-switch', |
130 | | - checkedChildren: null, |
131 | | - unCheckedChildren: null, |
132 | | - className: '', |
133 | | - defaultChecked: false, |
134 | | -}; |
135 | | - |
136 | 111 | export default Switch; |
0 commit comments