fix: Anvil drag preview for section widget #33198

marks0351 · 2024-05-06T09:57:22Z

Description

Adding Section widget thumbnail icons
removing shared component of widget card UI
adding anvil component for widget preview used while dragging.

Fixes #Issue Number
or
Fixes Issue URL

Warning

If no issue exists, please create an issue first, and check with the maintainers if the issue is valid.

Automation

/ok-to-test tags="@tag.Anvil"

🔍 Cypress test results

Tip

🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/8983616703
Commit: d96144a
Cypress dashboard url: Click here!

Communication

Should the DevRel and Marketing teams inform users about this change?

Yes
No

coderabbitai · 2024-05-06T09:57:33Z

Walkthrough

The recent updates aim to enhance the drag preview functionality for widgets within the Anvil editor by introducing the AnvilDragPreview component in index.tsx. This component dynamically generates drag preview props based on the widget type being dragged, improving the user experience during widget placement.

Changes

Files	Changes
`.../AnvilDragPreview/index.tsx`	Introduced `AnvilDragPreview` function component to handle drag preview functionality.
	Added `getWidgetDragPreviewProps` function to dynamically generate drag preview props.

Possibly related issues

appsmithorg/appsmith#32330: Enhancing Widget Card Design - Changes in WidgetCard.tsx, configuration updates, and thumbnail enhancements could directly contribute to improving the widget card design to accommodate new building blocks and align with design standards.

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>.
- 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 generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @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.

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 as PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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

marks0351 · 2024-05-06T10:29:49Z

/build-deploy-preview skip-tests=true

github-actions · 2024-05-06T10:30:09Z

Deploying Your Preview: https://github.com/appsmithorg/appsmith/actions/runs/8967677762.
Workflow: On demand build Docker image and deploy preview.
skip-tests: true.
env: ``.
PR: 33198.
recreate: .

github-actions · 2024-05-06T10:43:55Z

Deploy-Preview-URL: https://ce-33198.dp.appsmith.com

marks0351 · 2024-05-06T12:50:45Z

/build-deploy-preview skip-tests=true

github-actions · 2024-05-06T12:51:09Z

Deploying Your Preview: https://github.com/appsmithorg/appsmith/actions/runs/8969393864.
Workflow: On demand build Docker image and deploy preview.
skip-tests: true.
env: ``.
PR: 33198.
recreate: .

github-actions · 2024-05-06T13:04:19Z

Deploy-Preview-URL: https://ce-33198.dp.appsmith.com

KelvinOm · 2024-05-06T14:45:45Z

app/client/src/layoutSystems/anvil/editor/canvasArenas/AnvilDragPreview/index.tsx

+    widgetConfig.displayName
+  ) {
+    return {
+      thumbnail: widgetConfig.thumbnailSVG,


Maybe, we don't need to support SVG for anvil? I think the code will be a little clearer without it.

KelvinOm · 2024-05-06T14:47:57Z

app/client/src/layoutSystems/anvil/editor/canvasArenas/AnvilDragPreview/index.tsx

+  const widgetType = isNewWidget
+    ? dragDetails?.newWidget?.type
+    : dragDetails?.draggingGroupCenter?.widgetType || "";
+  const dragPreviewProps:


Could you create named type for this? Really difficult to read this inline types.

…o section-drag-preview

KelvinOm · 2024-05-07T10:54:53Z

...t/src/layoutSystems/anvil/editor/canvasArenas/AnvilDragPreview/AnvilDragPreviewComponent.tsx

+  ThumbnailCmp,
+}: {
+  displayName: string;
+  ThumbnailCmp?: React.FC;


Isn't this a required prop for this component?

it is required to show the icon whilst dragging, however we are checking for scenarios where the Icon is not provided since the ThumbnailCmp is not a required config for all widgets.
When it is not present we just render the widget display name on the drag preview without the icon.

marks0351 added 4 commits May 6, 2024 15:22

chore: add section icons.

e39764b

add thumbnail icon comp

f953212

chore: create single purpose widget card component for anvil needs

781bf73

enable modal dnd in empty layouts with lot of empty space.

e3c99b4

github-actions bot added the Bug Something isn't working label May 6, 2024

marks0351 added the ok-to-test Required label for CI label May 6, 2024

marks0351 requested a review from KelvinOm May 6, 2024 10:52

KelvinOm reviewed May 6, 2024

View reviewed changes

marks0351 added 2 commits May 7, 2024 15:42

chore: addressing code review comments.

3a11246

chore: clean up checks for thumbnailSVG

bd7b200

marks0351 requested a review from KelvinOm May 7, 2024 10:14

Merge branch 'release' of https://github.com/appsmithorg/appsmith int…

d96144a

…o section-drag-preview

marks0351 added ok-to-test Required label for CI and removed ok-to-test Required label for CI labels May 7, 2024

KelvinOm approved these changes May 7, 2024

View reviewed changes

marks0351 merged commit 30c8c19 into release May 7, 2024
44 checks passed

marks0351 deleted the section-drag-preview branch May 7, 2024 11:05

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: Anvil drag preview for section widget #33198

fix: Anvil drag preview for section widget #33198

marks0351 commented May 6, 2024 •

edited by github-actions bot

Loading

coderabbitai bot commented May 6, 2024 •

edited

Loading

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

marks0351 commented May 6, 2024

github-actions bot commented May 6, 2024

github-actions bot commented May 6, 2024

marks0351 commented May 6, 2024

github-actions bot commented May 6, 2024

github-actions bot commented May 6, 2024

KelvinOm May 6, 2024

KelvinOm May 6, 2024

KelvinOm May 7, 2024

marks0351 May 7, 2024

fix: Anvil drag preview for section widget #33198

fix: Anvil drag preview for section widget #33198

Conversation

marks0351 commented May 6, 2024 • edited by github-actions bot Loading

Description

Automation

🔍 Cypress test results

Communication

coderabbitai bot commented May 6, 2024 • edited Loading

Walkthrough

Changes

Possibly related issues

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

marks0351 commented May 6, 2024

github-actions bot commented May 6, 2024

github-actions bot commented May 6, 2024

marks0351 commented May 6, 2024

github-actions bot commented May 6, 2024

github-actions bot commented May 6, 2024

KelvinOm May 6, 2024

Choose a reason for hiding this comment

KelvinOm May 6, 2024

Choose a reason for hiding this comment

KelvinOm May 7, 2024

Choose a reason for hiding this comment

marks0351 May 7, 2024

Choose a reason for hiding this comment

marks0351 commented May 6, 2024 •

edited by github-actions bot

Loading

coderabbitai bot commented May 6, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)