Skip to content

feat(calendar-view): [calendar-view]add attributes #3525

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 1 commit into from
Jun 23, 2025
Merged

Conversation

James-9696
Copy link
Collaborator

@James-9696 James-9696 commented Jun 20, 2025

PR

PR Checklist

Please check if your PR fulfills the following requirements:

  • The commit message follows our Commit Message Guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Documentation content changes
  • Other... Please describe:

What is the current behavior?

Issue Number: N/A

What is the new behavior?

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

Summary by CodeRabbit

  • New Features

    • Added a new option to control the visibility of the "Back Today" button in the calendar view component.
  • Bug Fixes

    • The "Back Today" button now only appears when explicitly enabled, improving customization.
  • Documentation

    • Updated API documentation to reflect new configuration options and supported modes for the calendar view component.
  • Tests

    • Enhanced tests to verify the correct rendering and visibility of the "Back Today" button.

Copy link

coderabbitai bot commented Jun 20, 2025

Walkthrough

The changes introduce a new boolean prop, showBackToday, to the calendar view component, allowing conditional rendering of the "Back Today" button. Documentation and demo files are updated to reflect this prop, including its metadata, supported modes, and usage in demos. Related tests are adjusted to verify the button's presence or absence.

Changes

Files Change Summary
packages/vue/src/calendar-view/src/pc.vue Added showBackToday prop; conditionally renders "Back Today" button; minor template formatting changes.
examples/sites/demos/pc/app/calendar-view/calendar-mode.vue,
...composition-api.vue
Added show-back-today="false" prop to <tiny-calendar-view> in both demo templates.
examples/sites/demos/apis/calendar-view.js Updated API docs: show-back-today stable version, supported modes, and added pcDemo reference.
examples/sites/demos/pc/app/calendar-view/calendar-mode.spec.ts Added test to assert absence of "Back Today" button when show-back-today is false.

Poem

A button for "Back Today" now listens to you,
Show it or hide it—just set the prop true or untrue!
Docs and demos in sync, tests keep the way,
The calendar hops forward, in a rabbit-bright day.
🗓️✨

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.

examples/sites/demos/apis/calendar-view.js

