feat(sender): header and prefix support getter #324

wzc520pyfm · 2025-05-22T14:01:21Z

About #240 .

Summary by CodeRabbit

New Features
- Enhanced flexibility for the header and prefix properties in the sender component, allowing them to accept either static content or functions that return content for more dynamic rendering.
Documentation
- Updated API documentation to reflect the expanded options for header and prefix properties.

netlify · 2025-05-22T14:01:26Z

✅ Deploy Preview for antd-design-x-vue ready!

Name	Link
🔨 Latest commit	`d2a1584`
🔍 Latest deploy log	https://app.netlify.com/projects/antd-design-x-vue/deploys/682f2e34ed10ae000897a23d
😎 Deploy Preview	https://deploy-preview-324--antd-design-x-vue.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

coderabbitai · 2025-05-22T14:01:29Z

Walkthrough

The changes expand the accepted types for the header and prefix properties in the SenderProps interface and related documentation. These properties now support both direct VNode values and functions returning VNode. The component logic is updated to handle both cases, allowing for more dynamic rendering.

Changes

File(s)	Change Summary
docs/component/sender.md	Updated API documentation to reflect that `header` and `prefix` accept `VNode` or `() => VNode`.
src/sender/interface.ts	Modified `SenderProps` interface: `header` and `prefix` now accept `VNode` or `() => VNode`.
src/sender/Sender.vue	Updated computed properties to invoke `header`/`prefix` if they are functions, else use as is.

Sequence Diagram(s)

sequenceDiagram
    participant Parent as Parent Component
    participant Sender as <Sender />
    note right of Sender: On render
    Parent->>Sender: Passes header/prefix as VNode or function
    Sender->>Sender: Checks if header/prefix is function
    alt Is function
        Sender->>Sender: Invoke function to get VNode
    else Is VNode
        Sender->>Sender: Use VNode directly
    end
    Sender-->>Parent: Renders with resolved header/prefix

Suggested labels

Sender

Poem

A tweak for the sender, so clever and neat,
Now headers and prefixes can’t be beat!
VNode or function, both are now fair,
Dynamic or static, just pass it with care.
🐇✨ The sender now hops with more flexible flair!

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/sender/interface.ts

