plane icon indicating copy to clipboard operation
plane copied to clipboard

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

Open sharma01ketan opened this issue 1 year ago β€’ 1 comments

[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

  2. New empty-state.tsx component created in the space directory. Space had no empty-state.tsx previously. image

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

sharma01ketan avatar Aug 27 '24 13:08 sharma01ketan

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

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.

coderabbitai[bot] avatar Aug 27 '24 13:08 coderabbitai[bot]