fix(clerk-js): Optically align clerk logo in components #6790
Conversation
🦋 Changeset detectedLatest commit: d131882 The changes in this PR will be included in the next version bump. This PR includes changesets to release 0 packagesWhen changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
WalkthroughCardClerkAndPagesTag now forwards props into LogoMarkIconLink and renders it with Changes
Sequence Diagram(s)(omitted — no control-flow or runtime interaction changes warranting a sequence diagram) Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests
📜 Recent review detailsConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Disabled knowledge base sources:
📒 Files selected for processing (1)
🧰 Additional context used📓 Path-based instructions (1).changeset/**📄 CodeRabbit inference engine (.cursor/rules/monorepo.mdc)
Files:
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)
🔇 Additional comments (1)
Tip 👮 Agentic pre-merge checks are now available in preview!Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.
Please see the documentation for more information. Example: reviews:
pre_merge_checks:
custom_checks:
- name: "Undocumented Breaking Changes"
mode: "warning"
instructions: |
Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).Please share your feedback with us on this Discord post. Comment |
@clerk/agent-toolkit
@clerk/astro
@clerk/backend
@clerk/chrome-extension
@clerk/clerk-js
@clerk/dev-cli
@clerk/elements
@clerk/clerk-expo
@clerk/expo-passkeys
@clerk/express
@clerk/fastify
@clerk/localizations
@clerk/nextjs
@clerk/nuxt
@clerk/clerk-react
@clerk/react-router
@clerk/remix
@clerk/shared
@clerk/tanstack-react-start
@clerk/testing
@clerk/themes
@clerk/types
@clerk/upgrade
@clerk/vue
commit: |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
packages/clerk-js/src/ui/elements/Card/CardClerkAndPagesTag.tsx (1)
75-79: Optical nudge OK—please verify cross‑env renderingThe 1px translate aligns the logo, but subpixel rounding can blur on some DPIs/browsers. Please sanity‑check in:
- macOS Safari/Chrome on retina and non‑retina
- Windows Chrome/Edge at 100%/125% zoom
If issues appear, considermarginTop: -1pxor a theme token equivalent instead of transform.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Disabled knowledge base sources:
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
packages/clerk-js/src/ui/elements/Card/CardClerkAndPagesTag.tsx(2 hunks)
🧰 Additional context used
📓 Path-based instructions (9)
packages/clerk-js/src/ui/**/*.{ts,tsx}
📄 CodeRabbit inference engine (.cursor/rules/clerk-js-ui.mdc)
packages/clerk-js/src/ui/**/*.{ts,tsx}: Element descriptors should always be camelCase
Use element descriptors in UI components to enable consistent theming and styling via appearance.elements
Element descriptors should generate unique, stable CSS classes for theming
Element descriptors should handle state classes (e.g., cl-loading, cl-active, cl-error, cl-open) automatically based on component state
Do not render hard-coded values; all user-facing strings must be localized using provided localization methods
Use the useLocalizations hook and localizationKeys utility for all text and error messages
Use the styled system (sx prop, theme tokens, responsive values) for custom component styling
Use useCardState for card-level state, useFormState for form-level state, and useLoadingStatus for loading states
Always use handleError utility for API errors and use translateError for localized error messages
Use useFormControl for form field state, implement proper validation, and handle loading and error states in forms
Use localization keys for all form labels and placeholders
Use element descriptors for consistent styling and follow the theme token system
Use the Card and FormContainer patterns for consistent UI structure
Files:
packages/clerk-js/src/ui/elements/Card/CardClerkAndPagesTag.tsx
**/*.{js,jsx,ts,tsx}
📄 CodeRabbit inference engine (.cursor/rules/development.mdc)
**/*.{js,jsx,ts,tsx}: All code must pass ESLint checks with the project's configuration
Follow established naming conventions (PascalCase for components, camelCase for variables)
Maintain comprehensive JSDoc comments for public APIs
Use dynamic imports for optional features
All public APIs must be documented with JSDoc
Provide meaningful error messages to developers
Include error recovery suggestions where applicable
Log errors appropriately for debugging
Lazy load components and features when possible
Implement proper caching strategies
Use efficient data structures and algorithms
Profile and optimize critical paths
Validate all inputs and sanitize outputs
Implement proper logging with different levels
Files:
packages/clerk-js/src/ui/elements/Card/CardClerkAndPagesTag.tsx
**/*.{js,jsx,ts,tsx,json,css,scss,md,yaml,yml}
📄 CodeRabbit inference engine (.cursor/rules/development.mdc)
Use Prettier for consistent code formatting
Files:
packages/clerk-js/src/ui/elements/Card/CardClerkAndPagesTag.tsx
packages/**/*.{ts,tsx}
📄 CodeRabbit inference engine (.cursor/rules/development.mdc)
TypeScript is required for all packages
Files:
packages/clerk-js/src/ui/elements/Card/CardClerkAndPagesTag.tsx
packages/**/*.{ts,tsx,d.ts}
📄 CodeRabbit inference engine (.cursor/rules/development.mdc)
Packages should export TypeScript types alongside runtime code
Files:
packages/clerk-js/src/ui/elements/Card/CardClerkAndPagesTag.tsx
**/*.{ts,tsx}
📄 CodeRabbit inference engine (.cursor/rules/development.mdc)
Use proper TypeScript error types
**/*.{ts,tsx}: Always define explicit return types for functions, especially public APIs
Use proper type annotations for variables and parameters where inference isn't clear
Avoidanytype - preferunknownwhen type is uncertain, then narrow with type guards
Useinterfacefor object shapes that might be extended
Usetypefor unions, primitives, and computed types
Preferreadonlyproperties for immutable data structures
Useprivatefor internal implementation details
Useprotectedfor inheritance hierarchies
Usepublicexplicitly for clarity in public APIs
Preferreadonlyfor properties that shouldn't change after construction
Prefer composition and interfaces over deep inheritance chains
Use mixins for shared behavior across unrelated classes
Implement dependency injection for loose coupling
Let TypeScript infer when types are obvious
Useconst assertionsfor literal types:as const
Usesatisfiesoperator for type checking without widening
Use mapped types for transforming object types
Use conditional types for type-level logic
Leverage template literal types for string manipulation
Use ES6 imports/exports consistently
Use default exports sparingly, prefer named exports
Use type-only imports:import type { ... } from ...
Noanytypes without justification
Proper error handling with typed errors
Consistent use ofreadonlyfor immutable data
Proper generic constraints
No unused type parameters
Proper use of utility types instead of manual type construction
Type-only imports where possible
Proper tree-shaking friendly exports
No circular dependencies
Efficient type computations (avoid deep recursion)
Files:
packages/clerk-js/src/ui/elements/Card/CardClerkAndPagesTag.tsx
**/*.{jsx,tsx}
📄 CodeRabbit inference engine (.cursor/rules/development.mdc)
**/*.{jsx,tsx}: Use error boundaries in React components
Minimize re-renders in React components
**/*.{jsx,tsx}: Always use functional components with hooks instead of class components
Follow PascalCase naming for components:UserProfile,NavigationMenu
Keep components focused on a single responsibility - split large components
Limit component size to 150-200 lines; extract logic into custom hooks
Use composition over inheritance - prefer smaller, composable components
Export components as named exports for better tree-shaking
One component per file with matching filename and component name
Use useState for simple state management
Use useReducer for complex state logic
Implement proper state initialization
Use proper state updates with callbacks
Implement proper state cleanup
Use Context API for theme/authentication
Implement proper state selectors
Use proper state normalization
Implement proper state persistence
Use React.memo for expensive components
Implement proper useCallback for handlers
Use proper useMemo for expensive computations
Implement proper virtualization for lists
Use proper code splitting with React.lazy
Implement proper cleanup in useEffect
Use proper refs for DOM access
Implement proper event listener cleanup
Use proper abort controllers for fetch
Implement proper subscription cleanup
Use proper HTML elements
Implement proper ARIA attributes
Use proper heading hierarchy
Implement proper form labels
Use proper button types
Implement proper focus management
Use proper keyboard shortcuts
Implement proper tab order
Use proper skip links
Implement proper focus traps
Implement proper error boundaries
Use proper error logging
Implement proper error recovery
Use proper error messages
Implement proper error fallbacks
Use proper form validation
Implement proper error states
Use proper error messages
Implement proper form submission
Use proper form reset
Use proper component naming
Implement proper file naming
Use proper prop naming
Implement proper...
Files:
packages/clerk-js/src/ui/elements/Card/CardClerkAndPagesTag.tsx
**/*.{js,ts,tsx,jsx}
📄 CodeRabbit inference engine (.cursor/rules/monorepo.mdc)
Support multiple Clerk environment variables (CLERK_, NEXT_PUBLIC_CLERK_, etc.) for configuration.
Files:
packages/clerk-js/src/ui/elements/Card/CardClerkAndPagesTag.tsx
**/*.tsx
📄 CodeRabbit inference engine (.cursor/rules/react.mdc)
**/*.tsx: Use proper type definitions for props and state
Leverage TypeScript's type inference where possible
Use proper event types for handlers
Implement proper generic types for reusable components
Use proper type guards for conditional rendering
Files:
packages/clerk-js/src/ui/elements/Card/CardClerkAndPagesTag.tsx
🧬 Code graph analysis (1)
packages/clerk-js/src/ui/elements/Card/CardClerkAndPagesTag.tsx (1)
packages/clerk-js/src/ui/styledSystem/types.ts (1)
PropsOfComponent(58-58)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)
- GitHub Check: Analyze (actions)
- GitHub Check: Analyze (javascript-typescript)
- GitHub Check: semgrep-cloud-platform/scan
- GitHub Check: semgrep-cloud-platform/scan
| const LogoMarkIconLink = (props: PropsOfComponent<typeof Link>) => { | ||
| return ( | ||
| <Link | ||
| href='https://go.clerk.com/components' | ||
| colorScheme='inherit' | ||
| isExternal | ||
| aria-label='Clerk logo' | ||
| {...props} | ||
| > |
There was a problem hiding this comment.
❓ Verification inconclusive
Don’t allow callers to override invariant Link props (href, isExternal, aria-label)
Spreading {...props} after fixed props lets consumers change href/isExternal/aria-label, which weakens UX and can be a security posture gap. Also: localize the aria label, add default element descriptors, and prefer an explicit return type.
Minimal safe fix (preserve invariants by ordering):
- <Link
- href='https://go.clerk.com/components'
- colorScheme='inherit'
- isExternal
- aria-label='Clerk logo'
- {...props}
- >
+ <Link
+ {...props}
+ href='https://go.clerk.com/components'
+ colorScheme='inherit'
+ isExternal
+ aria-label='Clerk logo'
+ elementDescriptor='logoMarkIconLink'
+ >Prefer stricter surface (only allow styling/theming props):
-const LogoMarkIconLink = (props: PropsOfComponent<typeof Link>) => {
+type LogoMarkIconLinkProps = Pick<PropsOfComponent<typeof Link>, 'sx' | 'className' | 'elementDescriptor' | 'elementId'>;
+const LogoMarkIconLink = (props: LogoMarkIconLinkProps): JSX.Element => {Localize the aria label (illustrative—use your localization util/key):
- aria-label='Clerk logo'
+ aria-label={/* t('clerk.logoAriaLabel') */ 'Clerk logo'}Optional: add an element descriptor to the icon for theming:
<Icon
icon={LogoMark}
+ elementDescriptor="logoMarkIcon"
sx={theme => ({
width: theme.sizes.$12,
height: theme.sizes.$3x5,
})}
/>Note: Ensure the Link component sets rel="noopener noreferrer" when isExternal is true (if not already handled internally).
Prevent callers from overriding invariant Link props
Spreading {...props} after fixed props allows consumers to override href / isExternal / aria-label (UX/security risk). Fix required.
File: packages/clerk-js/src/ui/elements/Card/CardClerkAndPagesTag.tsx (lines 93–101)
Minimal safe fix (preserve invariants by ordering):
- <Link
- href='https://go.clerk.com/components'
- colorScheme='inherit'
- isExternal
- aria-label='Clerk logo'
- {...props}
- >
+ <Link
+ {...props}
+ href='https://go.clerk.com/components'
+ colorScheme='inherit'
+ isExternal
+ aria-label='Clerk logo'
+ elementDescriptor='logoMarkIconLink'
+ >Recommended extras (brief):
- Narrow public surface: type LogoMarkIconLinkProps = Pick<PropsOfComponent, 'sx' | 'className' | 'elementDescriptor' | 'elementId'>; const LogoMarkIconLink = (props: LogoMarkIconLinkProps): JSX.Element => { ... }
- Localize aria-label (use i18n key).
- Ensure Link sets rel="noopener noreferrer" when isExternal (if not already handled).
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| const LogoMarkIconLink = (props: PropsOfComponent<typeof Link>) => { | |
| return ( | |
| <Link | |
| href='https://go.clerk.com/components' | |
| colorScheme='inherit' | |
| isExternal | |
| aria-label='Clerk logo' | |
| {...props} | |
| > | |
| const LogoMarkIconLink = (props: PropsOfComponent<typeof Link>) => { | |
| return ( | |
| <Link | |
| {...props} | |
| href='https://go.clerk.com/components' | |
| colorScheme='inherit' | |
| isExternal | |
| aria-label='Clerk logo' | |
| elementDescriptor='logoMarkIconLink' | |
| > |
🤖 Prompt for AI Agents
packages/clerk-js/src/ui/elements/Card/CardClerkAndPagesTag.tsx around lines
93–101: the component spreads {...props} after fixed Link props which allows
callers to override invariants (href, isExternal, aria-label); reorder and/or
pick-safe props so fixed props cannot be overridden and only allow a small safe
set from callers. Change the component to accept a narrowed
LogoMarkIconLinkProps type (e.g. Pick<PropsOfComponent<typeof Link>,
'sx'|'className'|'elementDescriptor'|'elementId'>) and spread those props into
Link before or instead of spreading arbitrary props; ensure
href='https://go.clerk.com/components', isExternal, aria-label remain
hard-coded, and add rel="noopener noreferrer" to the Link when isExternal if not
already applied; optionally replace aria-label with an i18n key.
|
Marking as draft until I get final approval from design. |
Description
Checklist
pnpm testruns as expected.pnpm buildruns as expected.Type of change
Summary by CodeRabbit
Bug Fixes
New Features
Chores