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

fix(application-system): empty title for formStepper #15185

Merged
merged 3 commits into from
Jun 11, 2024

Conversation

jonnigs
Copy link
Member

@jonnigs jonnigs commented Jun 11, 2024

What

Don't render out steps in the formStepper if the title is empty

Why

To have the same behaviour as the discontinued core formStepper

Screenshots / Gifs

Previously:
Screenshot 2024-06-11 at 12 50 04

Now:
image

Checklist:

  • I have performed a self-review of my own code
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • Formatting passes locally with my changes
  • I have rebased against main before asking for a review

Summary by CodeRabbit

  • Bug Fixes
    • Improved the FormStepper component to handle cases where text elements are null, ensuring proper conditional rendering based on the presence of valid text content.

Copy link
Contributor

coderabbitai bot commented Jun 11, 2024

Walkthrough

The changes in FormStepper.tsx enhance the rendering logic of the FormStepper component by introducing conditional rendering. This update ensures that child elements and sections are only rendered if they contain valid text content, thus preventing the display of null text elements and improving the overall user interface consistency.

Changes

File Path Change Summary
libs/application/ui-shell/src/components/FormStepper.tsx Updated the mapping of child elements and sections to handle null text content and adjust rendering logic accordingly.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant FormStepper
    participant UI

    User->>FormStepper: Load FormStepper
    FormStepper->>UI: Map child elements and sections
    alt Text content is valid
        UI->>User: Render child elements and sections
    else Text content is null
        UI->>User: Skip rendering for null text elements
    end
Loading

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

@jonnigs jonnigs marked this pull request as ready for review June 11, 2024 13:24
@jonnigs jonnigs requested a review from a team as a code owner June 11, 2024 13:24
@datadog-island-is
Copy link

Datadog Report

All test runs 49f9a0c 🔗

5 Total Test Services: 0 Failed, 5 Passed
🔻 Test Sessions change in coverage: 1 decreased (-0.02%), 7 no change

Test Services
Service Name Failed Known Flaky New Flaky Passed Skipped Total Time Code Coverage Change Test Service View
api 0 0 0 4 0 3.54s 1 no change Link
application-system-api 0 0 0 111 2 3m 39.8s 1 no change Link
application-template-api-modules 0 0 0 109 0 2m 46.41s 1 no change Link
application-templates-driving-license 0 0 0 13 0 46.85s 1 no change Link
application-ui-shell 0 0 0 74 0 1m 24s 1 decreased (-0.02%) Link

🔻 Code Coverage Decreases vs Default Branch (1)

  • application-ui-shell - jest 28.06% (-0.02%) - Details

Copy link

codecov bot commented Jun 11, 2024

Codecov Report

Attention: Patch coverage is 0% with 13 lines in your changes missing coverage. Please review.

Project coverage is 36.98%. Comparing base (628a19c) to head (a4a3864).

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main   #15185      +/-   ##
==========================================
- Coverage   36.98%   36.98%   -0.01%     
==========================================
  Files        6419     6419              
  Lines      130969   130974       +5     
  Branches    37497    37498       +1     
==========================================
  Hits        48439    48439              
- Misses      82530    82535       +5     
Flag Coverage Δ
api 3.44% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Files Coverage Δ
...pplication/ui-shell/src/components/FormStepper.tsx 31.25% <0.00%> (-7.22%) ⬇️

... and 1 file with indirect coverage changes


Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 628a19c...a4a3864. Read the comment docs.

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: 3

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 628a19c and 079ce93.

Files selected for processing (1)
  • libs/application/ui-shell/src/components/FormStepper.tsx (2 hunks)
Additional context used
Path-based instructions (1)
libs/application/ui-shell/src/components/FormStepper.tsx (1)

Pattern libs/**/*: "Confirm that the code adheres to the following:

  • Reusability of components and hooks across different NextJS apps.
  • TypeScript usage for defining props and exporting types.
  • Effective tree-shaking and bundling practices."
Biome
libs/application/ui-shell/src/components/FormStepper.tsx

[error] 68-68: Avoid using the index of an array as key property in an element. (lint/suspicious/noArrayIndexKey)

This is the source of the key value.

The order of the items may change, and this also affects performances and component state.
Check the React documentation.


[error] 104-104: Avoid using the index of an array as key property in an element. (lint/suspicious/noArrayIndexKey)

This is the source of the key value.

The order of the items may change, and this also affects performances and component state.
Check the React documentation.

Additional comments not posted (1)
libs/application/ui-shell/src/components/FormStepper.tsx (1)

100-119: Ensure conditional rendering logic is robust and maintainable.

The implementation of conditional rendering based on the presence of sectionTitle is clear and aligns with the PR objectives to handle null text content effectively.

Tools
Biome

[error] 104-104: Avoid using the index of an array as key property in an element. (lint/suspicious/noArrayIndexKey)

This is the source of the key value.

The order of the items may change, and this also affects performances and component state.
Check the React documentation.

@jonnigs jonnigs added the automerge Merge this PR as soon as all checks pass label Jun 11, 2024
@kodiakhq kodiakhq bot merged commit a01ba02 into main Jun 11, 2024
36 checks passed
@kodiakhq kodiakhq bot deleted the fix/formstepper-handle-empty branch June 11, 2024 13:51
sigruntg pushed a commit that referenced this pull request Jun 12, 2024
* fix: empty title for formStepper

* fix: use the constant I defined

---------

Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
lodmfjord pushed a commit that referenced this pull request Jun 14, 2024
* fix: empty title for formStepper

* fix: use the constant I defined

---------

Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
automerge Merge this PR as soon as all checks pass
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants