TimePicker.tsx 19 KB

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