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: v-loading support for element plus #5008

Merged
merged 1 commit into from
Dec 4, 2024

Conversation

mynetfan
Copy link
Collaborator

@mynetfan mynetfan commented Dec 3, 2024

Description

将element-plus提供的v-loading指令注册为可用。

对element-plus不太熟悉的同学可能在没有完整引入的情况下难以使用这个指令,此PR将此常用指令手动注册以达到开箱即用的结果。

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

    • Introduced a loading directive (v-loading) for enhanced user feedback during loading processes.
    • Added a new loading demonstration card labeled "V-Loading."
  • Improvements

    • Updated the layout of demo cards to a responsive flexbox model for better visual alignment and spacing.
  • Bug Fixes

    • Maintained existing functionality and error handling logic while improving the presentation.

@mynetfan mynetfan requested review from anncwb, vince292007 and a team as code owners December 3, 2024 07:43
Copy link

changeset-bot bot commented Dec 3, 2024

⚠️ No Changeset found

Latest commit: 67e7f81

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

Copy link
Contributor

coderabbitai bot commented Dec 3, 2024

Walkthrough

The pull request introduces changes to two main files: bootstrap.ts and index.vue. In bootstrap.ts, an import statement for ElLoading is added, and the v-loading directive is registered with the Vue application instance. In index.vue, the template structure is modified to use a flexbox layout for better responsiveness, and a new ElCard for loading demonstration is added, utilizing the v-loading directive. The overall functionality of the components remains unchanged.

Changes

File Change Summary
apps/web-ele/src/bootstrap.ts Added import for ElLoading and registered v-loading directive with the Vue app instance.
apps/web-ele/src/views/demos/element/index.vue Replaced vertical stack of ElCard components with a flexbox layout; added a new ElCard for loading demonstration with v-loading directive.

Possibly related PRs

  • chore: update modal.vue #4987: The changes in modal.vue involve handling loading states, which is conceptually related to the addition of the v-loading directive in bootstrap.ts for managing loading indicators in the application.

Suggested reviewers

  • anncwb
  • vince292007

🐰 In the code where we play,
A loading state brightens the day.
With cards in a flex, oh what a sight,
Responsive and neat, everything feels right!
So hop along, let’s code and cheer,
For changes that bring us joy, oh dear! 🐇

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.

apps/web-ele/src/bootstrap.ts

Oops! Something went wrong! :(

ESLint: 9.16.0

Error [ERR_MODULE_NOT_FOUND]: Cannot find module '/node_modules/@vben/eslint-config/dist/index.mjs' imported from /eslint.config.mjs
at finalizeResolution (node:internal/modules/esm/resolve:257:11)
at moduleResolve (node:internal/modules/esm/resolve:914:10)
at defaultResolve (node:internal/modules/esm/resolve:1038:11)
at ModuleLoader.defaultResolve (node:internal/modules/esm/loader:557:12)
at ModuleLoader.resolve (node:internal/modules/esm/loader:525:25)
at ModuleLoader.getModuleJob (node:internal/modules/esm/loader:246:38)
at ModuleJob._link (node:internal/modules/esm/module_job:126:49)


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 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.

Copy link
Contributor

@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: 0

🧹 Outside diff range and nitpick comments (2)
apps/web-ele/src/bootstrap.ts (1)

23-24: Consider translating the Chinese comment for better accessibility.

The directive registration is implemented correctly, but consider translating the comment "注册Element Plus提供的v-loading指令" to English for better international collaboration.

-  // 注册Element Plus提供的v-loading指令
+  // Register v-loading directive provided by Element Plus
apps/web-ele/src/views/demos/element/index.vue (1)

103-108: Enhance the loading demo with interactive controls.

The current implementation has the loading state hardcoded to true. Consider adding:

  1. A toggle button to demonstrate dynamic loading states
  2. Error state handling
  3. Loading text customization example

Here's a suggested implementation:

-        <div class="flex size-72 items-center justify-center" v-loading="true">
+        <div class="flex size-72 items-center justify-center" v-loading="isLoading" element-loading-text="Loading...">
           一些演示的内容
         </div>
+        <div class="mt-4">
+          <ElButton @click="isLoading = !isLoading">
+            {{ isLoading ? 'Stop Loading' : 'Start Loading' }}
+          </ElButton>
+        </div>

Add to the script section:

const isLoading = ref(false);
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 24b9aa4 and 67e7f81.

📒 Files selected for processing (2)
  • apps/web-ele/src/bootstrap.ts (2 hunks)
  • apps/web-ele/src/views/demos/element/index.vue (1 hunks)
🔇 Additional comments (2)
apps/web-ele/src/bootstrap.ts (1)

10-10: LGTM! Efficient import strategy.

The named import of ElLoading is well-structured and supports tree-shaking, aligning with the goal of minimal imports.

apps/web-ele/src/views/demos/element/index.vue (1)

64-102: LGTM! Well-structured responsive layout.

The flex layout implementation with consistent utility classes provides good responsiveness and maintainability.

@anncwb anncwb merged commit fccbe44 into vbenjs:main Dec 4, 2024
14 checks passed
@anncwb anncwb added the feature label Dec 4, 2024
@mynetfan mynetfan deleted the feat/v-loading-ele branch December 5, 2024 04:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants