Skip to content

refactor: new CountTo component with demo - #5551

Merged
mynetfan merged 1 commit into
vbenjs:mainfrom
mynetfan:feat/count-to
Feb 17, 2025
Merged

mynetfan merged 1 commit into
vbenjs:mainfrom
mynetfan:feat/count-to

Conversation

@mynetfan

@mynetfan mynetfan commented Feb 17, 2025 •

Copy link
Copy Markdown
Collaborator

Description

重构CountTo数字动画组件。出于向下兼容的原因,之前的VbenCountToAnimator组件仍然保留

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update
  • Please, don't make changes to pnpm-lock.yaml unless you introduce a new test example.

Checklist

ℹ️ Check all checkboxes - this will indicate that you have done everything in accordance with the rules in CONTRIBUTING.

  • If you introduce new functionality, document it. You can run documentation with pnpm run docs:dev command.
  • Run the tests with pnpm test.
  • Changes in changelog are generated from PR name. Please, make sure that it explains your changes in an understandable manner. Please, prefix changeset messages with feat:, fix:, perf:, docs:, or chore:.
  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

Summary by CodeRabbit

  • New Features
    • Added a dynamic counting animation component with customizable properties like start value, duration, and formatting options.
    • Introduced visual cues indicating the start and finish of the animation.
    • Launched an interactive demo page, enabling users to test and adjust the animated counting experience via a dedicated route.

@changeset-bot

changeset-bot Bot commented Feb 17, 2025

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: c13cc2d

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@mynetfan
mynetfan merged commit 24bad09 into vbenjs:main Feb 17, 2025
@mynetfan
mynetfan deleted the feat/count-to branch February 17, 2025 13:16
@coderabbitai

coderabbitai Bot commented Feb 17, 2025 •

Copy link
Copy Markdown
Contributor

Caution

Review failed

The pull request is closed.

Walkthrough

This pull request introduces a new Vue component called CountTo for numeric animations. The component is built with TypeScript and the Composition API, and it uses configurable properties and computed values for animated counting. New type definitions and exports are added in related files to ensure type safety and ease of use. Additionally, an example page and corresponding route have been added to the playground for interactive demonstration of the CountTo component.

Changes

File(s) Change Summary
packages/effects/.../count-to/count-to.vue
packages/effects/.../count-to/index.ts
packages/effects/.../count-to/types.ts
Introduces the CountTo component with TypeScript, Composition API, animations, configurable props (startVal, duration, etc.), emitted events (started, finished), and related type definitions.
packages/effects/.../components/index.ts Re-exports all entities from the count-to module for centralized access.
playground/src/router/.../examples.ts Adds a new route entry for the CountTo example with proper meta information (icon and title).
playground/src/views/examples/count-to/index.vue Provides a new example page demonstrating the CountTo component with interactive controls and dynamic animation features.

Sequence Diagram(s)

sequenceDiagram
    participant EV as ExampleView
    participant CT as CountTo Component
    EV->>CT: Mount with props (startVal, endVal, duration, etc.)
    CT->>CT: Initialize state and set up watcher for prop changes
    EV->>CT: Trigger changeNumber (updates endVal)
    CT->>EV: Emit "started" event
    CT->>CT: Execute counting animation with transition effects
    CT->>EV: Emit "finished" event
Loading

Suggested labels

feature

Suggested reviewers

  • anncwb
  • vince292007

Poem

I'm a rabbit, hopping with glee,
Coding new paths, as swift as can be.
CountTo leaps into animation so bright,
With properties set just right.
A joyful hop for each line of code! 🐇✨


📜 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 cddf71e and c13cc2d.

📒 Files selected for processing (6)
  • packages/effects/common-ui/src/components/count-to/count-to.vue (1 hunks)
  • packages/effects/common-ui/src/components/count-to/index.ts (1 hunks)
  • packages/effects/common-ui/src/components/count-to/types.ts (1 hunks)
  • packages/effects/common-ui/src/components/index.ts (1 hunks)
  • playground/src/router/routes/modules/examples.ts (1 hunks)
  • playground/src/views/examples/count-to/index.vue (1 hunks)
✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

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?

❤️ 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.
    • Generate unit testing code for this file.
    • 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 generate unit testing code for this file.
    • @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 generate unit testing code.
    • @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.

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. (Beta)
  • @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.

Syxi added a commit to Syxi/vue-vben-admin that referenced this pull request Feb 18, 2025
@github-actions github-actions Bot locked and limited conversation to collaborators Mar 20, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant