made "Create New Key" always accessible #2414

[FaheemOnHub]

What does this PR do?

Initial Problem: The "Create New Key" button was positioned below the entire list of API cards, which can be extensive. When trying to create a new root key with workspace-only permissions, users need to scroll to the bottom of the page. This creates an inconvenient user experience, especially when the list of APIs is long. Ideally, the button should be sticky and always visible at the bottom of the window, regardless of the length of the API list.

Solution: Made "Create New Key" button sticky , so there is no need to scroll to bottom.
Fixes # (#2414)
Fixes #2414

Type of change: added some tailwind classes and some DOM manipulation

• 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 : Go to Root keys, and create a new root key , see the button to Create new Key is sticky and there is no need to scroll to bottom

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:

Screen.Recording.2024-10-15.at.10.35.19.PM.mov

Summary by CodeRabbit

• New Features

  • Enhanced readability of workspace settings descriptions in the SettingsLayout component.
  • Improved structure and clarity in the settings root keys components, including a sticky footer for the new key button.

• Bug Fixes

  • Removed unnecessary spaces and commas in the component code for cleaner rendering.

• Style

  • Improved formatting and indentation in the Navbar component and other related files for better code clarity.

• Documentation

  • Updated API type definitions for clarity and marked deprecated methods to guide future usage.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 32e5024

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

[CLAassistant]

All committers have signed the CLA.

[vercel]

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

Name	Status	Preview	Comments	Updated (UTC)
engineering	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Oct 15, 2024 5:21pm

[vercel]

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

A member of the Team first needs to authorize it.

[coderabbitai]

Caution

Review failed

The pull request is closed.

📝 Walkthrough

📝 Walkthrough

Walkthrough

The pull request introduces several formatting and readability improvements across multiple components of the dashboard application. Key changes include restructuring JSX layouts, adjusting type definitions in TypeScript files, and enhancing the visual presentation of elements. Notably, the addition of a Button component for creating a new key aims to address user experience concerns related to accessibility. Overall, the functionality of the components remains unchanged.

Changes

File Path	Change Summary
apps/dashboard/app/(app)/settings/layout.tsx	Minor formatting change in SettingsLayout for improved readability.
apps/dashboard/app/(app)/settings/root-keys/new/client.tsx apps/dashboard/app/(app)/settings/root-keys/new/page.tsx apps/dashboard/app/(app)/settings/root-keys/page.tsx	Restructured imports, layout adjustments, and improved JSX structure for readability.
apps/dashboard/components/dashboard/navbar.tsx	Restructured JSX layout and improved formatting in Navbar component.
packages/api/src/openapi.d.ts	Updates to TypeScript definitions for clarity and usability; no changes to exported entities.

Assessment against linked issues

Objective	Addressed	Explanation
"Create New Key" button should be sticky at the bottom of the viewport (Issue #2414)	❌	The button's position was modified but not made sticky.

Possibly related PRs

• feat: Adds toggle for root key permissions #2062: Changes in client.tsx related to managing permissions, focusing on improving the user interface.
• fix: A user can collapse/expand APIs when creating a new root key #2124: Modifications to client.tsx introducing collapsible UI components for displaying API permissions.
• feat(dashboard): URL state synchronization for /settings/root-keys/new route #2218: Updates in client.tsx regarding state management and permission selection.
• fix: inconsistent API spelling in docs and dashboard #2275: Updates to spelling of "API" in various components for consistency.

Suggested labels

Feature, :joystick: 150 points

Suggested reviewers

• mcstepp
• chronark
• perkinsjr

---

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.

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]

Hey there and thank you for opening this pull request! 👋🏼

We require pull request titles to follow the Conventional Commits specification and it looks like your proposed title needs to be adjusted.
Here is an example:

<type>[optional scope]: <description>
fix: I fixed something for Unkey

Details:

No release type found in pull request title "made "Create New Key" always accessible #2414". Add a prefix to indicate what kind of release this pull request corresponds to. For reference, see https://www.conventionalcommits.org/

Available types:
 - feat: A new feature
 - fix: A bug fix
 - docs: Documentation only changes
 - style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
 - refactor: A code change that neither fixes a bug nor adds a feature
 - perf: A code change that improves performance
 - test: Adding missing tests or correcting existing tests
 - build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
 - ci: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
 - chore: Other changes that don't modify src or test files
 - revert: Reverts a previous commit

[perkinsjr]

This issue is assigned to someone else, please do not submit PRs for issues that aren't assigned to you