feat: support creating different format value by range index
在特殊业务场景下,我需要为RangPicker的起始时间和结束时间采用不同的格式化:
现有的api似乎无法做到,结合目前的format prop设计,只要将range的索引传递给customFormat即可实现:
Preview:
Summary by CodeRabbit
-
新功能
- 在范围选择器示例中新增“自定义格式”用法,支持分别自定义起止日期的显示格式(如仅显示年份或完整日期)。
-
文档
- 增加了“自定义格式”相关的使用示例,便于理解格式化函数的用法。
-
类型优化
- 自定义格式化函数现支持接收索引参数,便于区分和处理不同位置的日期格式。
The latest updates on your projects. Learn more about Vercel for Git ↗︎
| Name | Status | Preview | Comments | Updated (UTC) |
|---|---|---|---|---|
| picker | ✅ Ready (Inspect) | Visit Preview | 💬 Add feedback | Jun 25, 2025 1:42pm |
Walkthrough
本次更改为 RangePicker 组件引入了自定义格式化示例,并将自定义格式化函数的签名扩展为支持索引参数。相关类型定义、工具函数和钩子均已同步调整,以便格式化函数能够接收并利用日期项的索引信息。
Changes
| 文件/分组 | 变更简述 |
|---|---|
| docs/examples/range.tsx | 新增“Custom Format”示例,展示带索引的自定义格式化 RangePicker。 |
| src/interface.tsx | CustomFormat 类型签名增加 index 参数。 |
| src/utils/dateUtil.ts | formatValue 函数增加 index 参数,调用格式化函数时传递索引。 |
| src/PickerInput/Selector/hooks/useInputProps.ts | getText 回调函数签名增加 index 参数,相关调用同步调整。 |
Sequence Diagram(s)
sequenceDiagram
participant User
participant RangePicker
participant formatValue
participant CustomFormat
User->>RangePicker: 选择日期范围
RangePicker->>formatValue: formatValue(date, { format, index })
formatValue->>CustomFormat: CustomFormat(date, index)
CustomFormat-->>formatValue: 返回格式化字符串
formatValue-->>RangePicker: 返回格式化结果
RangePicker-->>User: 显示格式化后的日期文本
Suggested reviewers
- zombieJ
Poem
🐇
代码如春草,格式随心调,
索引添新意,日期更美妙。
RangePicker 展示,示例闪光耀,
格式自定义,灵活真高超!
[!WARNING] There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.
🔧 ESLint
If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.
src/PickerInput/Selector/hooks/useInputProps.ts
Oops! Something went wrong! :(
ESLint: 8.57.1
Error: Cannot read config file: /.eslintrc.js Error: Cannot find module '@umijs/fabric/dist/eslint' Require stack:
- /.eslintrc.js
- /node_modules/.pnpm/@[email protected]/node_modules/@eslint/eslintrc/dist/eslintrc.cjs
- /node_modules/.pnpm/[email protected]/node_modules/eslint/lib/cli-engine/cli-engine.js
- /node_modules/.pnpm/[email protected]/node_modules/eslint/lib/eslint/eslint.js
- /node_modules/.pnpm/[email protected]/node_modules/eslint/lib/eslint/index.js
- /node_modules/.pnpm/[email protected]/node_modules/eslint/lib/cli.js
- /node_modules/.pnpm/[email protected]/node_modules/eslint/bin/eslint.js at Module._resolveFilename (node:internal/modules/cjs/loader:1405:15) at require.resolve (node:internal/modules/helpers:145:19) at Object.
(/.eslintrc.js:2:21) at Module._compile (node:internal/modules/cjs/loader:1734:14) at Object..js (node:internal/modules/cjs/loader:1899:10) at Module.load (node:internal/modules/cjs/loader:1469:32) at Module._load (node:internal/modules/cjs/loader:1286:12) at TracingChannel.traceSync (node:diagnostics_channel:322:14) at wrapModuleLoad (node:internal/modules/cjs/loader:235:24) at Module.require (node:internal/modules/cjs/loader:1491:12)
📜 Recent review details
Configuration used: CodeRabbit UI Review profile: CHILL Plan: Pro
📥 Commits
Reviewing files that changed from the base of the PR and between abd1bba4b8c082b23d0ca83b38b89e822f42c499 and 82093690e635dbeccdecb7ef3b64ffaed374aaa7.
📒 Files selected for processing (1)
-
src/PickerInput/Selector/hooks/useInputProps.ts(2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- src/PickerInput/Selector/hooks/useInputProps.ts
✨ Finishing Touches
- [ ] 📝 Generate Docstrings
🧪 Generate Unit Tests
- [ ] Create PR with Unit Tests
- [ ] Post Copyable Unit Tests in Comment
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.
🪧 Tips
Chat
There are 3 ways to chat with CodeRabbit:
- Review comments: Directly reply to a review comment made by CodeRabbit. Example:
-
I pushed a fix in commit <commit_id>, please review it. -
Explain this complex logic. -
Open a follow-up GitHub issue for this discussion.
-
- Files and specific lines of code (under the "Files changed" tab): Tag
@coderabbitaiin a new review comment at the desired location with your query. Examples:-
@coderabbitai explain this code block. -
@coderabbitai modularize this function.
-
- PR comments: Tag
@coderabbitaiin a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:-
@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase. -
@coderabbitai read src/utils.ts and explain its main purpose. -
@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format. -
@coderabbitai help me debug CodeRabbit configuration file.
-
Support
Need help? Create a ticket on our support page for assistance with any issues or questions.
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.
CodeRabbit Commands (Invoked using PR comments)
-
@coderabbitai pauseto pause the reviews on a PR. -
@coderabbitai resumeto resume the paused reviews. -
@coderabbitai reviewto trigger an incremental review. This is useful when automatic reviews are disabled for the repository. -
@coderabbitai full reviewto do a full review from scratch and review all the files again. -
@coderabbitai summaryto regenerate the summary of the PR. -
@coderabbitai generate docstringsto generate docstrings for this PR. -
@coderabbitai generate sequence diagramto generate a sequence diagram of the changes in this PR. -
@coderabbitai auto-generate unit teststo generate unit tests for this PR. -
@coderabbitai resolveresolve all the CodeRabbit review comments. -
@coderabbitai configurationto show the current CodeRabbit configuration for the repository. -
@coderabbitai helpto get help.
Other keywords and placeholders
- Add
@coderabbitai ignoreanywhere in the PR description to prevent this PR from being reviewed. - Add
@coderabbitai summaryto generate the high-level summary at a specific location in the PR description. - Add
@coderabbitaianywhere in the PR title to generate the title automatically.
CodeRabbit Configuration File (.coderabbit.yaml)
- You can programmatically configure CodeRabbit by adding a
.coderabbit.yamlfile to the root of your repository. - Please see the configuration documentation for more information.
- If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation:
# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json
Documentation and Community
- Visit our Documentation for detailed information on how to use CodeRabbit.
- Join our Discord Community to get help, request features, and share feedback.
- Follow us on X/Twitter for updates and announcements.
Codecov Report
All modified and coverable lines are covered by tests :white_check_mark:
Project coverage is 98.80%. Comparing base (
d3dc263) to head (8209369).
Additional details and impacted files
@@ Coverage Diff @@
## master #932 +/- ##
=======================================
Coverage 98.80% 98.80%
=======================================
Files 65 65
Lines 2669 2670 +1
Branches 742 716 -26
=======================================
+ Hits 2637 2638 +1
Misses 29 29
Partials 3 3
:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.
:rocket: New features to boost your workflow:
- :snowflake: Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
- :package: JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.