Skip to content
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

feat(Typed): add Typed component #5291

Merged
merged 13 commits into from
Feb 3, 2025
Merged

feat(Typed): add Typed component #5291

merged 13 commits into from
Feb 3, 2025

Conversation

ArgoZhang
Copy link
Collaborator

@ArgoZhang ArgoZhang commented Feb 3, 2025

add Typed component

Summary of the changes (Less than 80 chars)

简单描述你更改了什么, 不超过80个字符;如果有关联 Issue 请在下方填写相关编号

Description

fixes #5290

Regression?

  • Yes
  • No

[If yes, specify the version the behavior has regressed from]

[是否影响老版本]

Risk

  • High
  • Medium
  • Low

[Justify the selection above]

Verification

  • Manual (required)
  • Automated

Packaging changes reviewed?

  • Yes
  • No
  • N/A

☑️ Self Check before Merge

⚠️ Please check all items below before review. ⚠️

  • Doc is updated/provided or not needed
  • Demo is updated/provided or not needed
  • Merge the latest code from the main branch

Summary by Sourcery

New Features:

  • Introduce a new component that provides a typewriter effect for displaying text.

Copy link

sourcery-ai bot commented Feb 3, 2025

Reviewer's Guide by Sourcery

This pull request introduces a new Typed component that provides a text typing animation effect. The component is implemented using the Typed.js library and includes options for customizing the animation.

Sequence diagram for Typed component initialization and update

sequenceDiagram
    participant C as Component
    participant JS as JavaScript
    participant T as Typed.js

    C->>JS: init(id, invoke, text, options, callbacks)
    JS->>T: new Typed(element, options)
    T-->>JS: typed instance
    JS-->>C: store instance

    Note over C,T: When parameters update
    C->>JS: update(id, text, options)
    JS->>T: destroy()
    JS->>T: new Typed(element, newOptions)
    T-->>JS: new typed instance
    JS-->>C: store new instance
Loading

File-Level Changes

Change Details Files
Added a new Typed component.
  • Created Typed.razor.cs to handle component logic.
  • Created TypedOptions.cs to manage component options.
  • Created Typed.razor.js for JavaScript interop.
  • Created Typed.razor for the component's UI.
src/BootstrapBlazor/Components/Typed/Typed.razor.cs
src/BootstrapBlazor/Components/Typed/TypedOptions.cs
src/BootstrapBlazor/Components/Typed/Typed.razor.js
src/BootstrapBlazor/Components/Typed/Typed.razor
Added a sample page for the Typed component.
  • Created Typeds.razor.cs to manage the sample page logic.
  • Created Typeds.razor for the sample page UI.
src/BootstrapBlazor.Server/Components/Samples/Typeds.razor.cs
src/BootstrapBlazor.Server/Components/Samples/Typeds.razor
Added unit tests for the Typed component.
  • Created TypedTest.cs to verify the component's functionality.
test/UnitTest/Components/TypedTest.cs
Updated the menu to include the new Typed component.
  • Added a new menu item for the Typed component.
src/BootstrapBlazor.Server/Extensions/MenusLocalizerExtensions.cs
Added localization for the new component.
  • Added English localization for the Typed component.
  • Added Chinese localization for the Typed component.
src/BootstrapBlazor.Server/Locales/en-US.json
src/BootstrapBlazor.Server/Locales/zh-CN.json
Added documentation for the new component.
  • Added documentation for the Typed component.
src/BootstrapBlazor.Server/docs.json
Added the Typed.js library.
  • Added the Typed.js library to the project.
src/BootstrapBlazor/wwwroot/lib/typedjs/typed.module.js

Assessment against linked issues

Issue Objective Addressed Explanation
#5290 Add Typed component to the BootstrapBlazor library
#5290 Implement TypedJs functionality with configurable options
#5290 Provide documentation and sample usage for the Typed component

Possibly linked issues


Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@bb-auto bb-auto bot added the enhancement New feature or request label Feb 3, 2025
@bb-auto bb-auto bot added this to the v9.3.0 milestone Feb 3, 2025
sourcery-ai[bot]
sourcery-ai bot previously approved these changes Feb 3, 2025
Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @ArgoZhang - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟡 General issues: 2 issues found
  • 🟢 Security: all looks good
  • 🟡 Testing: 2 issues found
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Copy link

codecov bot commented Feb 3, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (9079726) to head (b9ef7f0).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #5291   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          640       642    +2     
  Lines        28791     28846   +55     
  Branches      4092      4100    +8     
=========================================
+ Hits         28791     28846   +55     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@ArgoZhang ArgoZhang merged commit a2756ed into main Feb 3, 2025
5 checks passed
@ArgoZhang ArgoZhang deleted the feat-typed-js branch February 3, 2025 16:38
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.

feat(Typed): add Typed component
1 participant