-
Notifications
You must be signed in to change notification settings - Fork 278
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
fix(pager): [pager] fix pager type error #2801
Conversation
…nge event when value change
WalkthroughThe pull request modifies the Changes
Possibly related PRs
Suggested reviewers
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
Walkthrough此PR修复了pager组件的类型声明错误,主要涉及对类型定义的调整和更新,以确保正确的类型推断和使用。 Changes
|
watchTotal, | ||
watchShowSizes | ||
watchShowSizes, | ||
watchInternalPageSize, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ensure that the new watchInternalPageSize
and getInternalPageSize
functions are correctly implemented and tested to prevent any runtime errors.
WalkthroughThis PR fixes the type declaration error of the pager component, mainly involving adjustments and updates to the type definition to ensure correct type inference and usage. Changes
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (1)
packages/renderless/types/pager.type.ts (1)
35-37
: Consider documenting the migration path.The shift from external to internal page size management is a significant architectural change. Consider:
- Adding migration documentation for users who might be using the removed methods.
- Updating component documentation to reflect the new internal page size management approach.
- Adding deprecation warnings if this change is planned for a future major version.
Also applies to: 96-97
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
packages/renderless/types/pager.type.ts
(2 hunks)
🔇 Additional comments (2)
packages/renderless/types/pager.type.ts (2)
96-97
: LGTM! Type definitions are correctly implemented.The new methods are properly typed using ReturnType for accurate type inference, maintaining type safety during the refactor.
35-37
: Verify the removal of page size watchers.The shift from external (
watchPageSizes
,watchPageSize
) to internal page size management (watchInternalPageSize
,getInternalPageSize
) might affect existing code that relies on the removed watchers.Let's verify the usage of removed methods in the codebase:
✅ Verification successful
Changes are safe to proceed
The removed page size watchers have no existing usage in the codebase, and the new internal page size management is properly implemented across all relevant files.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Search for any remaining usage of the removed methods echo "Searching for usage of removed methods..." rg "watchPageSizes|watchPageSize|watchInternalPageCount" --type ts # Search for potential migration to new methods echo "Searching for usage of new methods..." rg "watchInternalPageSize|getInternalPageSize" --type tsLength of output: 2030
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (2)
examples/sites/demos/pc/webdoc/import-components-en.md (1)
48-50
: LGTM! Consider enhancing the version information format.The paragraph formatting improves readability. The version information is clear and helpful.
Consider formatting the version number in a code tag for better visibility:
-<p>Warm reminder: Exporting components with Tiny prefix is supported since 3.17.0. If using previous versions, you need to use aliases.</p> +<p>Warm reminder: Exporting components with Tiny prefix is supported since <code>3.17.0</code>. If using previous versions, you need to use aliases.</p>examples/sites/demos/pc/webdoc/import-components.md (1)
136-138
: LGTM! Consider matching version number formatting with English version.The paragraph formatting improves readability and maintains consistency with the English documentation.
Consider formatting the version number in a code tag for better visibility and consistency with the English version:
-<p>温馨提示:带有 Tiny 前缀的组件导出自 3.17.0 开始支持。若使用之前版本,需使用别名。</p> +<p>温馨提示:带有 Tiny 前缀的组件导出自 <code>3.17.0</code> 开始支持。若使用之前版本,需使用别名。</p>
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
examples/sites/demos/pc/webdoc/import-components-en.md
(1 hunks)examples/sites/demos/pc/webdoc/import-components.md
(1 hunks)
PR
修复pager组件类型声明报错
PR Checklist
Please check if your PR fulfills the following requirements:
PR Type
What kind of change does this PR introduce?
What is the current behavior?
Issue Number: N/A
What is the new behavior?
Does this PR introduce a breaking change?
Other information
Summary by CodeRabbit