Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/sharp-terms-boil.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@clerk/ui': patch
---

Add mobile support for `<ConfigureSSO />` navbar to display application name, logo and organization name
2 changes: 2 additions & 0 deletions .changeset/snapi-bump-version.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
---
---
2 changes: 1 addition & 1 deletion .github/workflows/api-changes.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ concurrency:
cancel-in-progress: ${{ github.event_name == 'pull_request' }}

env:
SNAPI_PACKAGE: https://pkg.pr.new/clerk/snapi/@clerk/snapi@d42ed8b7857f9254bbb2a6e9ead44d5e7b1aa60c
SNAPI_PACKAGE: https://pkg.pr.new/clerk/snapi/@clerk/snapi@763ad1bb1da1da52fd8525a038405bb6ee1b7347
SNAPI_FILTERS: >-
--filter=@clerk/backend
--filter=@clerk/clerk-js
Expand Down
20 changes: 2 additions & 18 deletions packages/ui/src/components/ConfigureSSO/ConfigureSSO.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import React from 'react';

import { useProtect } from '@/common';
import { withCoreUserGuard } from '@/contexts';
import { Col, descriptors, Flex, Flow, Heading, Icon, localizationKeys, Text } from '@/customizables';
import { Col, Flex, Flow, Heading, Icon, localizationKeys, Text } from '@/customizables';
import { useCardState, withCardStateProvider } from '@/elements/contexts';
import { ProfileCard } from '@/elements/ProfileCard';
import { ExclamationTriangle } from '@/icons';
Expand Down Expand Up @@ -43,23 +43,7 @@ const AuthenticatedContent = withCoreUserGuard(() => {
sx={t => ({ display: 'grid', gridTemplateColumns: '1fr 3fr', height: t.sizes.$176, overflow: 'hidden' })}
>
<ConfigureSSONavbar contentRef={contentRef}>
<Col
ref={contentRef}
elementDescriptor={descriptors.scrollBox}
sx={t => ({
backgroundColor: t.colors.$colorBackground,
position: 'relative',
borderRadius: t.radii.$lg,
width: '100%',
overflow: 'hidden',
borderWidth: t.borderWidths.$normal,
borderStyle: t.borderStyles.$solid,
borderColor: t.colors.$borderAlpha150,
flex: 1,
})}
>
<ConfigureSSOContent contentRef={contentRef} />
</Col>
<ConfigureSSOContent contentRef={contentRef} />
</ConfigureSSONavbar>
</ProfileCard.Root>
);
Expand Down
113 changes: 107 additions & 6 deletions packages/ui/src/components/ConfigureSSO/ConfigureSSONavbar.tsx
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
import { useOrganization } from '@clerk/shared/react/index';
import { __internal_useOrganizationBase } from '@clerk/shared/react/index';
import React from 'react';

import { useEnvironment } from '@/contexts';
import { Box, Col, Flex, Icon, localizationKeys, Text, useAppearance } from '@/customizables';
import { Box, Col, descriptors, Flex, Heading, Icon, localizationKeys, Text, useAppearance } from '@/customizables';
import { ApplicationLogo } from '@/elements/ApplicationLogo';
import { NavBar, NavbarContextProvider } from '@/elements/Navbar';
import { BoxIcon } from '@/icons';
import { mqu } from '@/styledSystem';

type ConfigureSSONavbarProps = React.PropsWithChildren<{
contentRef: React.RefObject<HTMLDivElement>;
Expand Down Expand Up @@ -73,18 +74,118 @@ export const ConfigureSSONavbar = ({ children, contentRef }: ConfigureSSONavbarP
>
{applicationName}
</Text>
{organizationSettings.enabled && <OrganizationSidebarSubtitle />}
{organizationSettings.enabled && <OrganizationSubtitle />}
</Col>
</Flex>
}
/>
{children}
<Col
ref={contentRef}
elementDescriptor={descriptors.scrollBox}
sx={t => ({
backgroundColor: t.colors.$colorBackground,
position: 'relative',
borderRadius: t.radii.$lg,
width: '100%',
overflow: 'hidden',
borderWidth: t.borderWidths.$normal,
borderStyle: t.borderStyles.$solid,
borderColor: t.colors.$borderAlpha150,
flex: 1,
})}
>
<ConfigureSSOMobileNavbar />
{children}
</Col>
</NavbarContextProvider>
);
};