Oops! Something went wrong! :(

ESLint: 8.57.1

Error: Failed to load parser 'vue-eslint-parser' declared in '.eslintrc.js': Cannot find module 'vue-eslint-parser'
Require stack:

/.eslintrc.js
at Module._resolveFilename (node:internal/modules/cjs/loader:1405:15)
at require.resolve (node:internal/modules/helpers:145:19)
at Object.resolve (/node_modules/.pnpm/@eslint [email protected]/node_modules/@eslint/eslintrc/dist/eslintrc.cjs:2346:46)
at ConfigArrayFactory._loadParser (/node_modules/.pnpm/@eslint [email protected]/node_modules/@eslint/eslintrc/dist/eslintrc.cjs:3325:39)
at ConfigArrayFactory._normalizeObjectConfigDataBody (/node_modules/.pnpm/@eslint [email protected]/node_modules/@eslint/eslintrc/dist/eslintrc.cjs:3099:43)
at _normalizeObjectConfigDataBody.next ()
at ConfigArrayFactory._normalizeObjectConfigData (/node_modules/.pnpm/@eslint [email protected]/node_modules/@eslint/eslintrc/dist/eslintrc.cjs:3040:20)
at _normalizeObjectConfigData.next ()
at ConfigArrayFactory.loadInDirectory (/node_modules/.pnpm/@eslint [email protected]/node_modules/@eslint/eslintrc/dist/eslintrc.cjs:2886:28)
at CascadingConfigArrayFactory._loadConfigInAncestors (/node_modules/.pnpm/@eslint [email protected]/node_modules/@eslint/eslintrc/dist/eslintrc.cjs:3871:46)

src/sender/Sender.vue

Oops! Something went wrong! :(

ESLint: 8.57.1

Error: Failed to load parser 'vue-eslint-parser' declared in '.eslintrc.js': Cannot find module 'vue-eslint-parser'
Require stack:

/.eslintrc.js
at Module._resolveFilename (node:internal/modules/cjs/loader:1405:15)
at require.resolve (node:internal/modules/helpers:145:19)
at Object.resolve (/node_modules/.pnpm/@eslint [email protected]/node_modules/@eslint/eslintrc/dist/eslintrc.cjs:2346:46)
at ConfigArrayFactory._loadParser (/node_modules/.pnpm/@eslint [email protected]/node_modules/@eslint/eslintrc/dist/eslintrc.cjs:3325:39)
at ConfigArrayFactory._normalizeObjectConfigDataBody (/node_modules/.pnpm/@eslint [email protected]/node_modules/@eslint/eslintrc/dist/eslintrc.cjs:3099:43)
at _normalizeObjectConfigDataBody.next ()
at ConfigArrayFactory._normalizeObjectConfigData (/node_modules/.pnpm/@eslint [email protected]/node_modules/@eslint/eslintrc/dist/eslintrc.cjs:3040:20)
at _normalizeObjectConfigData.next ()
at ConfigArrayFactory.loadInDirectory (/node_modules/.pnpm/@eslint [email protected]/node_modules/@eslint/eslintrc/dist/eslintrc.cjs:2886:28)
at CascadingConfigArrayFactory._loadConfigInAncestors (/node_modules/.pnpm/@eslint [email protected]/node_modules/@eslint/eslintrc/dist/eslintrc.cjs:3871:46)

Note

⚡️ AI Code Reviews for VS Code, Cursor, Windsurf

CodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback.
Learn more here.

Note

⚡️ Faster reviews with caching

CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 30th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.
Enjoy the performance boost—your workflow just got faster.

📜 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 84db98c and d2a1584.

📒 Files selected for processing (3)

docs/component/sender.md (1 hunks)
src/sender/Sender.vue (1 hunks)
src/sender/interface.ts (1 hunks)

🔇 Additional comments (6)

src/sender/interface.ts (2)

77-77: Support for function-returning VNode adds flexibility.

The type definition for prefix now accepts either a direct VNode or a function returning a VNode. This enhancement allows for dynamic content generation and lazy rendering.

79-79: Support for function-returning VNode adds flexibility.

Similar to the prefix property, the header property now accepts either a direct VNode or a function returning a VNode. This change provides greater flexibility for dynamic content generation.

docs/component/sender.md (2)

155-155: Documentation accurately reflects interface changes.

The API documentation for the header property has been updated to reflect that it now accepts either a VNode or a function returning a VNode, aligning with the interface changes.

156-156: Documentation accurately reflects interface changes.

The API documentation for the prefix property has been updated to reflect that it now accepts either a VNode or a function returning a VNode, aligning with the interface changes.

src/sender/Sender.vue (2)

308-308: Implementation handles both VNode and function types correctly.

The computed property now checks if header is a function, and if so, invokes it to get the VNode. This correctly implements the interface changes and maintains the slot fallback behavior.

315-315: Implementation handles both VNode and function types correctly.

The computed property now checks if prefix is a function, and if so, invokes it to get the VNode. This correctly implements the interface changes and maintains the slot fallback behavior.

✨ Finishing Touches

📝 Generate Docstrings

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.

❤️ Share

🪧 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 @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai explain this code block.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in 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 pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file 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.

feat(sender): header and prefix support getter

d2a1584

wzc520pyfm merged commit c85fde7 into main Jun 10, 2025
6 checks passed

wzc520pyfm deleted the feat/sender-prefix-and-header-support-getter branch June 10, 2025 03:41

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat(sender): header and prefix support getter #324

feat(sender): header and prefix support getter #324

Uh oh!

wzc520pyfm commented May 22, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

netlify bot commented May 22, 2025 •

edited

Loading

Uh oh!

coderabbitai bot commented May 22, 2025 •

edited

Loading

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

Uh oh!

Uh oh!

feat(sender): header and prefix support getter #324

feat(sender): header and prefix support getter #324

Uh oh!

Conversation

wzc520pyfm commented May 22, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

netlify bot commented May 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for antd-design-x-vue ready!

Uh oh!

coderabbitai bot commented May 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Suggested labels

Poem

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

Uh oh!

Uh oh!

wzc520pyfm commented May 22, 2025 •

edited by coderabbitai bot

Loading

netlify bot commented May 22, 2025 •

edited

Loading

coderabbitai bot commented May 22, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)