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(web): Add default header for syslumenn organization #15959

Merged
merged 3 commits into from
Sep 12, 2024

Conversation

mannipje
Copy link
Member

@mannipje mannipje commented Sep 11, 2024

Add default header for syslumenn organization

What

Make it possible to use default header for syslumenn organization via config.

Why

A design that was approved by Digital Iceland

Screenshots / Gifs

Before

image

After

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

  • New Features

    • Introduced a new customizable header component for organization pages, enhancing visual presentation and responsiveness.
    • Added conditional rendering logic for organization headers based on theme configurations.
  • Style

    • Implemented new styling for the default header, improving layout and appearance.
  • Documentation

    • Updated module exports to include the new default header component, providing additional options for header customization.

@mannipje mannipje added the automerge Merge this PR as soon as all checks pass label Sep 11, 2024
@mannipje mannipje requested a review from a team as a code owner September 11, 2024 14:08
Copy link
Contributor

coderabbitai bot commented Sep 11, 2024

Walkthrough

The changes introduce a new header component, SyslumennDefaultHeader, and enhance the OrganizationWrapper.tsx file to conditionally render headers based on the organization’s theme configuration. The getThemeConfig function now extracts a boolean value to determine whether to use the default header. Additionally, a new CSS file is created for styling the default header. The module exports are updated to include the new header option, improving the adaptability of the organization’s header display.

Changes

Files Change Summary
apps/web/components/Organization/Wrapper/OrganizationWrapper.tsx Added logic to conditionally render SyslumennDefaultHeader based on organization theme configuration.
apps/web/components/Organization/Wrapper/Themes/SyslumennTheme/SyslumennDefaultHeader.css.ts Introduced CSS styles for the new header component.
apps/web/components/Organization/Wrapper/Themes/SyslumennTheme/SyslumennDefaultHeader.tsx Created a new React component for the default header with responsive design and theming capabilities.
apps/web/components/Organization/Wrapper/Themes/SyslumennTheme/index.ts Added export for SyslumennDefaultHeader to make it available alongside existing header components.

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

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.

@datadog-island-is
Copy link

datadog-island-is bot commented Sep 11, 2024

Datadog Report

Branch report: feature/add-default-header-for-syslumenn
Commit report: a5d5aba
Test service: web

✅ 0 Failed, 84 Passed, 0 Skipped, 30.92s Total Time
➡️ Test Sessions change in coverage: 1 no change

Copy link

codecov bot commented Sep 11, 2024

Codecov Report

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

Project coverage is 36.81%. Comparing base (deb2c31) to head (f24963c).
Report is 2 commits behind head on main.

Files with missing lines Patch % Lines
...r/Themes/SyslumennTheme/SyslumennDefaultHeader.tsx 0.00% 13 Missing ⚠️
...nents/Organization/Wrapper/OrganizationWrapper.tsx 0.00% 7 Missing ⚠️
...rganization/Wrapper/Themes/SyslumennTheme/index.ts 0.00% 1 Missing ⚠️
Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main   #15959      +/-   ##
==========================================
- Coverage   36.86%   36.81%   -0.05%     
==========================================
  Files        6714     6710       -4     
  Lines      137611   137366     -245     
  Branches    39119    39107      -12     
==========================================
- Hits        50732    50576     -156     
+ Misses      86879    86790      -89     
Flag Coverage Δ
web 1.84% <0.00%> (-0.01%) ⬇️

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

Files with missing lines Coverage Δ
...rganization/Wrapper/Themes/SyslumennTheme/index.ts 0.00% <0.00%> (ø)
...nents/Organization/Wrapper/OrganizationWrapper.tsx 0.00% <0.00%> (ø)
...r/Themes/SyslumennTheme/SyslumennDefaultHeader.tsx 0.00% <0.00%> (ø)

... and 58 files 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 a3c7569...f24963c. 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: 0

