Skip to content

fix(www): analytics bento code snippet is not readable#2311

Merged
chronark merged 2 commits intounkeyed:mainfrom
unrenamed:fix/analytics-code-snippets-not-readable
Oct 12, 2024
Merged

fix(www): analytics bento code snippet is not readable#2311
chronark merged 2 commits intounkeyed:mainfrom
unrenamed:fix/analytics-code-snippets-not-readable

Conversation

@unrenamed
Copy link
Contributor

@unrenamed unrenamed commented Oct 10, 2024

What does this PR do?

  • Adds hover effect to analytics bento removing gradient background
  • Makes copy code button sticky to top-right corner
  • Implements independent vertical scrolls for language switcher and code editor

Fixes #2216

ℹ️ The screenshots below show the updated (top) version of the Realtime Analytics bento and the previous version (bottom) on the landing page.

Screenshot 2024-10-10 at 21 45 24 Screenshot 2024-10-10 at 21 46 10 Screenshot 2024-10-10 at 21 48 19

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • Chore (refactoring code, technical debt, workflow improvements)
  • Enhancement (small improvements)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How should this be tested?

  • Test A
    • Go to http://go.unkey.com
    • Scroll to the Realtime Analytics section
    • Click Show API Code
    • Ensure the code editor is not fully visible and readable on mouse hover
    • Ensure the code editor has an independent vertical scroll so that the entire code can be viewed
    • Ensure the copy button is sticky

Checklist

Required

  • Filled out the "How to test" section in this PR
  • Read Contributing Guide
  • Self-reviewed my own code
  • Commented on my code in hard-to-understand areas
  • Ran pnpm build
  • Ran pnpm fmt
  • Checked for warnings, there are none
  • Removed all console.logs
  • Merged the latest changes from main onto my branch with git pull origin main
  • My changes don't cause any responsiveness issues

Appreciated

  • If a UI change was made: Added a screen recording or screenshots to this PR
  • Updated the Unkey Docs if changes were necessary

Summary by CodeRabbit

  • New Features

    • Introduced a CopyCodeSnippetButton for easier code copying.
    • Enhanced LanguageSwitcher for improved styling and overflow management.
  • Improvements

    • Updated layout and styling of the AnalyticsBento component for a better user experience.
    • Added flexibility in styling through a new className prop in the BentoText function.

- add hover effect to analytics bento removing gradient background
- make copy code button sticky to top-right corner
- impl independent vertical scrolls for language switcher and code editor
@changeset-bot
Copy link

changeset-bot bot commented Oct 10, 2024

⚠️ No Changeset found

Latest commit: 716f6cc

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
Copy link

vercel bot commented Oct 10, 2024

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

Name Status Preview Comments Updated (UTC)
dashboard ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 11, 2024 1:39pm
engineering ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 11, 2024 1:39pm
play ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 11, 2024 1:39pm
workflows ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 11, 2024 1:39pm
www ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 11, 2024 1:39pm

@vercel
Copy link

vercel bot commented Oct 10, 2024

@unrenamed is attempting to deploy a commit to the Unkey Team on Vercel.

A member of the Team first needs to authorize it.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 10, 2024

📝 Walkthrough

Walkthrough

The pull request introduces modifications to the AnalyticsBento component within the analytics-bento.tsx file. Key changes include the addition of new class names for improved styling, structural adjustments for better layout, and the implementation of a CopyCodeSnippetButton component to enhance user interaction. The BentoText function has been updated to accept a className prop, allowing for flexible styling. Overall, these changes aim to improve the component's user interface and experience without altering its core functionality.

Changes

File Path Change Summary
apps/www/components/analytics/analytics-bento.tsx - Added new class names and structural adjustments for styling.
- Modified BentoText to accept a className prop.
- Introduced CopyCodeSnippetButton for code copying functionality.
- Adjusted LanguageSwitcher structure for styling consistency.

Assessment against linked issues

Objective Addressed Explanation
Improve readability of the Analytics API section (#2216)

Possibly related PRs

  • fix(www): add missing langs to analytics bento #2214: This PR modifies the analytics-bento.tsx file, which is directly related to the main PR's changes in the same file, enhancing the functionality of the AnalyticsBento component by adding new language support and code snippet features.

Suggested labels

Bug, 🕹️ oss.gg, :joystick: 150 points, hacktoberfest

Suggested reviewers

  • mcstepp
  • chronark
  • perkinsjr
  • MichaelUnkey

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

@github-actions
Copy link
Contributor

github-actions bot commented Oct 10, 2024

Thank you for following the naming conventions for pull request titles! 🙏

@github-actions github-actions bot added 🕹️ 150 points Bug Something isn't working labels Oct 10, 2024
@vercel vercel bot temporarily deployed to Preview – engineering October 10, 2024 19:10 Inactive
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: 0

🧹 Outside diff range and nitpick comments (4)
apps/www/components/analytics/analytics-bento.tsx (4)

70-85: Improved styling and layout for AnalyticsBento component.

The changes enhance the visual appeal and interactivity of the component. The use of the cn utility function for managing class names is a good practice. Consider extracting the long className string into a separate constant for better readability.

+ const analyticsBentoClasses = cn(
+   "group relative mt-[80px] w-full h-[640px] analytics-linear-gradientborder border-white/10",
+   "flex justify-center xl:justify-start items-end rounded-3xl",
+ );

  <div
-   className={cn(
-     "group relative mt-[80px] w-full h-[640px] analytics-linear-gradientborder border-white/10",
-     "flex justify-center xl:justify-start items-end rounded-3xl",
-   )}
+   className={analyticsBentoClasses}
  >

77-80: Enhanced visual design and interactivity.

The addition of the LightSvg component and the modifications to AnalyticsStars improve the overall visual appeal. The new gradient background div with hover effect enhances interactivity.

Consider adding an aria-hidden="true" attribute to the LightSvg component to improve accessibility, as it's a decorative element:

- <LightSvg className="absolute hidden md:flex top-[-180px] left-0 lg:left-[300px] z-50 pointer-events-none" />
+ <LightSvg className="absolute hidden md:flex top-[-180px] left-0 lg:left-[300px] z-50 pointer-events-none" aria-hidden="true" />

819-826: Enhanced flexibility for BentoText component styling.

The addition of the className prop improves the component's reusability and allows for more flexible styling from parent components. The use of the cn utility function to combine default and custom classes is a good practice.

Consider using a more specific type for the className prop:

- export function BentoText({ className }: { className?: string }) {
+ export function BentoText({ className }: { className?: string | undefined }) {

This change explicitly allows undefined as a valid type for className, which is more accurate and consistent with React's prop types.


Line range hint 1-1186: Consider splitting the file into smaller, focused components.

While the changes made are good, this file contains multiple components and is quite large. Consider splitting it into separate files for each main component (e.g., AnalyticsBento.tsx, AnalyticsApiView.tsx, AnalyticsWebAppView.tsx, etc.) to improve maintainability and readability.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 0608fee and 77bbd42.

📒 Files selected for processing (1)
  • apps/www/components/analytics/analytics-bento.tsx (4 hunks)
🧰 Additional context used
🔇 Additional comments (1)
apps/www/components/analytics/analytics-bento.tsx (1)

81-85: Improved flexibility for BentoText component.

The addition of the className prop to the BentoText component enhances its reusability. The conditional className based on the showApi state allows for dynamic styling, which is a good practice for responsive design.

@vercel vercel bot temporarily deployed to Preview – engineering October 11, 2024 13:31 Inactive
@vercel vercel bot temporarily deployed to Preview – www October 11, 2024 13:37 Inactive
@vercel vercel bot temporarily deployed to Preview – play October 11, 2024 13:38 Inactive
@vercel vercel bot temporarily deployed to Preview – workflows October 11, 2024 13:39 Inactive
@vercel vercel bot temporarily deployed to Preview – dashboard October 11, 2024 13:39 Inactive
@chronark chronark added this pull request to the merge queue Oct 12, 2024
@chronark
Copy link
Collaborator

nice work

Merged via the queue into unkeyed:main with commit 3c04102 Oct 12, 2024
@oss-gg
Copy link

oss-gg bot commented Oct 12, 2024

Awarding unrenamed: 150 points 🕹️ Well done! Check out your new contribution on oss.gg/unrenamed

AkshayBandi027 pushed a commit to AkshayBandi027/unkey that referenced this pull request Oct 14, 2024
- add hover effect to analytics bento removing gradient background
- make copy code button sticky to top-right corner
- impl independent vertical scrolls for language switcher and code editor
AkshayBandi027 pushed a commit to AkshayBandi027/unkey that referenced this pull request Oct 14, 2024
- add hover effect to analytics bento removing gradient background
- make copy code button sticky to top-right corner
- impl independent vertical scrolls for language switcher and code editor
chronark added a commit that referenced this pull request Oct 28, 2024
* fix:breadcrum-cache-issue

* chore:rename-revalidateMytag

* refactor: move-revalidateTag

* refactor: extract tags into reusable utility

* feat: add template

* Update 3_follow_the_unkey_x_account.md (#2323)

* fix: capture uniqueness error and return it correctly (#2337)

* docs: getVerifications instead of get (#2329)

* Update 3_follow_the_unkey_x_account.md (#2324)

Followed unkey on Twitter

Co-authored-by: Andreas Thomas <[email protected]>

* fix: transaction ...: in use: for query (#2278)

* fix: transaction ...: in use: for query
- Fixes #2197
- The error is caused by the cache revalidation happening in the background, so we have a racecondition with the other queries we are running in the insertGenericAuditLogs function

* docs: explain for future self

* fix: another racecondition
also bulk insert auditLogs and auditLogTargets

* [autofix.ci] apply automated fixes

---------

Co-authored-by: chronark <[email protected]>
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>

* fix: handle undefined ratelimits

* Update 3_follow_the_unkey_x_account.md (#2338)

* fix: handle case when blogs array is empty

* [oss.gg] side quest : added another framework; hono on cloudflare workers. (#2345)

* fix: weird spacing in changelog by removing the extra gap (#2340)

* fix: weird spacing in changelog

* feat: formatted

* oss.gg: create a template for ratelimiting a oak server in deno with unkey (#2308)

Co-authored-by: Andreas Thomas <[email protected]>

* follow unkey on X #2252 (#2315)

Co-authored-by: Your Name <[email protected]>

* Follow the Unkey X account: @unkeydev Complete! (#2332)

* Update 3_follow_the_unkey_x_account.md

* Update 3_follow_the_unkey_x_account.md

---------

Co-authored-by: Andreas Thomas <[email protected]>

* fix(www): analytics bento code snippet is not readable (#2311)

- add hover effect to analytics bento removing gradient background
- make copy code button sticky to top-right corner
- impl independent vertical scrolls for language switcher and code editor

* Update 7_create_a_template.md

* Update 7_create_a_template.md

* chore(deps-dev): bump @content-collections/core from 0.6.2 to 0.7.2 (#2255)

Bumps @content-collections/core from 0.6.2 to 0.7.2.

---
updated-dependencies:
- dependency-name: "@content-collections/core"
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* fix: order audit logs by time, show latest on top (#2295)

* feat: add template

* feat: Unkey FastAPI boilerplate (#2307)

* feat: add template

* feat: follow unkey on X (#2357)

* Update 6_record_onboarding.md (#2301)

* fix: reset input fields in API delete dialog after reopening (#2316)

* fix: reset input fields in API delete dialog after reopening

* refactor: remove unnecessary useEffect and utilize existing onOpenChange function for dialog

* refactor: removed unused imports

* Update 3_follow_the_unkey_x_account.md (#2364)

Added name to the followed list.

Co-authored-by: Andreas Thomas <[email protected]>

* ci: add label

* feat: add hover to input fields

* Added gaps and width for md (#2371)

* docs: update overview.mdx (#2384)

avaliable -> available

* oss.gg side quest 3_follow_the_unkey_x_account.md (#2399)

Followed the unkey x account

* feat: Following unkey acc on twitter #2407 (#2408)

* Feat: Followed Unkey on X

* Feat: Followed Unkey on Twitter

---------

Co-authored-by: Andreas Thomas <[email protected]>

* resolve merge conflicts

* resolve merge conflicts

---------

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: chronark <[email protected]>
Co-authored-by: Emily Marie Ahtúnan <[email protected]>
Co-authored-by: Harsh Shrikant Bhat <[email protected]>
Co-authored-by: Aritra Sadhukhan <[email protected]>
Co-authored-by: Flo <[email protected]>
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
Co-authored-by: Devang Rakholiya <[email protected]>
Co-authored-by: Prabin <[email protected]>
Co-authored-by: ZiaCodes <[email protected]>
Co-authored-by: Devansh Baghel <[email protected]>
Co-authored-by: Shreenarayan jaiswal <[email protected]>
Co-authored-by: Your Name <[email protected]>
Co-authored-by: Chirag Arora <[email protected]>
Co-authored-by: Nazar Poshtarenko <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Saketh Pavan Goti <[email protected]>
Co-authored-by: Teddy ASSIH <[email protected]>
Co-authored-by: Vardhaman Bhandari <[email protected]>
Co-authored-by: Atharva_404 <[email protected]>
Co-authored-by: Rishi <[email protected]>
Co-authored-by: Ikko Eltociear Ashimine <[email protected]>
Co-authored-by: Ayan Mondal <[email protected]>
Co-authored-by: Kunal Arya <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Bug Something isn't working

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Landing Page: Analytics api section is not readable

2 participants