8000 feat: use post messaging to transmit route changes by elibosley · Pull Request #273 · unraid/docs · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

feat: use post messaging to transmit route changes #273

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
May 12, 2025
Merged

feat: use post messaging to transmit route changes #273

merged 1 commit into from
May 12, 2025

Conversation

elibosley
Copy link
Member
@elibosley elibosley commented May 11, 2025 •
edited by coderabbitai bot
Loading

Before Submitting This PR, Please Ensure You Have Completed The Following:

  1. Are internal links to wiki documents using relative file links?
  2. Are all new documentation files lowercase, with dash separated names (ex. unraid-os.mdx)?
  3. Are all assets (images, etc), located in an assets/ subfolder next to the .md/mdx files?
  4. Have you checked to ensure there aren't other open Pull Requests for the same update/change?
  5. Is the build succeeding?

Summary by CodeRabbit

  • New Features
    • The app now sends navigation updates to the parent window when running inside an iframe, allowing the parent to receive real-time information about navigation events within the iframe.

@coderabbitai coderabbitai
Copy link
Contributor
coderabbitai bot commented May 11, 2025 •
edited
Loading

Walkthrough

The IframeModeProvider component was updated to track URL changes using the useLocation hook. When running inside an iframe, it now sends navigation details to the parent window via postMessage whenever the location changes, in addition to managing the data-iframe attribute on the document element.

Changes

File(s) Change Summary
src/components/IFrame/iFrameHelper.tsx Added use of useLocation to detect URL changes and send navigation details to parent window via postMessage when inside an iframe.

Sequence Diagram(s)

sequenceDiagram
    participant IframeApp as IframeModeProvider
    participant ParentWindow

    IframeApp->IframeApp: Detect location change (useLocation)
    alt Inside iframe
        IframeApp->ParentWindow: window.parent.postMessage({ pathname, search, hash, href })
    end
Loading

Suggested reviewers

  • zackspear

Poem

In a frame within a frame, we dwell,
Now sending news of URLs as well.
With every hop, the parent knows,
Where the inner rabbit goes.
🐇✨
Messages leap, navigation flows—
Onward through the iframe, the journey shows!

✨ Finishing Touches
  • 📝 Generate Docstrings
🪧 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.

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.

coderabbitai[bot]
coderabbitai bot reviewed May 11, 2025
View reviewed changes
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: 1

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 71cc486 and dbfc657.

📒 Files selected for processing (1)
  • src/components/IFrame/iFrameHelper.tsx (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: build
  • GitHub Check: AWS Amplify Console Web Preview
🔇 Additional comments (2)
src/components/IFrame/iFrameHelper.tsx (2)

2-2: LGTM: Adding useLocation hook import

The new import is necessary for tracking location changes within the iframe.

9-10: LGTM: Proper hook initialization

Good use of the useLocation hook to track the current URL location.

@aws-amplify-us-west-2 AWS Amplify (us-west-2)
Copy link

This pull request is automatically being deployed by Amplify Hosting (learn more).

Access this pull request here: https://pr-273.d1o5s833kbd339.amplifyapp.com

@elibosley elibosley requested a review from zackspear May 12, 2025 15:06
@elibosley elibosley merged commit ac2cfb5 into main May 12, 2025
3 checks passed
@elibosley elibosley deleted the feat/post-message-route-changes branch May 12, 2025 15:12
This was referenced May 14, 2025
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] approved these changes

@zackspear zackspear Awaiting requested review from zackspear

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@elibosley
0