TimePicker.tsx 19 KB

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