Skip to content

fix: do not allow dragging if gallery has max images #1479

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

im-adithya
Copy link

@im-adithya im-adithya commented Mar 16, 2025

Fixes TryGhost/Ghost#22054

The problem is that we neither disable dragging nor check for maxImages in onDrop. I thought of showing an error message as per @9larsons' comment but I noticed that if we populate a gallery from the start with 9 images and then try to drag an image inside, it doesn't even show the green line which imo is good feedback to the user. So I did the same here to not show the green line anymore once gallery hits 9 images (rather than showing the green line first and then showing an error message which feels like a bad UX)

Edit: I first disabled drag for all cases when images.length === maxImages but that also stops reordering, fixed it now!

Copy link

coderabbitai bot commented Mar 16, 2025

Walkthrough

The pull request modifies the gallery reordering functionality by updating the parameter order of the useGalleryReorder hook. The parameter maxImages is now required as the third argument rather than having a default value, meaning callers must explicitly provide it. Additionally, the onDragStart function has been altered to include a new variable isInternal to determine if the dragged element is within the container, enabling dragging only if the number of images is less than maxImages or if the drag is internal. In the GalleryNodeComponent, the hook now receives the maximum image count from a constant (MAX_IMAGES), and the error message has been updated to dynamically reference this constant instead of a hardcoded value. These changes ensure that the gallery editor consistently enforces the image limit both during dragging and when displaying error messages.

Assessment against linked issues

Objective Addressed Explanation
Enforce gallery image count limit during drag-and-drop and file selection (#22054)
Update error message to dynamically reflect the maximum image count configured (#22054)

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.

packages/koenig-lexical/src/hooks/useGalleryReorder.js

Oops! Something went wrong! :(

ESLint: 8.57.0

ESLint couldn't find the config "react-app" to extend from. Please check that the name of the config is correct.

The config "react-app" was referenced from the config file in "/packages/koenig-lexical/.eslintrc.cjs".

If you still have problems, please stop by https://eslint.org/chat/help to chat with the team.

packages/koenig-lexical/src/nodes/GalleryNodeComponent.jsx

Oops! Something went wrong! :(

ESLint: 8.57.0

ESLint couldn't find the config "react-app" to extend from. Please check that the name of the config is correct.

The config "react-app" was referenced from the config file in "/packages/koenig-lexical/.eslintrc.cjs".

If you still have problems, please stop by https://eslint.org/chat/help to chat with the team.

Tip

⚡🧪 Multi-step agentic review comment chat (experimental)
  • We're introducing multi-step agentic chat in review comments. This experimental feature enhances review discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments.
    - To enable this feature, set early_access to true under in the settings.
✨ Finishing Touches
  • 📝 Generate Docstrings

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

@im-adithya im-adithya force-pushed the fix/gallery-max-images branch from 3220653 to d13e164 Compare March 16, 2025 09:37
Copy link

@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

🧹 Nitpick comments (2)
packages/koenig-lexical/src/hooks/useGalleryReorder.js (2)

6-6: Parameter order change looks good, but consider using a different pattern

The parameter reordering ensures callers must explicitly provide maxImages now. This helps enforce the gallery's image limit consistently. However, changing the order of parameters in established APIs can be risky if all call sites aren't updated.

As an alternative pattern, you could consider keeping the parameter order but making it required:

-export default function useGalleryReorder({images, updateImages, maxImages, isSelected = false, disabled = false}) {
+export default function useGalleryReorder({images, updateImages, isSelected = false, disabled = false, maxImages}) {

Or use early validation:

if (maxImages === undefined) {
  throw new Error('maxImages is required for useGalleryReorder');
}

20-20: Use optional chaining to prevent potential null reference

There's a potential null reference error if containerRef is null when checking containerRef.contains().

-        const isInternal = containerRef && containerRef.contains(draggableInfo.element);
+        const isInternal = containerRef?.contains(draggableInfo.element);
🧰 Tools
🪛 Biome (1.9.4)

[error] 20-20: Change to an optional chain.

Unsafe fix: Change to an optional chain.

(lint/complexity/useOptionalChain)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3220653 and d13e164.

📒 Files selected for processing (2)
  • packages/koenig-lexical/src/hooks/useGalleryReorder.js (2 hunks)
  • packages/koenig-lexical/src/nodes/GalleryNodeComponent.jsx (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • packages/koenig-lexical/src/nodes/GalleryNodeComponent.jsx
🧰 Additional context used
🪛 Biome (1.9.4)
packages/koenig-lexical/src/hooks/useGalleryReorder.js

[error] 20-20: Change to an optional chain.

Unsafe fix: Change to an optional chain.

(lint/complexity/useOptionalChain)

🔇 Additional comments (1)
packages/koenig-lexical/src/hooks/useGalleryReorder.js (1)

17-25: Good improvement to gallery drag behavior

This change successfully prevents the green drop indicator from appearing when the gallery is full, which was the main goal of issue #22054. The logic now correctly allows dragging only when:

  1. There's still room for more images OR
  2. The drag is internal (rearranging existing images)

This provides better visual feedback to users by not showing the drop indicator when the action isn't allowed.

🧰 Tools
🪛 Biome (1.9.4)

[error] 20-20: Change to an optional chain.

Unsafe fix: Change to an optional chain.

(lint/complexity/useOptionalChain)

@im-adithya
Copy link
Author

@9larsons can you please have a look :D

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Gallery card editor allows adding more than 9 images
1 participant