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

[WEB-2257] fix: empty state change for space archive and no issues #5440

Draft
wants to merge 2 commits into
base: preview
Choose a base branch
from

Conversation

sharma01ketan
Copy link
Collaborator

@sharma01ketan sharma01ketan commented Aug 27, 2024

[WEB-2257]

Changes:

This PR changes the UI rendered in "spaces" when the project is archived or has no issues.
For both light and dark mode

  1. New UI when no issues are present in the published project or it is archived.
image
  1. New empty-state.tsx component created in the space directory. Space had no empty-state.tsx previously.
image
  1. Light and Dark asset added to the space directory, keeping in mind that the relative path of the asset should be same in web and space, i.e. they are having the same relative path.
light-asset dark-asset

References:

[WEB-2257]

Summary by CodeRabbit

Summary by CodeRabbit

  • New Features

    • Introduced a customizable EmptyState component for displaying user-friendly placeholders when no content is available.
    • Enhanced the IssueLayoutHOC to utilize the EmptyState component, providing a visually informative message when no issues are found, with responsiveness to light or dark themes.
  • Bug Fixes

    • Improved the semantic clarity of the UI by replacing the previous simple message with a detailed EmptyState display.

Copy link
Contributor

coderabbitai bot commented Aug 27, 2024

Walkthrough

The changes introduce a new EmptyState React component to provide a visually appealing interface when no content is available. This component is integrated into the IssueLayoutHOC, replacing a simple message with a theme-aware EmptyState display that includes images and descriptions based on the current theme. The modifications enhance the functionality and appearance of empty states across the application.

Changes

Files Change Summary
space/core/components/common/empty-state.tsx Introduced a new EmptyState component that accepts props for title, description, image, and buttons.
space/core/components/issues/issue-layouts/issue-layout-HOC.tsx Enhanced IssueLayoutHOC to use the EmptyState component, integrating theme awareness for improved display.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant IssueLayoutHOC
    participant EmptyState

    User->>IssueLayoutHOC: Request to view issues
    IssueLayoutHOC->>IssueLayoutHOC: Check for issues
    alt No issues found
        IssueLayoutHOC->>EmptyState: Render with theme-aware image and description
        EmptyState-->>User: Display empty state
    else Issues found
        IssueLayoutHOC->>User: Display list of issues
    end
Loading

Poem

🐇 In a world where issues roam,
With empty spaces, we call home.
A state so bright, with themes that glow,
A cheerful place where bunnies flow.
Hooray for change, let spirits lift,
For every empty state, a lovely gift! ✨

Tip

We have updated our review workflow to use the Anthropic's Claude family of models. Please share any feedback in the discussion post on our Discord.


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.

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.

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 UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 0920969 and be0bd8c.

Files selected for processing (2)
  • space/core/components/common/empty-state.tsx (1 hunks)
  • space/core/components/issues/issue-layouts/issue-layout-HOC.tsx (3 hunks)
Additional comments not posted (8)
space/core/components/common/empty-state.tsx (4)

1-20: LGTM!

The imports and type definition are correct and well-defined.

The code changes are approved.


22-30: LGTM!

The component definition and structure are correct and follow best practices.

The code changes are approved.


31-33: LGTM!

The Image and title rendering are correct and follow best practices.

The code changes are approved.


34-47: LGTM!

The description and button rendering are correct and follow best practices for conditional rendering and dynamic properties.

The code changes are approved.

space/core/components/issues/issue-layouts/issue-layout-HOC.tsx (4)

2-8: LGTM!

The imports are correct and necessary for the new functionality.

The code changes are approved.


21-23: LGTM!

The component definition and theme usage are correct and follow best practices for theme-aware rendering.

The code changes are approved.


Line range hint 24-36: LGTM!

The loader and issue count handling are correct and follow best practices for conditional rendering based on state.

The code changes are approved.


37-44: LGTM!

The empty state rendering is correct and enhances the user experience by providing a visually informative display.

The code changes are approved.

@anmolsinghbhatia anmolsinghbhatia marked this pull request as draft August 28, 2024 08:20
@sharma01ketan sharma01ketan changed the title [WEB-2254] fix: empty state change for space archive and no issues [WEB-2257] fix: empty state change for space archive and no issues Aug 28, 2024
@sharma01ketan sharma01ketan marked this pull request as ready for review September 3, 2024 13:02
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 UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between be0bd8c and ad69f12.

Files selected for processing (1)
  • space/core/components/issues/issue-layouts/issue-layout-HOC.tsx (3 hunks)
Files skipped from review as they are similar to previous changes (1)
  • space/core/components/issues/issue-layouts/issue-layout-HOC.tsx

@sharma01ketan sharma01ketan marked this pull request as draft September 3, 2024 13:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant