Skip to content

feat: optimize time selector panel step precision logic #596

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Mar 10, 2023
Merged

feat: optimize time selector panel step precision logic #596

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
94d783a
test: add case
Wxh16144 Feb 27, 2023
54e1609
chore: optimize time selector panel step precision logic
Wxh16144 Feb 27, 2023
5f47332
test: update snapshot
Wxh16144 Feb 27, 2023
829ac93
feat(type): update TS type
Wxh16144 Feb 27, 2023
b4aa280
test: add case
Wxh16144 Feb 27, 2023
5154307
fix: fix negative number error
Wxh16144 Feb 27, 2023
4fe87d2
perf: update performance
Wxh16144 Feb 27, 2023
68d4cfc
Update tests/picker.spec.tsx
Wxh16144 Feb 27, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions src/interface.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,3 +112,10 @@ export interface PresetDate<T> {
label: React.ReactNode;
value: T;
}

// https://stackoverflow.com/a/39495173; need TypeScript >= 4.5
type Enumerate<N extends number, Acc extends number[] = []> = Acc['length'] extends N
? Acc[number]
: Enumerate<N, [...Acc, Acc['length']]>

export type IntRange<F extends number, T extends number> = Exclude<Enumerate<T>, Enumerate<F>>
3 changes: 2 additions & 1 deletion src/panels/TimePanel/TimeBody.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,8 @@ function generateUnits(
disabledUnits: number[] | undefined,
) {
const units: Unit[] = [];
for (let i = start; i <= end; i += step) {
const integerStep = step >= 1 ? step | 0 : 1
for (let i = start; i <= end; i += integerStep) {
units.push({
label: leftPad(i, 2),
value: i,
Expand Down
8 changes: 4 additions & 4 deletions src/panels/TimePanel/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import classNames from 'classnames';
import TimeHeader from './TimeHeader';
import type { BodyOperationRef } from './TimeBody';
import TimeBody from './TimeBody';
import type { PanelSharedProps, DisabledTimes } from '../../interface';
import type { PanelSharedProps, DisabledTimes, IntRange } from '../../interface';
import { createKeyDownHandler } from '../../utils/uiUtil';

export type SharedTimeProps<DateType> = {
Expand All @@ -13,9 +13,9 @@ export type SharedTimeProps<DateType> = {
showMinute?: boolean;
showSecond?: boolean;
use12Hours?: boolean;
hourStep?: number;
minuteStep?: number;
secondStep?: number;
hourStep?: IntRange<1, 23>;
minuteStep?: IntRange<1, 59>;
secondStep?: IntRange<1, 59>;
hideDisabledOptions?: boolean;
defaultValue?: DateType;

Expand Down
285 changes: 285 additions & 0 deletions tests/__snapshots__/picker.spec.tsx.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,3 +103,288 @@ exports[`Picker.Basic should render correctly in rtl 1`] = `
</div>
</div>
`;

exports[`Picker.Basic time step should show integer when step is not integer (hour) 1`] = `
<ul
class="rc-picker-time-panel-column"
style="position: relative;"
>
<li
class="rc-picker-time-panel-cell"
>
<div
class="rc-picker-time-panel-cell-inner"
>
00
</div>
</li>
<li
class="rc-picker-time-panel-cell"
>
<div
class="rc-picker-time-panel-cell-inner"
>
05
</div>
</li>
<li
class="rc-picker-time-panel-cell"
>
<div
class="rc-picker-time-panel-cell-inner"
>
10
</div>
</li>
<li
class="rc-picker-time-panel-cell"
>
<div
class="rc-picker-time-panel-cell-inner"
>
15
</div>
</li>
<li
class="rc-picker-time-panel-cell"
>
<div
class="rc-picker-time-panel-cell-inner"
>
20
</div>
</li>
</ul>
`;

exports[`Picker.Basic time step should show integer when step is not integer (minute) 1`] = `
<ul
class="rc-picker-time-panel-column"
style="position: relative;"
>
<li
class="rc-picker-time-panel-cell"
>
<div
class="rc-picker-time-panel-cell-inner"
>
00
</div>
</li>
<li
class="rc-picker-time-panel-cell"
>
<div
class="rc-picker-time-panel-cell-inner"
>
05
</div>
</li>
<li
class="rc-picker-time-panel-cell"
>
<div
class="rc-picker-time-panel-cell-inner"
>
10
</div>
</li>
<li
class="rc-picker-time-panel-cell"
>
<div
class="rc-picker-time-panel-cell-inner"
>
15
</div>
</li>
<li
class="rc-picker-time-panel-cell"
>
<div
class="rc-picker-time-panel-cell-inner"
>
20
</div>
</li>
<li
class="rc-picker-time-panel-cell"
>
<div
class="rc-picker-time-panel-cell-inner"
>
25
</div>
</li>
<li
class="rc-picker-time-panel-cell"
>
<div
class="rc-picker-time-panel-cell-inner"
>
30
</div>
</li>
<li
class="rc-picker-time-panel-cell"
>
<div
class="rc-picker-time-panel-cell-inner"
>
35
</div>
</li>
<li
class="rc-picker-time-panel-cell"
>
<div
class="rc-picker-time-panel-cell-inner"
>
40
</div>
</li>
<li
class="rc-picker-time-panel-cell"
>
<div
class="rc-picker-time-panel-cell-inner"
>
45
</div>
</li>
<li
class="rc-picker-time-panel-cell"
>
<div
class="rc-picker-time-panel-cell-inner"
>
50
</div>
</li>
<li
class="rc-picker-time-panel-cell"
>
<div
class="rc-picker-time-panel-cell-inner"
>
55
</div>
</li>
</ul>
`;

exports[`Picker.Basic time step should show integer when step is not integer (second) 1`] = `
<ul
class="rc-picker-time-panel-column"
style="position: relative;"
>
<li
class="rc-picker-time-panel-cell"
>
<div
class="rc-picker-time-panel-cell-inner"
>
00
</div>
</li>
<li
class="rc-picker-time-panel-cell"
>
<div
class="rc-picker-time-panel-cell-inner"
>
05
</div>
</li>
<li
class="rc-picker-time-panel-cell"
>
<div
class="rc-picker-time-panel-cell-inner"
>
10
</div>
</li>
<li
class="rc-picker-time-panel-cell"
>
<div
class="rc-picker-time-panel-cell-inner"
>
15
</div>
</li>
<li
class="rc-picker-time-panel-cell"
>
<div
class="rc-picker-time-panel-cell-inner"
>
20
</div>
</li>
<li
class="rc-picker-time-panel-cell"
>
<div
class="rc-picker-time-panel-cell-inner"
>
25
</div>
</li>
<li
class="rc-picker-time-panel-cell"
>
<div
class="rc-picker-time-panel-cell-inner"
>
30
</div>
</li>
<li
class="rc-picker-time-panel-cell"
>
<div
class="rc-picker-time-panel-cell-inner"
>
35
</div>
</li>
<li
class="rc-picker-time-panel-cell"
>
<div
class="rc-picker-time-panel-cell-inner"
>
40
</div>
</li>
<li
class="rc-picker-time-panel-cell"
>
<div
class="rc-picker-time-panel-cell-inner"
>
45
</div>
</li>
<li
class="rc-picker-time-panel-cell"
>
<div
class="rc-picker-time-panel-cell-inner"
>
50
</div>
</li>
<li
class="rc-picker-time-panel-cell"
>
<div
class="rc-picker-time-panel-cell-inner"
>
55
</div>
</li>
</ul>
`;
19 changes: 19 additions & 0 deletions tests/picker.spec.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -616,6 +616,25 @@ describe('Picker.Basic', () => {
);
spy.mockRestore();
});

// https://github.com/ant-design/ant-design/issues/40914
['hour', 'minute', 'second'].forEach((unit, index) => {
it(`should show integer when step is not integer (${unit})`, () => {
const props = {
[`${unit}Step`]: 5.5,
}
const { container } = render(<MomentPicker picker="time" {...props} />);
openPicker(container);
expect(document.querySelectorAll('.rc-picker-time-panel-column')[index]).toMatchSnapshot();
});
});

it('should work when hourStep < 0', () => {
// @ts-ignore
const { container } = render(<MomentPicker picker="time" hourStep={-1} />);
openPicker(container);
expect(document.querySelectorAll('.rc-picker-time-panel-column')[0].children.length).toBe(24);
});
});

it('pass data- & aria- & role', () => {
Expand Down