Make callouts fixed instead of sticky

[bradleycamacho]

Makes callouts fixed instead of sticky.

Sticky banners look really bad and reduce readability on mobile: https://x.com/JeffInTokyo/status/1838725233009893656

[coderabbitai]

Walkthrough

The changes involve a modification to the CSS styles for the div.custom-callouts class. The position property has been updated from sticky to fixed, which alters the element's behavior in relation to the viewport during scrolling. The top property remains at 65px, while the padding and background-color properties remain unchanged.

Changes

File	Change Summary
styles/global.css	Changed position from sticky to fixed for div.custom-callouts; top, padding, and background-color properties remain unchanged.

Suggested reviewers

• sbvegan

---

Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 19e8d85 and 2562bd9.

Files selected for processing (1)

• styles/global.css (1 hunks)

Additional comments not posted (1)

styles/global.css (1)

57-57: ⚠️ Potential issue

Reconsider using position: fixed for callouts

The change from position: sticky to position: fixed for callouts might not achieve the desired improvement in readability, especially on mobile devices. Here are some concerns and suggestions:

1. Fixed positioning keeps the callout always visible, potentially obstructing content on smaller screens. This seems to contradict the PR objective of improving readability.

2. While there's a media query adjusting the top position for mobile devices, fixed positioning on mobile can still be problematic due to limited screen space.

3. The high z-index (9999) might cause stacking context issues with other fixed or absolutely positioned elements.

Consider the following alternatives:

1. Revert to position: sticky but adjust the behavior:

   position: sticky;
   top: 65px;
   max-height: 30vh; /* Limit height on smaller screens */
   overflow-y: auto; /* Allow scrolling within the callout if content is too long */

2. Use position: relative with a dismissible feature:

   position: relative;
   margin-bottom: 1rem;

   Add a close button to allow users to dismiss the callout when they've read it.

3. If fixed positioning is necessary, consider adding a toggle feature:

   position: fixed;
   top: 65px;
   right: 10px;
   max-width: 300px;
   transform: translateX(calc(100% + 10px));
   transition: transform 0.3s ease-in-out;

   Add a JavaScript toggle to slide the callout in and out of view.

To ensure this change doesn't negatively impact other parts of the application, please run the following script:

This will help identify any potential conflicts with other fixed elements or JavaScript interactions that might be affected by this change.

Verification successful

Change Verified: position: fixed is exclusively used in styles/global.css

The modification does not conflict with other elements or JavaScript interactions based on the current codebase.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check for any other fixed positioned elements that might conflict
rg --type css 'position:\s*fixed' --glob '!styles/global.css'

# Check for any JavaScript interactions with callouts
rg --type js 'custom-callouts'

Length of output: 94

---

Script:

#!/bin/bash
# Search for any usage of position: fixed in the entire CSS codebase
rg --type css 'position:\s*fixed'

# Search for any JavaScript interactions with elements related to callouts
rg --type js '(custom-callouts|callout)'

# Search for media queries that adjust positioning of callouts
rg --type css '@media.*\(max-width:\s*767px\).*position'

Length of output: 174

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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 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.

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.

[netlify]

✅ Deploy Preview for docs-optimism ready!

Name	Link
🔨 Latest commit	2562bd9
🔍 Latest deploy log	https://app.netlify.com/sites/docs-optimism/deploys/66f3555f64300200087978b0
😎 Deploy Preview	https://deploy-preview-925--docs-optimism.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[sbvegan]

agreed, lgtm!