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: form component IconPicker #5005

Merged
merged 1 commit into from
Dec 4, 2024
Merged

Conversation

mynetfan
Copy link
Collaborator

@mynetfan mynetfan commented Dec 3, 2024

Description

将图标选择器抽离成与独立组件,并提供给form使用。 close #4999

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 the IconPicker component for enhanced icon selection across various applications.
    • Added IconPicker as a new field in the form schema, allowing users to select icons during form submissions.
    • Enhanced documentation for the Vben Form component to include details about the IconPicker.
    • Improved the IconPicker functionality with search capabilities and dynamic icon list management.
  • Bug Fixes

    • Improved error handling in the IconPicker component for better user experience.
  • Documentation

    • Updated documentation to clarify usage and integration of the IconPicker component with examples.
  • Chores

    • Added localized text for the IconPicker in both English and Chinese.

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

changeset-bot bot commented Dec 3, 2024

⚠️ No Changeset found

Latest commit: 9116aa3

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

Caution

Review failed

The pull request is closed.

Walkthrough

The changes in this pull request introduce the IconPicker component from the @vben/common-ui package across multiple files in the project. This component has been integrated into the component registration process, allowing it to be utilized within various applications and forms. Additionally, documentation has been updated to reflect these changes, and localization support for the IconPicker has been added in both English and Chinese. The overall functionality and structure of existing components remain unchanged, with the new component enhancing the available options for users.

Changes

File Path Change Summary
apps/web-antd/src/adapter/component/index.ts Added IconPicker import and included it in ComponentType and components object.
apps/web-ele/src/adapter/component/index.ts Added IconPicker import and included it in ComponentType and components object.
apps/web-naive/src/adapter/component/index.ts Added IconPicker import and included it in ComponentType and components object.
docs/src/components/common-ui/vben-form.md Updated documentation to include IconPicker details and examples.
packages/effects/common-ui/src/components/icon-picker/icon-picker.vue Enhanced functionality, added prefix prop, and introduced search capabilities.
packages/locales/src/langs/en-US/ui.json Added new section for iconPicker with English labels.
packages/locales/src/langs/zh-CN/ui.json Added new section for iconPicker with Chinese labels.
playground/src/adapter/component/index.ts Added IconPicker import and included it in ComponentType and components object.
playground/src/views/demos/features/icons/icon-picker.vue Deleted file containing the old IconPicker component implementation.
playground/src/views/demos/features/icons/icons.data.ts Deleted file containing icon data export.
playground/src/views/demos/features/icons/index.vue Updated to use multiple instances of IconPicker with improved layout and functionality.
playground/src/views/examples/form/basic.vue Added IconPicker as a new form field labeled '图标'.

Assessment against linked issues

Objective Addressed Explanation
Integrate IconPicker component into forms (#4999)

Possibly related issues

Possibly related PRs

  • feat: add icon-picker component #4832: The addition of the IconPicker component in the main PR is directly related to the updates made in the retrieved PRs, which also include the integration of the IconPicker component across multiple files, enhancing its registration and usage within forms.
  • feat: form component IconPicker #5005: This PR focuses on the integration of the IconPicker component into the index.ts files of various applications, aligning with the main PR's changes that introduce the IconPicker component into the global component state.
  • fix: resolve onChange issue in form component #4890: The changes in the form-field.vue file regarding event handling and the onChange issue are relevant as they enhance the form's interactivity, which is a key aspect of the IconPicker component's functionality.
  • fix(@vben/common-ui): pagination current page error #4893: The updates to the icon-picker.vue component, particularly regarding pagination and current page management, are related to the main PR's introduction of the IconPicker, as they both enhance user interaction with icons.
  • docs: add form slots docs #4992: The documentation updates regarding the use of slots in forms are relevant as they provide context for how the IconPicker can be utilized within forms, which is a focus of the main PR.

Suggested reviewers

  • vince292007

🐰 "In a garden where icons bloom,
An IconPicker dispels the gloom.
With choices galore, let’s take a pick,
For every form, a perfect click!
A hop, a skip, a joyful cheer,
Icons await, let’s draw them near!" 🐇

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-antd/src/adapter/component/index.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)


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 24b9aa4 and 9116aa3.

📒 Files selected for processing (12)
  • apps/web-antd/src/adapter/component/index.ts (3 hunks)
  • apps/web-ele/src/adapter/component/index.ts (3 hunks)
  • apps/web-naive/src/adapter/component/index.ts (3 hunks)
  • docs/src/components/common-ui/vben-form.md (3 hunks)
  • packages/effects/common-ui/src/components/icon-picker/icon-picker.vue (2 hunks)
  • packages/locales/src/langs/en-US/ui.json (1 hunks)
  • packages/locales/src/langs/zh-CN/ui.json (1 hunks)
  • playground/src/adapter/component/index.ts (3 hunks)
  • playground/src/views/demos/features/icons/icon-picker.vue (0 hunks)
  • playground/src/views/demos/features/icons/icons.data.ts (0 hunks)
  • playground/src/views/demos/features/icons/index.vue (3 hunks)
  • playground/src/views/examples/form/basic.vue (1 hunks)

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.

@mynetfan mynetfan closed this Dec 3, 2024
@mynetfan mynetfan deleted the feat/form-icon-picker branch December 3, 2024 02:13
@mynetfan mynetfan restored the feat/form-icon-picker branch December 3, 2024 02:13
@mynetfan mynetfan reopened this Dec 3, 2024
@mynetfan mynetfan closed this Dec 3, 2024
@mynetfan mynetfan reopened this Dec 3, 2024
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.

FEATURE: 如何在表单中使用icon-picker组件
2 participants