fix: z-index issue in scalar-client #1145

MrRevengerX · 2025-02-10T14:48:22Z

This PR fixes a small UI issue in the documentation where the "Test Request" popup overlaps with the sidebar, making it difficult to use.

The issue was resolved by updating scalar-client.tsx, specifically by setting .z-overlay to z-index: 999.
The fix was straightforward and ensures the popup no longer overlaps the sidebar.

<div ref={ref}>
  {!loaded && <Loader />}
  <ApiReferenceReact
    configuration={{
      hideModels: true,
      layout: "classic",
      searchHotKey: "" as any,
      darkMode: isDark,
      customCss: `
      .z-overlay{
        z-index: 999;
      }
      `,
      spec: { url: specUrl },
    }}
  />
</div>

Let me know if any changes are needed! 🚀

Summary by CodeRabbit

Chores
- Upgraded a core dependency to maintain stability and ensure ongoing compatibility.

changeset-bot · 2025-02-10T14:48:26Z

⚠️ No Changeset found

Latest commit: f7c0dfd

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

vercel · 2025-02-10T14:48:30Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
docs-uploadthing	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Feb 11, 2025 7:56pm

1 Skipped Deployment

Name	Status	Preview	Comments	Updated (UTC)
legacy-docs-uploadthing	⬜️ Ignored (Inspect)	Visit Preview		Feb 11, 2025 7:56pm

coderabbitai · 2025-02-10T14:48:31Z

Walkthrough

The change updates the version of the @scalar/api-reference-react dependency in the docs/package.json file. The version is bumped from ^0.4.21 to ^0.4.25 without introducing any additional modifications.

Changes

File	Change Summary
docs/package.json	Updated the `@scalar/api-reference-react` dependency version from `^0.4.21` to `^0.4.25`

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>, 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. (Beta)
@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.

markflorkowski · 2025-02-11T18:30:14Z

I noticed we are not on the latest version of @scalar/api-reference-react, did you confirm the issue was present in the latest version too? If possible I would prefer a version bump over custom css.

markflorkowski · 2025-02-11T18:56:42Z

Just spoke with the team over at Scalar, and they are aware of this and will be fixing it in their upcoming release. We should be able to just bump the version when that is out 👍

…engerX/uploadthing into fix-openapidoc-overlapping

coderabbitai

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 6789536 and f7c0dfd.

⛔ Files ignored due to path filters (1)

pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml

📒 Files selected for processing (1)

docs/package.json (1 hunks)

docs/package.json

MrRevengerX · 2025-02-11T19:57:50Z

I noticed we are not on the latest version of @scalar/api-reference-react, did you confirm the issue was present in the latest version too? If possible I would prefer a version bump over custom css.

I hadn't noticed there was a new version. Upgrading to version 0.4.25 fixed the issue. I pushed the version bump and reverted the changes.

Fix z-index issue in scalar-client

6789536

github-actions bot added the 📚 documentation label Feb 10, 2025

vercel bot deployed to Preview – docs-uploadthing February 10, 2025 14:53 View deployment

MrRevengerX changed the title ~~Fix z-index issue in scalar-client~~ fix: z-index issue in scalar-client Feb 11, 2025

MrRevengerX added 2 commits February 12, 2025 01:21

Fix z-index issue in scalar-client

9e30b73

Merge branch 'fix-openapidoc-overlapping' of https://github.com/MrRev…

252c79a

…engerX/uploadthing into fix-openapidoc-overlapping

vercel bot deployed to Preview – docs-uploadthing February 11, 2025 19:53 View deployment

Bump up scalar version

f7c0dfd

github-actions bot removed the 📚 documentation label Feb 11, 2025

vercel bot deployed to Preview – docs-uploadthing February 11, 2025 19:56 View deployment

coderabbitai bot reviewed Feb 11, 2025

View reviewed changes

docs/package.json Show resolved Hide resolved

markflorkowski approved these changes Feb 11, 2025

View reviewed changes

markflorkowski merged commit 30d208d into pingdotgg:main Feb 11, 2025
19 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: z-index issue in scalar-client #1145

fix: z-index issue in scalar-client #1145

MrRevengerX commented Feb 10, 2025 •

edited by coderabbitai bot

Loading

changeset-bot bot commented Feb 10, 2025 •

edited

Loading

vercel bot commented Feb 10, 2025 •

edited

Loading

coderabbitai bot commented Feb 10, 2025 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

markflorkowski commented Feb 11, 2025

markflorkowski commented Feb 11, 2025

coderabbitai bot left a comment

MrRevengerX commented Feb 11, 2025

fix: z-index issue in scalar-client #1145

fix: z-index issue in scalar-client #1145

Conversation

MrRevengerX commented Feb 10, 2025 • edited by coderabbitai bot Loading

Summary by CodeRabbit

changeset-bot bot commented Feb 10, 2025 • edited Loading

⚠️ No Changeset found

vercel bot commented Feb 10, 2025 • edited Loading

coderabbitai bot commented Feb 10, 2025 • edited Loading

Walkthrough

Changes

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

markflorkowski commented Feb 11, 2025

markflorkowski commented Feb 11, 2025

coderabbitai bot left a comment

Choose a reason for hiding this comment

MrRevengerX commented Feb 11, 2025

MrRevengerX commented Feb 10, 2025 •

edited by coderabbitai bot

Loading

changeset-bot bot commented Feb 10, 2025 •

edited

Loading

vercel bot commented Feb 10, 2025 •

edited

Loading

coderabbitai bot commented Feb 10, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)