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: Added section component for action forms #35309

Merged
merged 2 commits into from
Aug 1, 2024

Conversation

albinAppsmith
Copy link
Collaborator

@albinAppsmith albinAppsmith commented Jul 31, 2024

Description

This PR added section component that can be used in UQI forms

Fixes #34319

Automation

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

🔍 Cypress test results

Tip

🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/10176993550
Commit: 95175f3
Cypress dashboard.
Tags: @tag.Sanity
Spec:


Wed, 31 Jul 2024 09:09:55 UTC

Communication

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

  • Yes
  • No

Summary by CodeRabbit

  • New Features
    • Introduced a modular Section component for improved UI structure and reusability.
    • Added responsive styling for the Section component, enhancing visual consistency across the application.
    • Enhanced accessibility by allowing other modules to easily integrate the Section component through the ActionForm module.

Copy link
Contributor

coderabbitai bot commented Jul 31, 2024

Walkthrough

This update introduces a new Section component to the application, enhancing its modularity and responsiveness. The component is designed to provide a flexible layout with specified styling for sections, including margins, gaps, and a maximum width. It allows for easy incorporation of child elements, enabling a more structured and visually appealing interface. This aligns with the goal of developing a responsive section control type for the application.

Changes

Files Summary Change Description
app/client/src/pages/Editor/ActionForm/Section/index.tsx Introduced Section component with children and isStandalone props; renders a styled div.
app/client/src/pages/Editor/ActionForm/Section/styles.module.css Added styles for .section class, utilizing flexbox for layout, with responsiveness and conditional styles.
app/client/src/pages/Editor/ActionForm/index.ts Created new export for all entities from Section, enhancing modularity for component imports.

Assessment against linked issues

Objective Addressed Explanation
Needs Y margin of 20px (Feature #34319)
Gap of 12 px (Feature #34319)
Defines max width of 800px (Feature #34319)
Can have any number of zones inside them (Feature #34319) Clarification needed on "zones" functionality.

🌟 In a realm of code, a section was born,
With margins and gaps, neat lines it adorn.
Responsive and sleek, a modular delight,
Bringing structure and style, making the UI bright!
Each child it welcomes, with open embrace,
In this digital garden, we find our place! 🌼


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

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

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.

@github-actions github-actions bot added Enhancement New feature or request IDE Product Issues related to the IDE Product IDE Navigation Issues/feature requests related to IDE navigation, and context switching IDE Pod Issues that new developers face while exploring the IDE potential-duplicate This label marks issues that are potential duplicates of already open issues labels Jul 31, 2024
@albinAppsmith albinAppsmith added the ok-to-test Required label for CI label Jul 31, 2024
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

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 5632481 and 95175f3.

Files selected for processing (3)
  • app/client/src/pages/Editor/ActionForm/Section/index.tsx (1 hunks)
  • app/client/src/pages/Editor/ActionForm/Section/styles.module.css (1 hunks)
  • app/client/src/pages/Editor/ActionForm/index.ts (1 hunks)
Files skipped from review due to trivial changes (2)
  • app/client/src/pages/Editor/ActionForm/Section/styles.module.css
  • app/client/src/pages/Editor/ActionForm/index.ts
Additional comments not posted (4)
app/client/src/pages/Editor/ActionForm/Section/index.tsx (4)

1-2: Imports look good.

The imports of React and the CSS module are appropriate for this component.


4-7: Interface definition is clear.

The SectionProps interface is well-defined with optional properties.


9-18: Component implementation is solid.

The Section component is well-implemented, adhering to best practices for functional components. The use of data-standalone attribute is a nice touch for conditional styling.


20-20: Export statement is correct.

The Section component is correctly exported.

@sagar-qa007
Copy link
Contributor

@albinAppsmith Please add unit test cases if possible.

@albinAppsmith
Copy link
Collaborator Author

@albinAppsmith Please add unit test cases if possible.

@sagar-qa007 This is a visual component. I feel writing unit test for this doesn't make sense.

@albinAppsmith albinAppsmith merged commit ccedf2e into release Aug 1, 2024
44 checks passed
@albinAppsmith albinAppsmith deleted the responsive-form-section branch August 1, 2024 06:11
@github-actions github-actions bot added QA Needs QA attention QA Pod Issues under the QA Pod labels Aug 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Enhancement New feature or request IDE Navigation Issues/feature requests related to IDE navigation, and context switching IDE Pod Issues that new developers face while exploring the IDE IDE Product Issues related to the IDE Product ok-to-test Required label for CI potential-duplicate This label marks issues that are potential duplicates of already open issues QA Pod Issues under the QA Pod QA Needs QA attention
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Feature]: Responsive Section in UQI
4 participants