Outside diff range and nitpick comments (1)
apps/web/components/Organization/Wrapper/Themes/SyslumennTheme/SyslumennDefaultHeader.tsx (1)

18-63: LGTM! Consider adding tests for the component.

The SyslumennDefaultHeader component is well-implemented and adheres to the NextJS best practices. It efficiently manages the state using hooks and conditionally renders based on the window size and theme properties. The use of TypeScript for the component props ensures type safety.

To further improve the component, consider adding tests to validate its behavior under different configurations, such as different window sizes and theme properties.

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 82360b0 and 03dae5b.

Files selected for processing (4)
  • apps/web/components/Organization/Wrapper/OrganizationWrapper.tsx (4 hunks)
  • apps/web/components/Organization/Wrapper/Themes/SyslumennTheme/SyslumennDefaultHeader.css.ts (1 hunks)
  • apps/web/components/Organization/Wrapper/Themes/SyslumennTheme/SyslumennDefaultHeader.tsx (1 hunks)
  • apps/web/components/Organization/Wrapper/Themes/SyslumennTheme/index.ts (1 hunks)
Files skipped from review due to trivial changes (1)
  • apps/web/components/Organization/Wrapper/Themes/SyslumennTheme/SyslumennDefaultHeader.css.ts
Additional context used
Path-based instructions (3)
apps/web/components/Organization/Wrapper/Themes/SyslumennTheme/index.ts (1)

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

  • NextJS best practices, including file structure, API routes, and static generation methods.
  • Efficient state management and server-side rendering techniques.
  • Optimal use of TypeScript for component and utility type safety."
apps/web/components/Organization/Wrapper/Themes/SyslumennTheme/SyslumennDefaultHeader.tsx (1)

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

  • NextJS best practices, including file structure, API routes, and static generation methods.
  • Efficient state management and server-side rendering techniques.
  • Optimal use of TypeScript for component and utility type safety."
apps/web/components/Organization/Wrapper/OrganizationWrapper.tsx (1)

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

  • NextJS best practices, including file structure, API routes, and static generation methods.
  • Efficient state management and server-side rendering techniques.
  • Optimal use of TypeScript for component and utility type safety."
Additional comments not posted (6)
apps/web/components/Organization/Wrapper/Themes/SyslumennTheme/index.ts (2)

3-3: LGTM!

The import statement for the DefaultHeader component is correctly written and follows the NextJS best practices for importing components.


8-8: LGTM!

The export statement for the SyslumennDefaultHeader component is correctly written and enhances the module's functionality by providing an additional header option.

apps/web/components/Organization/Wrapper/OrganizationWrapper.tsx (4)

100-104: LGTM!

The import statement for the SyslumennDefaultHeader component is correctly added.


170-175: LGTM!

The changes in the getThemeConfig function correctly parse the organization object to extract the usingDefaultHeader boolean value. This allows the function to determine whether to use the default header for the Syslumenn theme based on the organization's configuration.


201-202: LGTM!

The changes correctly include the usingDefaultHeader boolean in the condition for returning the theme configuration for light themes. This ensures that the default header is used for the Syslumenn theme when usingDefaultHeader is true, regardless of the theme.


Line range hint 271-282: LGTM!

The changes correctly update the rendering logic for the 'syslumenn' theme to conditionally render the appropriate header component based on the usingDefaultHeader value. The SyslumennDefaultHeader component is rendered when usingDefaultHeader is true, and the existing SyslumennHeader component is rendered otherwise. The necessary props are passed to the SyslumennDefaultHeader component.

@kodiakhq kodiakhq bot merged commit b9fcee6 into main Sep 12, 2024
30 checks passed
@kodiakhq kodiakhq bot deleted the feature/add-default-header-for-syslumenn branch September 12, 2024 09:40
jonnigs pushed a commit that referenced this pull request Sep 12, 2024
* Add default header for syslumenn organization

* Fix json parse

---------

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