[WEB-3827] refactor: work item widget components by aaryan610 · Pull Request #6902 · makeplane/plane

aaryan610 · 2025-04-09T12:38:10Z

Description

This PR refactors the work item widget components in the following ways-

Added a new prop issueServiceType from the root level to add support for widgets in different places.
Added hideWIdgets props for the ability to show only selected widgets.

Type of Change

Code refactoring

Summary by CodeRabbit

New Features
- Enhanced the issue detail view to support configurable widget visibility, allowing certain sections (like attachments, links, sub-items, and relations) to be selectively displayed for a more tailored experience.
- Improved consistency in service settings across issue interaction components, ensuring a more predictable and reliable user interface behavior.

coderabbitai · 2025-04-09T12:38:17Z

Walkthrough

This pull request updates multiple components by enforcing the explicit provision of the issueServiceType prop—changing it from optional to required—and by introducing an optional hideWidgets array in widget-related components. The modifications remove default values for issueServiceType and update the destructuring logic. Additionally, conditional rendering has been added for various action buttons and collapsible sections based on the values provided in hideWidgets. These changes enhance type safety and configurability across the issue detail widgets.

Changes

File(s)	Change Summary
`web/core/components/issues/issue-detail-widgets/action-buttons.tsx`, `.../root.tsx`, `.../issue-detail-widget-collapsibles.tsx`, `.../issue-detail-widget-modals.tsx`	Added new props: `issueServiceType` (required) and optional `hideWidgets`; updated prop destructuring and conditional rendering logic to control widget visibility and pass `issueServiceType` to child components.
`web/core/components/issues/issue-detail-widgets/attachments/`, `web/core/components/issues/issue-detail-widgets/links/`, `web/core/components/issues/issue-detail-widgets/relations/`, `web/core/components/issues/issue-detail-widgets/sub-issues/`	Converted `issueServiceType` from optional to required across various widget components by removing default fallback values, ensuring explicit prop provision.
`web/core/components/issues/issue-detail/links/*`, `web/core/components/issues/issue-detail/main-content.tsx`	Updated type definitions and prop handling for `issueServiceType`; added new import for constants and passed the prop to modals and widgets for consistent usage.
`web/core/components/issues/peek-overview/view.tsx`	Added explicit `issueServiceType` prop to both rendering paths of `IssueDetailWidgets` within the peek overview.

Sequence Diagram(s)

sequenceDiagram
  participant U as User
  participant W as IssueDetailWidgets
  participant AB as ActionButtons
  participant C as Collapsibles
  participant M as Modals

  U->>W: Render with { issueServiceType, hideWidgets }
  W->>AB: Pass props for action buttons
  W->>C: Pass props for collapsible sections
  W->>M: Pass props for modals
  AB->>U: Conditionally render buttons based on hideWidgets
  C->>U: Render collapsible sections accordingly
  M->>U: Display modals with issueServiceType

Possibly related PRs

[WEB-3748, 3749] feat: work item description version history #6863: Related adjustments to the handling of the issueServiceType prop align with the modifications in this PR.
[WEB-3693] chore: cmd-k work item actions improvements #6891: Focuses on enforcing the use of issueServiceType within the updateIssue function, echoing similar changes in component prop management.

Suggested labels

🌟improvement, 🌐frontend

Suggested reviewers

prateekshourya29
sriramveeraghanta

Poem

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 993c789 and 959f0d9.

📒 Files selected for processing (19)

web/core/components/issues/issue-detail-widgets/action-buttons.tsx (1 hunks)
web/core/components/issues/issue-detail-widgets/attachments/quick-action-button.tsx (2 hunks)
web/core/components/issues/issue-detail-widgets/attachments/root.tsx (2 hunks)
web/core/components/issues/issue-detail-widgets/issue-detail-widget-collapsibles.tsx (3 hunks)
web/core/components/issues/issue-detail-widgets/issue-detail-widget-modals.tsx (3 hunks)
web/core/components/issues/issue-detail-widgets/links/content.tsx (1 hunks)
web/core/components/issues/issue-detail-widgets/links/quick-action-button.tsx (1 hunks)
web/core/components/issues/issue-detail-widgets/links/root.tsx (2 hunks)
web/core/components/issues/issue-detail-widgets/links/title.tsx (2 hunks)
web/core/components/issues/issue-detail-widgets/relations/quick-action-button.tsx (2 hunks)
web/core/components/issues/issue-detail-widgets/relations/root.tsx (2 hunks)
web/core/components/issues/issue-detail-widgets/root.tsx (2 hunks)
web/core/components/issues/issue-detail-widgets/sub-issues/quick-action-button.tsx (2 hunks)
web/core/components/issues/issue-detail-widgets/sub-issues/root.tsx (2 hunks)
web/core/components/issues/issue-detail/links/create-update-link-modal.tsx (2 hunks)
web/core/components/issues/issue-detail/links/link-list.tsx (2 hunks)
web/core/components/issues/issue-detail/links/root.tsx (3 hunks)
web/core/components/issues/issue-detail/main-content.tsx (2 hunks)
web/core/components/issues/peek-overview/view.tsx (2 hunks)

