TimePicker.tsx 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521
  1. import React from 'react';
  2. import PropTypes from 'prop-types';
  3. import classNames from 'classnames';
  4. import { noop, get } from 'lodash';
  5. import ConfigContext from '../configProvider/context';
  6. import BaseComponent, { ValidateStatus } from '../_base/baseComponent';
  7. import { strings, cssClasses } from '@douyinfe/semi-foundation/timePicker/constants';
  8. import Popover, { PopoverProps } from '../popover';
  9. import { numbers as popoverNumbers } from '@douyinfe/semi-foundation/popover/constants';
  10. import TimePickerFoundation, {
  11. TimePickerAdapter,
  12. TimePickerFoundationProps,
  13. TimePickerFoundationState,
  14. } from '@douyinfe/semi-foundation/timePicker/foundation';
  15. import isNullOrUndefined from '@douyinfe/semi-foundation/utils/isNullOrUndefined';
  16. import Combobox from './Combobox';
  17. import TimeInput from './TimeInput';
  18. import { PanelShape, PanelShapeDefaults } from './PanelShape';
  19. import { TimeShape } from './TimeShape';
  20. import '@douyinfe/semi-foundation/timePicker/timePicker.scss';
  21. import Trigger from '../trigger';
  22. import { InputSize } from '../input';
  23. import { Position } from '../tooltip';
  24. import { ScrollItemProps } from '../scrollList/scrollItem';
  25. import { Locale } from '../locale/interface';
  26. export interface Panel {
  27. panelHeader?: React.ReactNode | React.ReactNode[];
  28. panelFooter?: React.ReactNode | React.ReactNode[]
  29. }
  30. export type TimePickerProps = {
  31. 'aria-describedby'?: React.AriaAttributes['aria-describedby'];
  32. 'aria-errormessage'?: React.AriaAttributes['aria-errormessage'];
  33. 'aria-invalid'?: React.AriaAttributes['aria-invalid'];
  34. 'aria-labelledby'?: React.AriaAttributes['aria-labelledby'];
  35. 'aria-required'?: React.AriaAttributes['aria-required'];
  36. clearIcon?: React.ReactNode;
  37. dropdownMargin?: PopoverProps['margin'];
  38. inputStyle?: React.CSSProperties;
  39. insetLabel?: React.ReactNode;
  40. locale?: Locale['TimePicker'];
  41. popupStyle?: React.CSSProperties;
  42. position?: Position;
  43. scrollItemProps?: ScrollItemProps<any>;
  44. size?: InputSize;
  45. style?: React.CSSProperties;
  46. triggerRender?: (props?: any) => React.ReactNode;
  47. validateStatus?: ValidateStatus;
  48. onBlur?: React.FocusEventHandler<HTMLInputElement>;
  49. onChange?: TimePickerAdapter['notifyChange'];
  50. onChangeWithDateFirst?: boolean;
  51. onFocus?: React.FocusEventHandler<HTMLInputElement>;
  52. onOpenChange?: (open: boolean) => void
  53. } & TimePickerFoundationProps;
  54. export interface TimePickerState extends TimePickerFoundationState { }
  55. export default class TimePicker extends BaseComponent<TimePickerProps, TimePickerState> {
  56. static contextType = ConfigContext;
  57. static propTypes = {
  58. 'aria-labelledby': PropTypes.string,
  59. 'aria-invalid': PropTypes.bool,
  60. 'aria-errormessage': PropTypes.string,
  61. 'aria-describedby': PropTypes.string,
  62. 'aria-required': PropTypes.bool,
  63. prefixCls: PropTypes.string,
  64. borderless: PropTypes.bool,
  65. clearText: PropTypes.string,
  66. clearIcon: PropTypes.node,
  67. value: TimeShape,
  68. inputReadOnly: PropTypes.bool,
  69. disabled: PropTypes.bool,
  70. showClear: PropTypes.bool,
  71. defaultValue: TimeShape,
  72. open: PropTypes.bool,
  73. defaultOpen: PropTypes.bool,
  74. onOpenChange: PropTypes.func,
  75. position: PropTypes.any,
  76. getPopupContainer: PropTypes.func,
  77. placeholder: PropTypes.string,
  78. format: PropTypes.string,
  79. style: PropTypes.object,
  80. className: PropTypes.string,
  81. popupClassName: PropTypes.string,
  82. popupStyle: PropTypes.object,
  83. disabledHours: PropTypes.func,
  84. disabledMinutes: PropTypes.func,
  85. disabledSeconds: PropTypes.func,
  86. dropdownMargin: PropTypes.oneOfType([PropTypes.number, PropTypes.object]),
  87. hideDisabledOptions: PropTypes.bool,
  88. onChange: PropTypes.func,
  89. use12Hours: PropTypes.bool,
  90. hourStep: PropTypes.number,
  91. minuteStep: PropTypes.number,
  92. secondStep: PropTypes.number,
  93. focusOnOpen: PropTypes.bool,
  94. autoFocus: PropTypes.bool,
  95. size: PropTypes.oneOf(strings.SIZE),
  96. stopPropagation: PropTypes.bool,
  97. panels: PropTypes.arrayOf(PropTypes.shape(PanelShape)),
  98. onFocus: PropTypes.func,
  99. onBlur: PropTypes.func,
  100. locale: PropTypes.object,
  101. localeCode: PropTypes.string,
  102. dateFnsLocale: PropTypes.object,
  103. zIndex: PropTypes.oneOfType([PropTypes.number, PropTypes.string]),
  104. insetLabel: PropTypes.node,
  105. insetLabelId: PropTypes.string,
  106. validateStatus: PropTypes.oneOf(strings.STATUS),
  107. type: PropTypes.oneOf<TimePickerProps['type']>(strings.TYPES),
  108. rangeSeparator: PropTypes.string,
  109. triggerRender: PropTypes.func,
  110. timeZone: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
  111. scrollItemProps: PropTypes.object,
  112. motion: PropTypes.oneOfType([PropTypes.bool, PropTypes.func, PropTypes.object]),
  113. autoAdjustOverflow: PropTypes.bool,
  114. ...PanelShape,
  115. inputStyle: PropTypes.object,
  116. preventScroll: PropTypes.bool,
  117. };
  118. static defaultProps = {
  119. autoAdjustOverflow: true,
  120. borderless: false,
  121. getPopupContainer: () => document.body,
  122. showClear: true,
  123. zIndex: popoverNumbers.DEFAULT_Z_INDEX,
  124. rangeSeparator: strings.DEFAULT_RANGE_SEPARATOR,
  125. onOpenChange: noop,
  126. clearText: 'clear',
  127. prefixCls: cssClasses.PREFIX,
  128. inputReadOnly: false,
  129. style: {},
  130. stopPropagation: true,
  131. className: '',
  132. popupClassName: '',
  133. popupStyle: { left: '0px', top: '0px' },
  134. disabledHours: () => [] as number[],
  135. disabledMinutes: () => [] as number[],
  136. disabledSeconds: () => [] as number[],
  137. hideDisabledOptions: false,
  138. // position: 'bottomLeft',
  139. onFocus: noop,
  140. onBlur: noop,
  141. onChange: noop,
  142. onChangeWithDateFirst: true,
  143. use12Hours: false,
  144. focusOnOpen: false,
  145. onKeyDown: noop,
  146. size: 'default' as const,
  147. type: strings.DEFAULT_TYPE,
  148. motion: true,
  149. ...PanelShapeDefaults,
  150. // format: strings.DEFAULT_FORMAT,
  151. // open and value controlled
  152. };
  153. foundation: TimePickerFoundation;
  154. timePickerRef: React.MutableRefObject<HTMLDivElement>;
  155. savePanelRef: React.RefObject<HTMLDivElement>;
  156. useCustomTrigger: boolean;
  157. clickOutSideHandler: (e: MouseEvent) => void;
  158. constructor(props: TimePickerProps) {
  159. super(props);
  160. const { format = strings.DEFAULT_FORMAT } = props;
  161. this.state = {
  162. open: props.open || props.defaultOpen || false,
  163. value: [], // Date[]
  164. inputValue: '', // time string
  165. currentSelectPanel: 0,
  166. isAM: [true, false],
  167. showHour: Boolean(format.match(/HH|hh|H|h/g)),
  168. showMinute: Boolean(format.match(/mm/g)),
  169. showSecond: Boolean(format.match(/ss/g)),
  170. invalid: undefined,
  171. };
  172. this.foundation = new TimePickerFoundation(this.adapter);
  173. this.timePickerRef = React.createRef();
  174. this.savePanelRef = React.createRef();
  175. this.useCustomTrigger = typeof this.props.triggerRender === 'function';
  176. }
  177. get adapter(): TimePickerAdapter<TimePickerProps, TimePickerState> {
  178. return {
  179. ...super.adapter,
  180. togglePanel: show => {
  181. this.setState({ open: show });
  182. },
  183. registerClickOutSide: () => {
  184. if (this.clickOutSideHandler) {
  185. this.adapter.unregisterClickOutSide();
  186. }
  187. this.clickOutSideHandler = e => {
  188. const panel = this.savePanelRef && this.savePanelRef.current;
  189. const trigger = this.timePickerRef && this.timePickerRef.current;
  190. const target = e.target as Element;
  191. const path = (e.composedPath && e.composedPath()) || [target];
  192. if (
  193. !(panel && panel.contains(target)) &&
  194. !(trigger && trigger.contains(target)) &&
  195. !(path.includes(trigger) || path.includes(panel))
  196. ) {
  197. this.foundation.handlePanelClose(true, e);
  198. }
  199. };
  200. document.addEventListener('mousedown', this.clickOutSideHandler);
  201. },
  202. setInputValue: (inputValue, cb) => this.setState({ inputValue }, cb),
  203. unregisterClickOutSide: () => {
  204. if (this.clickOutSideHandler) {
  205. document.removeEventListener('mousedown', this.clickOutSideHandler);
  206. this.clickOutSideHandler = null;
  207. }
  208. },
  209. notifyOpenChange: (...args) => this.props.onOpenChange(...args),
  210. notifyChange: (agr1, arg2) => this.props.onChange && this.props.onChange(agr1, arg2),
  211. notifyFocus: (...args) => this.props.onFocus && this.props.onFocus(...args),
  212. notifyBlur: (...args) => this.props.onBlur && this.props.onBlur(...args),
  213. isRangePicker: () => this.props.type === strings.TYPE_TIME_RANGE_PICKER,
  214. };
  215. }
  216. static getDerivedStateFromProps(nextProps: TimePickerProps, prevState: TimePickerState) {
  217. if ('open' in nextProps && nextProps.open !== prevState.open) {
  218. return {
  219. open: nextProps.open,
  220. };
  221. }
  222. return null;
  223. }
  224. componentDidUpdate(prevProps: TimePickerProps) {
  225. // if (this.isControlled('open') && this.props.open != null && this.props.open !== prevProps.open) {
  226. // this.foundation.setPanel(this.props.open);
  227. // }
  228. if (this.isControlled('value') && this.props.value !== prevProps.value) {
  229. this.foundation.refreshProps({
  230. ...this.props,
  231. });
  232. } else if (this.props.timeZone !== prevProps.timeZone) {
  233. this.foundation.refreshProps({
  234. timeZone: this.props.timeZone,
  235. __prevTimeZone: prevProps.timeZone,
  236. value: this.state.value,
  237. });
  238. }
  239. }
  240. onCurrentSelectPanelChange = (currentSelectPanel: string) => {
  241. this.setState({ currentSelectPanel });
  242. };
  243. handlePanelChange = (value: { isAM: boolean; value: string; timeStampValue: number }, index: number) =>
  244. this.foundation.handlePanelChange(value, index);
  245. handleInput = (value: string) => this.foundation.handleInputChange(value);
  246. createPanelProps = (index = 0) => {
  247. const { panels, panelFooter, panelHeader, locale } = this.props;
  248. const panelProps = {
  249. panelHeader,
  250. panelFooter,
  251. };
  252. if (this.adapter.isRangePicker()) {
  253. const defaultHeaderMap = {
  254. 0: locale.begin,
  255. 1: locale.end,
  256. };
  257. panelProps.panelHeader = get(
  258. panels,
  259. index,
  260. isNullOrUndefined(panelHeader)
  261. ? get(defaultHeaderMap, index, null)
  262. : Array.isArray(panelHeader)
  263. ? panelHeader[index]
  264. : panelHeader
  265. );
  266. panelProps.panelFooter = get(
  267. panels,
  268. index,
  269. Array.isArray(panelFooter) ? panelFooter[index] : panelFooter
  270. ) as React.ReactNode;
  271. }
  272. return panelProps;
  273. };
  274. getPanelElement() {
  275. const { prefixCls, type } = this.props;
  276. const { isAM, value } = this.state;
  277. const format = this.foundation.getDefaultFormatIfNeed();
  278. const timePanels = [
  279. <Combobox
  280. {...this.props}
  281. key={0}
  282. format={format}
  283. isAM={isAM[0]}
  284. timeStampValue={value[0]}
  285. prefixCls={`${prefixCls}-panel`}
  286. onChange={v => this.handlePanelChange(v, 0)}
  287. onCurrentSelectPanelChange={this.onCurrentSelectPanelChange}
  288. {...this.createPanelProps(0)}
  289. />,
  290. ];
  291. if (type === strings.TYPE_TIME_RANGE_PICKER) {
  292. timePanels.push(
  293. <Combobox
  294. {...this.props}
  295. key={1}
  296. format={format}
  297. isAM={isAM[1]}
  298. timeStampValue={value[1]}
  299. prefixCls={`${prefixCls}-panel`}
  300. onChange={v => this.handlePanelChange(v, 1)}
  301. onCurrentSelectPanelChange={this.onCurrentSelectPanelChange}
  302. {...this.createPanelProps(1)}
  303. />
  304. );
  305. }
  306. const wrapCls = classNames({
  307. [cssClasses.RANGE_PANEL_LISTS]: this.adapter.isRangePicker(),
  308. });
  309. return (
  310. <div ref={this.savePanelRef} className={wrapCls}>
  311. {timePanels.map(panel => panel)}
  312. </div>
  313. );
  314. }
  315. getPopupClassName() {
  316. const { use12Hours, prefixCls, popupClassName } = this.props;
  317. const { showHour, showMinute, showSecond } = this.state;
  318. let selectColumnCount = 0;
  319. if (showHour) {
  320. selectColumnCount += 1;
  321. }
  322. if (showMinute) {
  323. selectColumnCount += 1;
  324. }
  325. if (showSecond) {
  326. selectColumnCount += 1;
  327. }
  328. if (use12Hours) {
  329. selectColumnCount += 1;
  330. }
  331. return classNames(
  332. `${prefixCls}-panel`,
  333. popupClassName,
  334. {
  335. [`${prefixCls}-panel-narrow`]: (!showHour || !showMinute || !showSecond) && !use12Hours,
  336. [cssClasses.RANGE_PICKER]: this.adapter.isRangePicker(),
  337. },
  338. `${prefixCls}-panel-column-${selectColumnCount}`
  339. );
  340. }
  341. focus() {
  342. // TODO this.picker is undefined, confirm keep this func or not
  343. // this.picker.focus();
  344. }
  345. blur() {
  346. // TODO this.picker is undefined, confirm keep this func or not
  347. // this.picker.blur();
  348. }
  349. /* istanbul ignore next */
  350. handlePanelVisibleChange = (visible: boolean) => this.foundation.handleVisibleChange(visible);
  351. openPanel = () => {
  352. this.foundation.handlePanelOpen();
  353. };
  354. handleFocus = (e: React.FocusEvent<HTMLInputElement>) => {
  355. this.foundation.handleFocus(e);
  356. };
  357. handleBlur = (e: React.FocusEvent<HTMLInputElement>) => this.foundation.handleInputBlur(e);
  358. setTimePickerRef: React.LegacyRef<HTMLDivElement> = node => (this.timePickerRef.current = node);
  359. render() {
  360. const {
  361. prefixCls,
  362. placeholder,
  363. disabled,
  364. defaultValue,
  365. dropdownMargin,
  366. className,
  367. popupStyle,
  368. size,
  369. style,
  370. locale,
  371. localeCode,
  372. zIndex,
  373. getPopupContainer,
  374. insetLabel,
  375. insetLabelId,
  376. inputStyle,
  377. showClear,
  378. panelHeader,
  379. panelFooter,
  380. rangeSeparator,
  381. onOpenChange,
  382. onChangeWithDateFirst,
  383. popupClassName: propPopupClassName,
  384. hideDisabledOptions,
  385. use12Hours,
  386. minuteStep,
  387. hourStep,
  388. secondStep,
  389. scrollItemProps,
  390. triggerRender,
  391. motion,
  392. autoAdjustOverflow,
  393. stopPropagation,
  394. ...rest
  395. } = this.props;
  396. const format = this.foundation.getDefaultFormatIfNeed();
  397. const position = this.foundation.getPosition();
  398. const { open, inputValue, invalid, value } = this.state;
  399. const popupClassName = this.getPopupClassName();
  400. const headerPrefix = classNames({
  401. [`${prefixCls}-header`]: true,
  402. });
  403. const panelPrefix = classNames({
  404. [`${prefixCls}-panel`]: true,
  405. [`${prefixCls}-panel-${size}`]: size,
  406. });
  407. const inputProps = {
  408. ...rest,
  409. disabled,
  410. prefixCls,
  411. size,
  412. showClear: disabled ? false : showClear,
  413. style: inputStyle,
  414. value: inputValue,
  415. onFocus: this.handleFocus,
  416. insetLabel,
  417. insetLabelId,
  418. format,
  419. locale,
  420. localeCode,
  421. invalid,
  422. placeholder,
  423. onChange: this.handleInput,
  424. onBlur: this.handleBlur,
  425. };
  426. const outerProps = {} as { onClick: () => void };
  427. if (this.useCustomTrigger) {
  428. outerProps.onClick = this.openPanel;
  429. }
  430. return (
  431. <div
  432. ref={this.setTimePickerRef}
  433. className={classNames({ [prefixCls]: true }, className)}
  434. style={style}
  435. {...outerProps}
  436. >
  437. <Popover
  438. getPopupContainer={getPopupContainer}
  439. zIndex={zIndex as number}
  440. prefixCls={panelPrefix}
  441. contentClassName={popupClassName}
  442. style={popupStyle}
  443. content={this.getPanelElement()}
  444. trigger={'custom'}
  445. position={position}
  446. visible={disabled ? false : Boolean(open)}
  447. motion={motion}
  448. margin={dropdownMargin}
  449. autoAdjustOverflow={autoAdjustOverflow}
  450. stopPropagation={stopPropagation}
  451. >
  452. {this.useCustomTrigger ? (
  453. <Trigger
  454. triggerRender={triggerRender}
  455. disabled={disabled}
  456. value={value}
  457. inputValue={inputValue}
  458. onChange={this.handleInput}
  459. placeholder={placeholder}
  460. componentName={'TimePicker'}
  461. componentProps={{ ...this.props }}
  462. />
  463. ) : (
  464. <span className={headerPrefix}>
  465. <TimeInput {...inputProps} />
  466. </span>
  467. )}
  468. </Popover>
  469. </div>
  470. );
  471. }
  472. }