286 add plugin-image-module

[cycleccc]

Changes Overview

Implementation Approach

Testing Done

Verification Steps

Additional Notes

Checklist

• I have created a changeset for this PR if necessary.
• My changes do not break the library.
• I have added tests where applicable.
• I have followed the project guidelines.
• I have fixed any lint issues.

Related Issues

Summary by CodeRabbit

Release Notes

• New Features

  • Introduced the @wangeditor-next/plugin-float-image package, enabling floating image functionality in the editor.
  • Added multilingual support for floating image options in English and Simplified Chinese.
  • Implemented functionality for rendering and resizing images within the editor.

• Enhancements

  • New CSS styles for image link cards.
  • Improved handling of image elements, including inline and void characteristics.

• Bug Fixes

  • Enhanced error handling for image rendering and resizing.

• Documentation

  • Added type definitions and constants for image elements and their styles.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 21e3113

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.

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

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

This pull request introduces the @wangeditor-next/plugin-float-image package, which includes a new package.json file detailing the package's metadata and dependencies. It also adds a Rollup configuration for building the plugin in multiple formats. New CSS styles, TypeScript types, and utility functions for image handling are defined. Additionally, the plugin implements functionality for floating images within a text editor, including multilingual support and various menu options for image positioning. The changes encapsulate the complete setup for managing floating images in the editor.

Changes

File	Change Summary
packages/plugin-float-image/package.json	New package declaration for @wangeditor-next/plugin-float-image, including metadata, peer dependencies, and configuration for exports and publishing.
packages/plugin-float-image/rollup.config.js	New Rollup configuration defining output formats for ESM and UMD for the plugin.
packages/plugin-float-image/src/asserts/index.less	New CSS styles for link card components related to floating images.
packages/plugin-float-image/src/constants/icon-svg.ts	New TypeScript file defining SVG constants for floating image icons.
packages/plugin-float-image/src/index.ts	New entry point file importing styles and modules, re-exporting custom types.
packages/plugin-float-image/src/module/custom-types.ts	New TypeScript types for image elements, including EmptyText, ImageStyle, and ImageElement.
packages/plugin-float-image/src/module/elem-to-html.ts	New function imageToHtml for converting ImageElement to HTML <img> tags, with a configuration object for parsing.
packages/plugin-float-image/src/module/index.ts	New module entry point encapsulating configurations for rendering and managing floating images.
packages/plugin-float-image/src/module/local.ts	Multilingual support for floating image options added, with English and Simplified Chinese translations.
packages/plugin-float-image/src/module/menu/FloatBase.ts	New abstract class ImageFloatBaseClass for creating button menus related to floating images.
packages/plugin-float-image/src/module/menu/FloatLeft.ts	New class FloatLeft for handling left floating images.
packages/plugin-float-image/src/module/menu/FloatNone.ts	New class FloatNone for handling images with no float.
packages/plugin-float-image/src/module/menu/FloatRight.ts	New class FloatRight for handling right floating images.
packages/plugin-float-image/src/module/menu/index.ts	New module exporting configurations for image floating options in the menu.
packages/plugin-float-image/src/module/parse-elem-html.ts	New function parseHtml for parsing HTML elements into ImageElement objects, with a configuration object for parsing.
packages/plugin-float-image/src/module/plugin.ts	New plugin file overriding IDomEditor methods to handle image elements as inline and void elements.
packages/plugin-float-image/src/module/render-elem.tsx	New functions for rendering and resizing image elements within the editor.
packages/plugin-float-image/src/utils/dom.ts	New utility functions for DOM manipulation using the dom7 library, including type definitions for DOM elements.
packages/plugin-float-image/tsconfig.json	New TypeScript configuration file extending base settings and including source files.

Possibly related PRs

• feat(table module): add table property setting #71: Enhances hover bar functionality related to table properties, indirectly relating to overall editor element handling.
• 253 图片无法回显行内元素包含行内元素无法解析 #283: Addresses rendering issues with inline elements within images, directly relevant to the new floating image plugin.

🐰 In the garden, images float,
With styles and icons, they happily gloat.
Left, right, or none, they take their place,
In the editor's embrace, they find their grace.
A plugin for all, with colors so bright,
Come join the fun, let your images take flight! 🌼✨

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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