Skip to content

fix(countdown): 适配v14 && type增加text类型 #2701

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.

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 19 commits into from
Nov 22, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
104 changes: 8 additions & 96 deletions packages/nutui-taro-demo/src/app.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,125 +2,37 @@
const subPackages = [
{
"root": "base",
"pages": [
"pages/button/index",
"pages/cell/index",
"pages/configprovider/index",
"pages/icon/index",
"pages/image/index",
"pages/overlay/index"
]
"pages": []
},
{
"root": "layout",
"pages": [
"pages/divider/index",
"pages/grid/index",
"pages/layout/index",
"pages/safearea/index",
"pages/space/index",
"pages/sticky/index"
]
"pages": []
},
{
"root": "nav",
"pages": [
"pages/backtop/index",
"pages/elevator/index",
"pages/fixednav/index",
"pages/hoverbutton/index",
"pages/navbar/index",
"pages/sidenavbar/index",
"pages/tabbar/index",
"pages/tabs/index"
]
"pages": []
},
{
"root": "dentry",
"pages": [
"pages/address/index",
"pages/calendar/index",
"pages/calendarcard/index",
"pages/cascader/index",
"pages/checkbox/index",
"pages/datepicker/index",
"pages/form/index",
"pages/input/index",
"pages/inputnumber/index"
]
"pages": []
},
{
"root": "dataentry",
"pages": [
"pages/menu/index",
"pages/numberkeyboard/index",
"pages/picker/index",
"pages/radio/index",
"pages/range/index",
"pages/rate/index",
"pages/searchbar/index",
"pages/shortpassword/index",
"pages/signature/index",
"pages/switch/index",
"pages/textarea/index",
"pages/uploader/index"
]
"pages": []
},
{
"root": "feedback",
"pages": [
"pages/actionsheet/index",
"pages/badge/index",
"pages/dialog/index",
"pages/drag/index",
"pages/empty/index",
"pages/infiniteloading/index",
"pages/loading/index",
"pages/noticebar/index",
"pages/notify/index",
"pages/popover/index",
"pages/popup/index",
"pages/pulltorefresh/index",
"pages/resultpage/index",
"pages/skeleton/index",
"pages/swipe/index",
"pages/toast/index"
]
"pages": []
},
{
"root": "exhibition",
"pages": [
"pages/animate/index",
"pages/animatingnumbers/index",
"pages/avatar/index",
"pages/circleprogress/index",
"pages/collapse/index",
"pages/countdown/index",
"pages/ellipsis/index",
"pages/imagepreview/index",
"pages/indicator/index",
"pages/pagination/index",
"pages/price/index",
"pages/progress/index",
"pages/steps/index",
"pages/swiper/index",
"pages/table/index",
"pages/tag/index",
"pages/tour/index",
"pages/video/index",
"pages/virtuallist/index"
"pages/countdown/index"
]
},
{
"root": "business",
"pages": [
"pages/avatarcropper/index",
"pages/barrage/index",
"pages/card/index",
"pages/timeselect/index",
"pages/trendarrow/index",
"pages/watermark/index"
]
"pages": []
}
];

Expand Down
3 changes: 2 additions & 1 deletion src/config.json
Original file line number Diff line number Diff line change
Expand Up @@ -987,7 +987,8 @@
"sort": 17,
"show": true,
"taro": true,
"author": "songsong"
"author": "songsong",
"v14": true
},
{
"version": "2.0.0",
Expand Down
100 changes: 100 additions & 0 deletions src/packages/countdown/__test__/__snapshots__/countdown.spec.tsx.snap
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@
// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html

exports[`Countdown > type props primary 1`] = `
<div>
<div
class="nut-countdown "
>
<span
class="nut-countdown-number-primary"
>
00
</span>
:
<span
class="nut-countdown-number-primary"
>
00
</span>
:
<span
class="nut-countdown-number-primary"
>
00
</span>
</div>
</div>
`;

exports[`Countdown > type props text 1`] = `
<div>
<div
class="nut-countdown "
>
<span
class="nut-countdown-number-text"
>
00
</span>
:
<span
class="nut-countdown-number-text"
>
00
</span>
:
<span
class="nut-countdown-number-text"
>
00
</span>
</div>
</div>
`;

exports[`Countdown > type props text primary 1`] = `
<div>
<div
class="nut-countdown "
>
<span
class="nut-countdown-number-text"
>
00
</span>
:
<span
class="nut-countdown-number-text"
>
00
</span>
:
<span
class="nut-countdown-number-text"
>
00
</span>
</div>
<div
class="nut-countdown "
>
<span
class="nut-countdown-number-primary"
>
00
</span>
:
<span
class="nut-countdown-number-primary"
>
00
</span>
:
<span
class="nut-countdown-number-primary"
>
00
</span>
</div>
</div>
`;
22 changes: 22 additions & 0 deletions src/packages/countdown/__test__/countdown.spec.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,28 @@ describe('Countdown', () => {
})
})

test('type props text', async () => {
const { container } = render(
<CountDown endTime={Date.now() + 1 * 1000} type="text" />
)
const countdownDom = container.querySelector('.nut-countdown') as Element
expect(container).toMatchSnapshot()
expect(
countdownDom?.querySelectorAll('.nut-countdown-number-text')?.length
).toBe(3)
})
Comment on lines +46 to +55
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

建议增强 text 类型的测试覆盖范围

当前测试用例存在以下可以改进的地方:

  1. 仅验证了元素数量,未验证实际渲染的内容
  2. 缺少倒计时动态更新的测试
  3. 未测试边界情况

建议按照以下方式增强测试:

 test('type props text', async () => {
+  const endTime = Date.now() + 2000
   const { container } = render(
-    <CountDown endTime={Date.now() + 1 * 1000} type="text" />
+    <CountDown endTime={endTime} type="text" />
   )
   const countdownDom = container.querySelector('.nut-countdown') as Element
-  expect(container).toMatchSnapshot()
+  
+  // 验证初始渲染
   expect(
     countdownDom?.querySelectorAll('.nut-countdown-number-text')?.length
   ).toBe(3)
+  
+  // 验证实际内容
+  const numbers = countdownDom?.querySelectorAll('.nut-countdown-number-text')
+  expect(numbers[0]).toHaveTextContent('00')
+  
+  // 验证动态更新
+  await act(async () => {
+    await sleep(1000)
+    waitFor(() => {
+      expect(numbers[0]).toHaveTextContent('00')
+    })
+  })
+  
+  // 验证分隔符
+  const separators = countdownDom?.querySelectorAll('.nut-countdown-separator')
+  expect(separators).toHaveLength(2)
 })

Committable suggestion skipped: line range outside the PR's diff.


test('type props primary', async () => {
const { container } = render(
<CountDown endTime={Date.now() + 1 * 1000} type="primary" />
)
const countdownDom = container.querySelector('.nut-countdown') as Element
expect(container).toMatchSnapshot()
expect(
countdownDom?.querySelectorAll('.nut-countdown-number-primary')?.length
).toBe(3)
})

test('paused props', async () => {
const testClick = vi.fn()
let paused = false
Expand Down
10 changes: 8 additions & 2 deletions src/packages/countdown/countdown.scss
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
font-size: $countdown-font-size;
&-number-primary,
&-number,
&-number-text,
&-unit {
display: flex;
align-items: center;
Expand All @@ -20,19 +21,24 @@
padding: $countdown-number-padding;
border-radius: $countdown-number-border-radius;
margin: $countdown-number-margin;
text-align: center;
}
&-number {
border: 1px solid $countdown-number-border-color;
background-color: $countdown-number-background-color;
color: $countdown-number-color;
text-align: center;
}
&-number-primary {
border: 1px solid $countdown-number-primary-border-color;
background-color: $countdown-number-primary-background-color;
color: $countdown-number-primary-color;
}
&-number-text {
border: 0;
background-color: transparent;
color: $countdown-number-color;
}
&-unit {
color: $color-primary;
color: $countdown-color;
}
}
46 changes: 12 additions & 34 deletions src/packages/countdown/countdown.taro.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -2,40 +2,15 @@ import React, {
useState,
useRef,
useEffect,
ReactNode,
ForwardRefRenderFunction,
useImperativeHandle,
} from 'react'
import classNames from 'classnames'
import { View } from '@tarojs/components'
import { BasicComponent, ComponentDefaults } from '@/utils/typings'
import { ComponentDefaults } from '@/utils/typings'
import { padZero } from '@/utils/pad-zero'
import { web } from '@/utils/platform-taro'

export interface CountDownTimeProps {
d: number
h: number
m: number
s: number
ms: number
}
export type CountDownType = 'default' | 'primary'
export interface CountDownProps extends BasicComponent {
type: CountDownType
paused: boolean
startTime: number
endTime: number
remainingTime: number
millisecond: boolean
format: string
autoStart: boolean
time: number
destroy: boolean
onEnd: () => void
onPaused: (restTime: number) => void
onRestart: (restTime: number) => void
onUpdate: (restTime: any) => void
children: ReactNode
}
import { CountDownProps, CountDownTimeProps } from './types'

const defaultProps = {
...ComponentDefaults,
Expand Down Expand Up @@ -198,7 +173,7 @@ const InternalCountDown: ForwardRefRenderFunction<
} else if (formatCache.includes('SS')) {
formatCache = formatCache.replace('SS', msC.slice(0, 2))
} else if (formatCache.includes('S')) {
formatCache = formatCache.replace('SS', msC.slice(0, 1))
formatCache = formatCache.replace('S', msC.slice(0, 1))
}
}

Expand Down Expand Up @@ -237,8 +212,7 @@ const InternalCountDown: ForwardRefRenderFunction<
// 监听值变更
useEffect(() => {
const tranTime = formatRemainTime(stateRef.current.restTime, 'custom')

onUpdate && onUpdate(tranTime)
onUpdate && onUpdate(tranTime as CountDownTimeProps)
}, [restTimeStamp])

// 监听暂停
Expand Down Expand Up @@ -301,9 +275,13 @@ const InternalCountDown: ForwardRefRenderFunction<
{format.includes(formatUnit) ? (
<>
<View
className={`${classPrefix}-number${type === 'primary' ? '-primary' : ''}`}
className={classNames({
[`${classPrefix}-number`]: type === 'default',
[`${classPrefix}-number-primary`]: type === 'primary',
[`${classPrefix}-number-text`]: type === 'text',
})}
>
{padZero(time)}
{unit ? padZero(time) : time}
</View>
{unit ? (
<View className={`${classPrefix}-unit`}>{getUnit(unit)}</View>
Expand Down Expand Up @@ -335,7 +313,7 @@ const InternalCountDown: ForwardRefRenderFunction<
'S',
padZero(ms, 3)
.toString()
.slice(0, digit || 2)
.slice(0, digit || 1)
)}
</>
)
Expand Down
Loading
Loading