plane icon indicating copy to clipboard operation
plane copied to clipboard

Add preview image to board

Open kubilaysalih opened this issue 1 year ago • 2 comments

I have made the first image that comes in the issue detail as an image that we can see on the kanban layout. Various style and type checks need to be done.

testtest

Summary by CodeRabbit

  • New Features

    • Enhanced issue details with the addition of descriptive HTML content for improved output.
    • Introduced conditional image rendering in the Kanban layout to enhance visual representation of issues.
  • Bug Fixes

    • Improved handling of issue descriptions to ensure relevant images are displayed correctly.

kubilaysalih avatar Sep 11 '24 13:09 kubilaysalih

CLA assistant check
All committers have signed the CLA.

CLAassistant avatar Sep 11 '24 13:09 CLAassistant

Walkthrough

The changes introduce enhancements to the issue_on_results function in the grouper.py file by adding a new attribute, "description_html", to the output structure. Additionally, the KanbanIssueDetailsBlock component in block.tsx has been updated to extract and render images from the issue.description_html, improving the display of issue details in the Kanban layout.

Changes

File Change Summary
apiserver/plane/utils/grouper.py Added "description_html" to the return structure of issue_on_results function.
web/core/components/issues/issue-layouts/kanban/block.tsx Introduced matchedImage constant to extract and conditionally render an image from issue.description_html.

Poem

In the meadow where ideas bloom,
A new field shines, dispelling gloom.
With images bright, our issues now sing,
In Kanban's embrace, joy they bring.
Hops of delight, as we code away,
Celebrating changes, come what may! 🐇✨


Recent review details

Configuration used: CodeRabbit UI Review profile: CHILL

Commits

Files that changed from the base of the PR and between fdcd9a376cb7d4bd90e7a6f64009dbc2da06f7f6 and 77fccdc949a9ce149f8109f5413b1c2839014888.

Files selected for processing (2)
  • apiserver/plane/utils/grouper.py (1 hunks)
  • web/core/components/issues/issue-layouts/kanban/block.tsx (2 hunks)
Additional comments not posted (3)
apiserver/plane/utils/grouper.py (1)

77-77: LGTM!

The code change is approved.

web/core/components/issues/issue-layouts/kanban/block.tsx (2)

63-63: LGTM!

The code segment correctly extracts the source URL of the first image found in the issue.description_html using a regular expression.


96-96: LGTM!

The code segment correctly renders the <img> element conditionally based on the presence of matchedImage and applies appropriate CSS classes for responsive styling.


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 Sep 11 '24 13:09 coderabbitai[bot]

We plan to introduce a different layout, such as a Gallery View, to address this use case. However, this approach is not scalable because it extracts images from the description, which can negatively impact the performance of the list view API.

sriramveeraghanta avatar Oct 07 '25 15:10 sriramveeraghanta

Yes, I don't want to take images from detail_html either, but your situation at the time allowed for it. I honestly can't imagine a kanban without previews. If you can offer a better solution, I'd appreciate it.

kubilaysalih avatar Oct 07 '25 15:10 kubilaysalih