-
Notifications
You must be signed in to change notification settings - Fork 393
refactor(clerk-js): Update text/icon color usages pt1 #6697
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
refactor(clerk-js): Update text/icon color usages pt1 #6697
Conversation
The latest updates on your projects. Learn more about Vercel for GitHub.
|
🦋 Changeset detectedLatest commit: 2db0a18 The changes in this PR will be included in the next version bump. This PR includes changesets to release 3 packages
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 |
WalkthroughStyling updates apply theme-based muted foreground colors to icons in MembersSearch and PaymentSourceRow, and set secondary colorScheme for the secondary identifier in UserPreview. A changeset is added to publish these UI color tweaks as a patch. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Assessment against linked issues
Poem
✨ Finishing Touches🧪 Generate unit tests
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
Status, Documentation and Community
|
@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: |
There was a problem hiding this 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
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
packages/clerk-js/src/ui/components/OrganizationProfile/MembersSearch.tsx (1)
96-98
: Localize the aria-labelAvoid hard-coded user-facing strings. Use the same localization key as the placeholder for the input’s aria-label.
Apply this diff:
- aria-label='Search' + aria-label={t(localizationKeys('organizationProfile.membersPage.action__search'))}
🧹 Nitpick comments (2)
packages/clerk-js/src/ui/components/OrganizationProfile/MembersSearch.tsx (1)
42-65
: Clear the debounce timer on unmountMinor: add cleanup to prevent late triggers if the component unmounts mid-debounce.
Apply this diff:
function handleKeyUp() { if (debounceTimer.current) { clearTimeout(debounceTimer.current); } debounceTimer.current = setTimeout(() => { onQueryTrigger(value.trim()); }, membersSearchDebounceMs); } + + // Cleanup any pending debounce on unmount + useEffect(() => { + return () => { + if (debounceTimer.current) { + clearTimeout(debounceTimer.current); + } + }; + }, []);packages/clerk-js/src/ui/components/UserButton/SessionActions.tsx (1)
142-149
: Hoist static theming helpers to module scopeAvoid re-creating these functions on each render; keeps prop references stable and can reduce child re-renders.
Apply this diff in-place:
- const commonActionSx: ThemableCssProp = t => ({ - color: t.colors.$colorForeground, - }); - - const commonActionIconSx: ThemableCssProp = t => ({ - color: t.colors.$colorMutedForeground, - }); + // hoisted to module scope (see added snippet below)Add this at module scope (above the component):
// Module-scope theming helpers to keep stable references const commonActionSx: ThemableCssProp = t => ({ color: t.colors.$colorForeground, }); const commonActionIconSx: ThemableCssProp = t => ({ color: t.colors.$colorMutedForeground, });
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (4)
packages/clerk-js/src/ui/components/OrganizationProfile/MembersSearch.tsx
(1 hunks)packages/clerk-js/src/ui/components/PaymentSources/PaymentSourceRow.tsx
(1 hunks)packages/clerk-js/src/ui/components/UserButton/SessionActions.tsx
(3 hunks)packages/clerk-js/src/ui/elements/UserPreview.tsx
(1 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/UserPreview.tsx
packages/clerk-js/src/ui/components/PaymentSources/PaymentSourceRow.tsx
packages/clerk-js/src/ui/components/UserButton/SessionActions.tsx
packages/clerk-js/src/ui/components/OrganizationProfile/MembersSearch.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/UserPreview.tsx
packages/clerk-js/src/ui/components/PaymentSources/PaymentSourceRow.tsx
packages/clerk-js/src/ui/components/UserButton/SessionActions.tsx
packages/clerk-js/src/ui/components/OrganizationProfile/MembersSearch.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/UserPreview.tsx
packages/clerk-js/src/ui/components/PaymentSources/PaymentSourceRow.tsx
packages/clerk-js/src/ui/components/UserButton/SessionActions.tsx
packages/clerk-js/src/ui/components/OrganizationProfile/MembersSearch.tsx
packages/**/*.{ts,tsx}
📄 CodeRabbit inference engine (.cursor/rules/development.mdc)
TypeScript is required for all packages
Files:
packages/clerk-js/src/ui/elements/UserPreview.tsx
packages/clerk-js/src/ui/components/PaymentSources/PaymentSourceRow.tsx
packages/clerk-js/src/ui/components/UserButton/SessionActions.tsx
packages/clerk-js/src/ui/components/OrganizationProfile/MembersSearch.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/UserPreview.tsx
packages/clerk-js/src/ui/components/PaymentSources/PaymentSourceRow.tsx
packages/clerk-js/src/ui/components/UserButton/SessionActions.tsx
packages/clerk-js/src/ui/components/OrganizationProfile/MembersSearch.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
Avoidany
type - preferunknown
when type is uncertain, then narrow with type guards
Useinterface
for object shapes that might be extended
Usetype
for unions, primitives, and computed types
Preferreadonly
properties for immutable data structures
Useprivate
for internal implementation details
Useprotected
for inheritance hierarchies
Usepublic
explicitly for clarity in public APIs
Preferreadonly
for 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 assertions
for literal types:as const
Usesatisfies
operator 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 ...
Noany
types without justification
Proper error handling with typed errors
Consistent use ofreadonly
for 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/UserPreview.tsx
packages/clerk-js/src/ui/components/PaymentSources/PaymentSourceRow.tsx
packages/clerk-js/src/ui/components/UserButton/SessionActions.tsx
packages/clerk-js/src/ui/components/OrganizationProfile/MembersSearch.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/UserPreview.tsx
packages/clerk-js/src/ui/components/PaymentSources/PaymentSourceRow.tsx
packages/clerk-js/src/ui/components/UserButton/SessionActions.tsx
packages/clerk-js/src/ui/components/OrganizationProfile/MembersSearch.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/UserPreview.tsx
packages/clerk-js/src/ui/components/PaymentSources/PaymentSourceRow.tsx
packages/clerk-js/src/ui/components/UserButton/SessionActions.tsx
packages/clerk-js/src/ui/components/OrganizationProfile/MembersSearch.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/UserPreview.tsx
packages/clerk-js/src/ui/components/PaymentSources/PaymentSourceRow.tsx
packages/clerk-js/src/ui/components/UserButton/SessionActions.tsx
packages/clerk-js/src/ui/components/OrganizationProfile/MembersSearch.tsx
🧬 Code graph analysis (1)
packages/clerk-js/src/ui/components/UserButton/SessionActions.tsx (1)
packages/clerk-js/src/ui/styledSystem/types.ts (1)
ThemableCssProp
(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). (3)
- GitHub Check: semgrep-cloud-platform/scan
- GitHub Check: semgrep-cloud-platform/scan
- GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (4)
packages/clerk-js/src/ui/components/OrganizationProfile/MembersSearch.tsx (1)
102-106
: Theme token for icon color — LGTMUsing sx with t.colors.$colorMutedForeground on the MagnifyingGlass aligns with the tokenized theme system and keeps styling consistent with element descriptors.
packages/clerk-js/src/ui/elements/UserPreview.tsx (1)
173-174
: Switch to secondary colorScheme — LGTMThis satisfies USER-3369 by styling the secondary identifier via the “secondary” scheme.
Please verify contrast across light/dark themes to ensure the secondary text remains accessible.
packages/clerk-js/src/ui/components/PaymentSources/PaymentSourceRow.tsx (1)
16-16
: Icon adopts muted foreground — LGTMTheme-aware sx with $colorMutedForeground is consistent with the PR’s styling direction and descriptor usage.
packages/clerk-js/src/ui/components/UserButton/SessionActions.tsx (1)
193-209
: Applying commonActionSx/iconSx to default items — LGTMConsistent, token-based styling for text and icons in the default actions branch.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes! Feels sooooo good seeing some of these tackled!
…breaking-changes-in-ui-components
There was a problem hiding this 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
🧹 Nitpick comments (1)
.changeset/petite-donkeys-leave.md (1)
5-5
: Make the changelog entry more explicit and reference the user stories.Clarify exactly what changed and link it to USER-3367/3368/3369 for traceability.
-Update search icon, payment source icon, and user preview identifier colors. +Update icon/text colors: use muted foreground for search and payment source icons; set UserPreview secondary identifier colorScheme to "secondary". + +Resolves: USER-3367, USER-3368, USER-3369.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
.changeset/petite-donkeys-leave.md
(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
.changeset/**
📄 CodeRabbit inference engine (.cursor/rules/monorepo.mdc)
Automated releases must use Changesets.
Files:
.changeset/petite-donkeys-leave.md
🪛 LanguageTool
.changeset/petite-donkeys-leave.md
[grammar] ~4-~4: There might be a mistake here.
Context: --- '@clerk/clerk-js': patch --- Update search icon, payment source icon, and u...
(QB_NEW_EN)
[grammar] ~5-~5: There might be a mistake here.
Context: ...con, and user preview identifier colors.
(QB_NEW_EN)
⏰ 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). (27)
- GitHub Check: Integration Tests (nuxt, chrome)
- GitHub Check: Integration Tests (nextjs, chrome, 15)
- GitHub Check: Integration Tests (nextjs, chrome, 14)
- GitHub Check: Integration Tests (machine, chrome)
- GitHub Check: Integration Tests (custom, chrome)
- GitHub Check: Integration Tests (billing, chrome)
- GitHub Check: Integration Tests (astro, chrome)
- GitHub Check: Integration Tests (react-router, chrome)
- GitHub Check: Integration Tests (tanstack-react-router, chrome)
- GitHub Check: Integration Tests (vue, chrome)
- GitHub Check: Integration Tests (sessions, chrome)
- GitHub Check: Integration Tests (localhost, chrome)
- GitHub Check: Integration Tests (tanstack-react-start, chrome)
- GitHub Check: Integration Tests (expo-web, chrome)
- GitHub Check: Integration Tests (elements, chrome)
- GitHub Check: Integration Tests (ap-flows, chrome)
- GitHub Check: Integration Tests (quickstart, chrome)
- GitHub Check: Integration Tests (generic, chrome)
- GitHub Check: Integration Tests (express, chrome)
- GitHub Check: Publish with pkg-pr-new
- GitHub Check: Static analysis
- GitHub Check: Unit Tests (18, --filter=@clerk/astro --filter=@clerk/backend --filter=@clerk/express --filter=@c...
- GitHub Check: Unit Tests (22, **)
- GitHub Check: semgrep/ci
- GitHub Check: Analyze (javascript-typescript)
- GitHub Check: semgrep-cloud-platform/scan
- GitHub Check: semgrep-cloud-platform/scan
🔇 Additional comments (1)
.changeset/petite-donkeys-leave.md (1)
1-3
: Changeset header looks correct and scoped.Package name and release type (patch) match a non-breaking UI color refactor.
Description
Update search icon color
Update payment source icon color
Update user preview text color
Resolves USER-3367, USER-3368, USER-3369
Checklist
pnpm test
runs as expected.pnpm build
runs as expected.Type of change
Summary by CodeRabbit