const OrganizationSidebarSubtitle = (): JSX.Element | null => {
const { organization } = useOrganization();
const ConfigureSSOMobileNavbar = () => {
const { parsedOptions } = useAppearance();
const {
organizationSettings,
displayConfig: { applicationName, logoImageUrl },
} = useEnvironment();

const hasLogo = Boolean(parsedOptions.logoImageUrl || logoImageUrl);

return (
<Col
as='header'
elementDescriptor={descriptors.configureSSOMobileNavbar}
sx={t => ({
display: 'none',
[mqu.md]: {
display: 'flex',
},
gap: t.space.$4,
padding: t.space.$5,
borderBottomWidth: t.borderWidths.$normal,
borderBottomStyle: t.borderStyles.$solid,
borderBottomColor: t.colors.$borderAlpha100,
})}
>
<Flex
align='center'
sx={t => ({
gap: t.space.$2,
maxWidth: '100%',
})}
>
{hasLogo ? (
<ApplicationLogo
sx={t => ({
width: t.space.$9,
height: t.space.$9,
borderRadius: t.radii.$md,
overflow: 'hidden',
})}
/>
) : (
<Box
sx={t => ({
width: t.space.$9,
height: t.space.$9,
flexShrink: 0,
borderRadius: t.radii.$md,
backgroundColor: t.colors.$primary500,
color: t.colors.$colorPrimaryForeground,
display: 'flex',
alignItems: 'center',
justifyContent: 'center',
})}
aria-hidden
>
<Icon
icon={BoxIcon}
sx={t => ({ width: t.sizes.$4, height: t.sizes.$4 })}
/>
</Box>
)}

<Col sx={{ minWidth: 0 }}>
<Text
as='p'
truncate
>
{applicationName}
</Text>
{organizationSettings.enabled && <OrganizationSubtitle />}
</Col>
</Flex>

<Heading
as='h3'
localizationKey={localizationKeys('configureSSO.navbar.title')}
sx={t => ({ fontSize: t.fontSizes.$lg })}
/>
</Col>
);
};

const OrganizationSubtitle = (): JSX.Element | null => {
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Avoid JSX.Element return type for React 19 compatibility in OrganizationSubtitle
packages/ui/src/components/ConfigureSSO/ConfigureSSONavbar.tsx:187

With React 19/@types/react, relying on the global JSX namespace can break type-checking; use React.JSX.Element | null (or import type { JSX } from 'react') instead.

Suggested fix
-const OrganizationSubtitle = (): JSX.Element | null => {
+const OrganizationSubtitle = (): React.JSX.Element | null => {
📝 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.

Suggested change
const OrganizationSubtitle = (): JSX.Element | null => {
const OrganizationSubtitle = (): React.JSX.Element | null => {
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@packages/ui/src/components/ConfigureSSO/ConfigureSSONavbar.tsx` at line 187,
The OrganizationSubtitle function currently uses the global JSX return type
which can break type-checking with React 19/@types/react; update its signature
to return React.JSX.Element | null (or import type { JSX } from 'react' and use
JSX.Element) so the type resolves from the react package; locate the
OrganizationSubtitle declaration and replace ": JSX.Element | null" with ":
React.JSX.Element | null" (or add the appropriate import and use that) and
adjust any imports if needed.

const organization = __internal_useOrganizationBase();

if (!organization) {
return null;
Expand Down
1 change: 1 addition & 0 deletions packages/ui/src/customizables/elementDescriptors.ts
Original file line number Diff line number Diff line change
Expand Up @@ -538,6 +538,7 @@ export const APPEARANCE_KEYS = containsAllElementsConfigKeys([
'enterpriseConnectionButtonText',

'configureSSOHeader',
'configureSSOMobileNavbar',
'configureSSOStepper',
'configureSSOStepperItem',
'configureSSOStepperItemBullet',
Expand Down
1 change: 1 addition & 0 deletions packages/ui/src/internal/appearance.ts
Original file line number Diff line number Diff line change
Expand Up @@ -674,6 +674,7 @@ export type ElementsConfig = {
enterpriseConnectionButtonText: WithOptions;

configureSSOHeader: WithOptions;
configureSSOMobileNavbar: WithOptions;
configureSSOStepper: WithOptions;
configureSSOStepperItem: WithOptions<string, ActiveState>;
configureSSOStepperItemBullet: WithOptions<string, ActiveState>;
Expand Down
Loading