Oops! Something went wrong! :(

ESLint: 8.57.1

ESLint couldn't find the plugin "eslint-plugin-vue".

(The package "eslint-plugin-vue" was not found when loaded as a Node module from the directory "".)

It's likely that the plugin isn't installed correctly. Try reinstalling by running the following:

npm install eslint-plugin-vue@latest --save-dev

The plugin "eslint-plugin-vue" was referenced from the config file in ".eslintrc.js » @antfu/eslint-config » @antfu/eslint-config-vue".

If you still can't figure out the problem, please stop by https://eslint.org/chat/help to chat with the team.

examples/sites/demos/pc/app/calendar-view/calendar-mode-composition-api.vue

Oops! Something went wrong! :(

ESLint: 8.57.1

ESLint couldn't find the plugin "eslint-plugin-vue".

(The package "eslint-plugin-vue" was not found when loaded as a Node module from the directory "".)

It's likely that the plugin isn't installed correctly. Try reinstalling by running the following:

npm install eslint-plugin-vue@latest --save-dev

The plugin "eslint-plugin-vue" was referenced from the config file in ".eslintrc.js » @antfu/eslint-config » @antfu/eslint-config-vue".

If you still can't figure out the problem, please stop by https://eslint.org/chat/help to chat with the team.

examples/sites/demos/pc/app/calendar-view/calendar-mode.spec.ts

Oops! Something went wrong! :(

ESLint: 8.57.1

ESLint couldn't find the plugin "eslint-plugin-vue".

(The package "eslint-plugin-vue" was not found when loaded as a Node module from the directory "".)

It's likely that the plugin isn't installed correctly. Try reinstalling by running the following:

npm install eslint-plugin-vue@latest --save-dev

The plugin "eslint-plugin-vue" was referenced from the config file in ".eslintrc.js » @antfu/eslint-config » @antfu/eslint-config-vue".

If you still can't figure out the problem, please stop by https://eslint.org/chat/help to chat with the team.

  • 2 others
✨ 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.

@github-actions github-actions bot added the enhancement New feature or request (功能增强) label Jun 20, 2025
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Nitpick comments (2)
packages/vue/src/calendar-view/src/pc.vue (1)

126-130: Consider avoiding unnecessary formatting changes.

The formatting changes to the week-day span element don't add functional value and make the diff noisy. Consider keeping such formatting changes in separate commits.

examples/sites/demos/apis/calendar-view.js (1)

198-202: Documentation updates look good, but consider demo consistency.

The API documentation correctly reflects the expanded support for PC mode and updated version. However, there's a potential inconsistency: the defaultValue is documented as 'true', but both demos explicitly set it to false. Consider whether the demos should demonstrate the default behavior (true) or if the default value documentation needs clarification.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d0959c6 and a833951.

📒 Files selected for processing (5)
  • examples/sites/demos/apis/calendar-view.js (1 hunks)
  • examples/sites/demos/pc/app/calendar-view/calendar-mode-composition-api.vue (1 hunks)
  • examples/sites/demos/pc/app/calendar-view/calendar-mode.spec.ts (1 hunks)
  • examples/sites/demos/pc/app/calendar-view/calendar-mode.vue (1 hunks)
  • packages/vue/src/calendar-view/src/pc.vue (3 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: PR E2E Test (pnpm test:e2e3)
🔇 Additional comments (4)
packages/vue/src/calendar-view/src/pc.vue (2)

5-5: LGTM! Conditional rendering implemented correctly.

The v-if="showBackToday" directive properly controls the visibility of the "Back Today" button based on the new prop.


290-290: LGTM! Prop properly added to the props array.

The showBackToday prop is correctly added to the component's props list.

examples/sites/demos/pc/app/calendar-view/calendar-mode-composition-api.vue (1)

7-7: LGTM! Demo properly uses the new prop.

The demo correctly demonstrates the show-back-today prop by explicitly setting it to false.

examples/sites/demos/pc/app/calendar-view/calendar-mode.vue (1)

7-7: LGTM! Consistent usage across demos.

The demo properly demonstrates the show-back-today prop, maintaining consistency with the composition API demo.

@@ -9,6 +9,9 @@ test('显示模式', async ({ page }) => {
const dmonthDom = page.locator('.tiny-calendar-view-month__main')
const timelineDom = page.locator('.tiny-calendar-view-week__timeline')
const scheduleDom = page.locator('.tiny-calendar-view-week__schedule')

const calendarHeader = page.locator('.tiny-calendar-view__header')
await expect(calendarHeader.locator('div').first()).not.toHaveClass('.tiny-button .tiny-button--default')
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue

Fix the CSS selector syntax in the test assertion.

The selector .tiny-button .tiny-button--default uses descendant selector syntax (space-separated), but you likely want to check that the element doesn't have both classes. Consider using .tiny-button.tiny-button--default (dot-separated) or check for individual classes separately.

-  await expect(calendarHeader.locator('div').first()).not.toHaveClass('.tiny-button .tiny-button--default')
+  await expect(calendarHeader.locator('div').first()).not.toHaveClass(/tiny-button/)
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
await expect(calendarHeader.locator('div').first()).not.toHaveClass('.tiny-button .tiny-button--default')
await expect(calendarHeader.locator('div').first()).not.toHaveClass(/tiny-button/)
🤖 Prompt for AI Agents
In examples/sites/demos/pc/app/calendar-view/calendar-mode.spec.ts at line 14,
the CSS selector in the test assertion incorrectly uses a descendant selector
'.tiny-button .tiny-button--default' to check for classes on a single element.
Replace the selector with '.tiny-button.tiny-button--default' to correctly check
that the element does not have both classes simultaneously.

@zzcr zzcr merged commit 40e69c4 into dev Jun 23, 2025
10 of 11 checks passed
@zzcr zzcr deleted the fix-calendar-view-pc branch June 23, 2025 01:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request (功能增强)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants