Skip to content

[WIKI-523] refactor: assets item component#7346

Merged
pushya22 merged 2 commits intopreviewfrom
refactor/navigation-pane
Jul 7, 2025
Merged

[WIKI-523] refactor: assets item component#7346
pushya22 merged 2 commits intopreviewfrom
refactor/navigation-pane

Conversation

@aaryan610
Copy link
Member

@aaryan610 aaryan610 commented Jul 4, 2025

Description

This PR refactors the asset item component in page navigation pane.

Type of Change

  • Code refactoring

Summary by CodeRabbit

  • New Features

    • Improved breadcrumb navigation by refining how page names are displayed in dropdowns.
  • Refactor

    • Optimized asset handling in the navigation pane for better performance and maintainability.
    • Enhanced asset item components to include additional properties for asset source and download URLs.
    • Updated navigation pane tab query parameter for clearer identification.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jul 4, 2025

Walkthrough

The changes update how page names are displayed in a breadcrumb navigation dropdown by applying a utility function, and extend asset item props with two new string properties for asset sources. Additionally, asset URL generation in a component is refactored to use memoized values, and these URLs are now passed as props to a child component. The constant for a query parameter key was also renamed.

Changes

File(s) Change Summary
.../projects/(detail)/[projectId]/pages/(detail)/header.tsx Uses getPageName(page?.name) instead of page?.name for the breadcrumb navigation dropdown title.
.../components/pages/navigation-pane/tab-panels/assets.tsx Adds assetSrc and assetDownloadSrc string properties to TAdditionalPageNavigationPaneAssetItemProps.
.../core/components/pages/navigation-pane/tab-panels/assets.tsx Refactors asset URL generation to use useMemo, passes memoized URLs as props, and updates formatting.
.../core/components/pages/navigation-pane/index.ts Renames constant PAGE_NAVIGATION_PANE_TABS_QUERY_PARAM value from "sidebarTab" to "paneTab".

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant BreadcrumbDropdown
    participant getPageName

    User->>BreadcrumbDropdown: Open navigation dropdown
    BreadcrumbDropdown->>getPageName: Call with page?.name
    getPageName-->>BreadcrumbDropdown: Returns formatted page name
    BreadcrumbDropdown-->>User: Display formatted page name in title
Loading
sequenceDiagram
    participant AssetItem
    participant useMemo
    participant AdditionalAssetItem

    AssetItem->>useMemo: Compute assetSrc and assetDownloadSrc
    useMemo-->>AssetItem: Return memoized URLs
    AssetItem->>AdditionalAssetItem: Pass assetSrc and assetDownloadSrc as props
    AdditionalAssetItem-->>AssetItem: Render asset with provided URLs
Loading

Possibly related PRs

Suggested reviewers

  • Palanikannan1437
  • prateekshourya29

Poem

A breadcrumb’s name, now polished bright,
Through getPageName it finds the light.
Assets gain new strings to show,
Their sources clear, their downloads flow.
Memoized and neatly passed,
These changes hop along so fast—
A rabbit’s joy in code amassed! 🐇


📜 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 5b874b0 and f78c157.

📒 Files selected for processing (1)
  • apps/web/core/components/pages/navigation-pane/index.ts (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • apps/web/core/components/pages/navigation-pane/index.ts
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Analyze (javascript)
✨ 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in this 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.

@pushya22 pushya22 changed the title [WEB-523] refactor: assets item component [WIKI-523] refactor: assets item component Jul 7, 2025
@makeplane
Copy link

makeplane bot commented Jul 7, 2025

Pull Request Linked with Plane Work Items

Comment Automatically Generated by Plane

@pushya22 pushya22 merged commit e306a92 into preview Jul 7, 2025
5 of 6 checks passed
@pushya22 pushya22 deleted the refactor/navigation-pane branch July 7, 2025 12:34
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.

3 participants