🧰 Additional context used

🧬 Code Graph Analysis (16)

web/core/components/issues/issue-detail-widgets/links/quick-action-button.tsx (1)

web/core/components/issues/issue-detail-widgets/links/content.tsx (1)

web/core/components/issues/issue-detail-widgets/action-buttons.tsx (2)

web/core/components/issues/issue-detail-widgets/issue-detail-widget-modals.tsx (1)

web/core/components/issues/issue-detail-widgets/relations/root.tsx (1)

web/core/components/issues/issue-detail/links/link-list.tsx (1)

web/core/components/issues/issue-detail-widgets/links/root.tsx (1)

web/core/components/issues/issue-detail-widgets/root.tsx (3)

web/core/components/issues/issue-detail/links/create-update-link-modal.tsx (1)

web/core/components/issues/issue-detail-widgets/sub-issues/root.tsx (1)

web/core/components/issues/issue-detail-widgets/attachments/quick-action-button.tsx (1)

web/core/components/issues/issue-detail-widgets/attachments/root.tsx (1)

web/core/components/issues/issue-detail-widgets/links/title.tsx (1)

web/core/components/issues/issue-detail-widgets/issue-detail-widget-collapsibles.tsx (6)

web/core/components/issues/issue-detail-widgets/relations/quick-action-button.tsx (1)

web/core/components/issues/issue-detail-widgets/sub-issues/quick-action-button.tsx (1)

⏰ Context from checks skipped due to timeout of 90000ms (2)

GitHub Check: Analyze (javascript)
GitHub Check: Analyze (python)

🔇 Additional comments (47)

✨ Finishing Touches

📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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>, please review it.
- 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @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 generate docstrings to generate docstrings for this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai plan to trigger planning for file edits and PR creation.
@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.

makeplane · 2025-04-09T14:22:33Z

Pull Request Linked with Plane Work Items

[WEB-3827] refactor: work item widget components

Comment Automatically Generated by Plane

refactor: issue widget components

959f0d9

aaryan610 requested review from anmolsinghbhatia and prateekshourya29 April 9, 2025 12:38

anmolsinghbhatia approved these changes Apr 9, 2025

View reviewed changes

prateekshourya29 approved these changes Apr 9, 2025

View reviewed changes

pushya22 changed the title ~~refactor: work item widget components~~ [WEB-3827] refactor: work item widget components Apr 9, 2025

pushya22 merged commit a3fd616 into preview Apr 9, 2025
5 of 6 checks passed

pushya22 deleted the refactor/issue-widget-components branch April 9, 2025 14:28

coderabbitai bot mentioned this pull request Apr 15, 2025

[WEB-3859] fix: work item links #6930

Merged

1 task

coderabbitai bot mentioned this pull request May 26, 2025

[WEB-3998] feat: settings page revamp #6959

Merged

coderabbitai bot mentioned this pull request Jun 9, 2025

[WEB-4017] fix: hooks and store refactoring for issue-details #7107

Merged

lifeiscontent pushed a commit that referenced this pull request Aug 18, 2025

[WEB-3827] refactor: work item widget components (#6902)

d7ff10e

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[WEB-3827] refactor: work item widget components#6902

[WEB-3827] refactor: work item widget components#6902
pushya22 merged 1 commit intopreviewfrom
refactor/issue-widget-components

aaryan610 commented Apr 9, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Apr 9, 2025 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

makeplane bot commented Apr 9, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

aaryan610 commented Apr 9, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Type of Change

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Apr 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Possibly related PRs

Suggested labels

Suggested reviewers

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

makeplane bot commented Apr 9, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

aaryan610 commented Apr 9, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Apr 9, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)