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

feature/rjsf-array-under-array-fix #1068

Merged
merged 3 commits into from
Feb 19, 2024
Merged

Conversation

jasquat
Copy link
Contributor

@jasquat jasquat commented Feb 19, 2024

Fixes #996

This removes the grid from the ArrayFieldItemTemplate component in frontend and instead uses display flex to line items up properly.

to test:

  • create a process model that uses a form with an array within an array and make sure things do not become misaligned while filling it out

example schema to test:

  "type": "object",
  "properties": {
    "nestedArray1": {
      "type": "array",
      "title": "Nested Array 1",
      "items": {
        "type": "object",
        "properties": {
          "nestedArray2": {
            "type": "array",
            "title": "Nested Array 2",
            "items": {
              "type": "string",
              "title": "Item"
            }
          }
        }
      }
    }
  }
}```

<!-- This is an auto-generated comment: release notes by coderabbit.ai -->
## Summary by CodeRabbit


- **Refactor**
	- Simplified imports and restructured layout in the `ArrayFieldItemTemplate` component for better readability and performance.
- **Style**
	- Enhanced form styling, including adjustments to margins, font sizes, and flexbox properties for a more polished user interface.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->

…ms in an rjsf array field to line up w/ burnettk
Copy link
Contributor

coderabbitai bot commented Feb 19, 2024

Warning

Rate Limit Exceeded

@jasquat has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 16 minutes and 47 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.
Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.
Please see our FAQ for further information.

Commits Files that changed from the base of the PR and between 0e5e93b and 2c5167c.

Walkthrough

The recent update aimed to improve the user interface of a form component by focusing on the array field items and overall form styling. It involved streamlining imports from a library, reorganizing the layout for array items within a single component, and refining visual aspects like margins, font sizes, and flexbox usage to enhance the user experience.

Changes

File Path Change Summary
.../ArrayFieldItemTemplate.tsx Refactored to simplify imports from @carbon/react and restructured array item layout with a unified div and updated class names for styling.
.../index.css Adjusted styling for margins, font sizes, and flexbox properties; improved styling for array items, text inputs, and side-by-side columns.

Assessment against linked issues

Objective Addressed Explanation
Array under array layout fix (#996) The refactor addressed the issue by restructuring the array item layout within a single component.

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-tests for this file.
  • 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 tests 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 from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @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.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

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.

Review Status

Actionable comments generated: 1

Configuration used: .coderabbit.yaml

Commits Files that changed from the base of the PR and between 6a81d68 and 7b530f2.
Files selected for processing (2)
  • spiffworkflow-frontend/src/rjsf/carbon_theme/ArrayFieldItemTemplate/ArrayFieldItemTemplate.tsx (2 hunks)
  • spiffworkflow-frontend/src/rjsf/carbon_theme/index.css (4 hunks)
Additional comments: 5
spiffworkflow-frontend/src/rjsf/carbon_theme/ArrayFieldItemTemplate/ArrayFieldItemTemplate.tsx (1)
  • 42-75: The refactoring to use a single div for both the contents and actions of the array field, with updated class names for styling, aligns well with the PR's objective to improve layout and alignment using flexbox. This change simplifies the structure and should make it easier to manage and style the component. However, ensure that the removal of the grid layout and the transition to flexbox does not introduce any unexpected layout issues, especially in edge cases with deeply nested arrays or varying content sizes.
spiffworkflow-frontend/src/rjsf/carbon_theme/index.css (4)
  • 71-71: Adjusting the bottom margin of .rjsf .array-item .rjsf-field to 0 is a targeted change that likely aims to reduce unnecessary spacing within array items. This should contribute to a more compact and aligned appearance for nested array elements. Ensure this change does not lead to elements being too tightly packed, which could affect readability and user experience.
  • 76-76: Reducing the font size of .rjsf .markdown-field-desc-text .field-description to 0.8rem is a subtle change that could help differentiate the description text from other text elements in the form. This change should be verified across different devices and screen sizes to ensure that the text remains legible and does not negatively impact the user experience, especially for users with visual impairments.
  • 108-109: Adding padding to the right of .rjsf .side-by-side-column:not(:last-child) is a good practice for creating visual separation between columns that are displayed side by side. This change should enhance the visual clarity of the form layout. Verify that the padding value of 1rem is consistent with the overall design system and does not create alignment issues with other form elements.
  • 111-123: The introduction of flexbox properties to .rjsf .array-field-container, .rjsf .array-field-contents, and .rjsf .array-field-actions is a significant change that aligns with the PR's objective to improve the layout and alignment of nested array forms. This change should provide more flexibility and control over the positioning of elements within the form. However, it's important to test these changes thoroughly across different browsers and screen sizes to ensure consistent behavior and appearance, especially since flexbox can behave differently in edge cases.

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.

Review Status

Actionable comments generated: 0

Configuration used: .coderabbit.yaml

Commits Files that changed from the base of the PR and between 7b530f2 and 0e5e93b.
Files selected for processing (1)
  • spiffworkflow-frontend/src/rjsf/carbon_theme/ArrayFieldItemTemplate/ArrayFieldItemTemplate.tsx (2 hunks)
Files skipped from review as they are similar to previous changes (1)
  • spiffworkflow-frontend/src/rjsf/carbon_theme/ArrayFieldItemTemplate/ArrayFieldItemTemplate.tsx

@burnettk burnettk merged commit dc14af7 into main Feb 19, 2024
19 checks passed
@burnettk burnettk deleted the feature/rjsf-array-under-array-fix branch February 19, 2024 20:27
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.

Array under array - JSON form - UI fix
2 participants