Merged
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
8 changes: 8 additions & 0 deletions .changeset/poor-rockets-look.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
---
'@clerk/localizations': patch
'@clerk/clerk-js': patch
'@clerk/shared': patch
'@clerk/types': patch
---

Introduced searching for members list on `OrganizationProfile`
10 changes: 6 additions & 4 deletions packages/clerk-js/src/ui/common/NotificationCountBadge.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,19 +7,21 @@ import { animations } from '../styledSystem';
type NotificationCountBadgeProps = PropsOfComponent<typeof NotificationBadge> & {
notificationCount: number;
containerSx?: ThemableCssProp;
shouldAnimate?: boolean;
};

export const NotificationCountBadge = (props: NotificationCountBadgeProps) => {
const { notificationCount, containerSx, ...restProps } = props;
const { notificationCount, containerSx, shouldAnimate = true, ...restProps } = props;
const prefersReducedMotion = usePrefersReducedMotion();
const { t } = useLocalizations();
const localeKey = t(localizationKeys('locale'));
const formattedNotificationCount = formatToCompactNumber(notificationCount, localeKey);

const enterExitAnimation: ThemableCssProp = t => ({
animation: prefersReducedMotion
? 'none'
: `${animations.notificationAnimation} ${t.transitionDuration.$textField} ${t.transitionTiming.$slowBezier} 0s 1 normal forwards`,
animation:
Comment thread
LauraBeatris marked this conversation as resolved.
shouldAnimate && !prefersReducedMotion
? `${animations.notificationAnimation} ${t.transitionDuration.$textField} ${t.transitionTiming.$slowBezier} 0s 1 normal forwards`
: 'none',
});

return (
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,16 +8,14 @@ import { useFetchRoles, useLocalizeCustomRoles } from '../../hooks/useFetchRoles
import { handleError } from '../../utils';
import { DataTable, RoleSelect, RowContainer } from './MemberListTable';

const membershipsParams = {
memberships: {
pageSize: 10,
keepPreviousData: true,
},
type ActiveMembersListProps = {
memberships: ReturnType<typeof useOrganization>['memberships'];
pageSize: number;
};

export const ActiveMembersList = () => {
export const ActiveMembersList = ({ memberships, pageSize }: ActiveMembersListProps) => {
const card = useCardState();
const { organization, memberships } = useOrganization(membershipsParams);
const { organization} = useOrganization();

const { options, isLoading: loadingRoles } = useFetchRoles();

Expand All@@ -44,8 +42,8 @@ export const ActiveMembersList = () => {
onPageChange={n => memberships?.fetchPage?.(n)}
itemCount={memberships?.count || 0}
pageCount={memberships?.pageCount || 0}
itemsPerPage={membershipsParams.memberships.pageSize}
isLoading={memberships?.isLoading || loadingRoles}
itemsPerPage={pageSize}
isLoading={(memberships?.isLoading && !memberships?.data.length) || loadingRoles}
emptyStateLocalizationKey={localizationKeys('organizationProfile.membersPage.detailsTitle__emptyRow')}
headers={[
localizationKeys('organizationProfile.membersPage.activeMembersTab.tableHeader__user'),
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,22 +4,31 @@ import { Animated } from '../../elements';
import { Action } from '../../elements/Action';
import { InviteMembersScreen } from './InviteMembersScreen';

export const MembersActionsRow = () => {
type MembersActionsRowProps = {
actionSlot?: React.ReactNode;
};

export const MembersActionsRow = ({ actionSlot }: MembersActionsRowProps) => {
const canManageMemberships = useProtect({ permission: 'org:sys_memberships:manage' });

return (
<Action.Root animate={false}>
<Animated asChild>
<Flex
justify='end'
justify={actionSlot ? 'between' : 'end'}
sx={t => ({
width: '100%',
marginLeft: 'auto',
padding: `${t.space.$none} ${t.space.$1}`,
})}
gap={actionSlot ? 2 : undefined}
>
{actionSlot}
{canManageMemberships && (
<Action.Trigger value='invite'>
<Action.Trigger
value='invite'
hideOnActive={!actionSlot}
>
<Button
elementDescriptor={descriptors.membersPageInviteButton}
aria-label='Invite'
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
import type { useOrganization } from '@clerk/shared/react';
import type { GetMembersParams } from '@clerk/types';
import { useEffect, useRef } from 'react';

import { descriptors, Flex, Icon, localizationKeys, useLocalizations } from '../../../ui/customizables';
import { Animated, InputWithIcon } from '../../../ui/elements';
import { MagnifyingGlass } from '../../../ui/icons';
import { Spinner } from '../../../ui/primitives';
import { ACTIVE_MEMBERS_PAGE_SIZE } from './OrganizationMembers';

type MembersSearchProps = {
/**
* Controlled query param state by parent component
*/
query: GetMembersParams['query'];
/**
* Controlled input field value by parent component
*/
value: string;
/**
* Paginated organization memberships
*/
memberships: ReturnType<typeof useOrganization>['memberships'];
/**
* Handler for change event on input field
*/
onSearchChange: (value: string) => void;
/**
* Handler for `query` value changes
*/
onQueryTrigger: (query: string) => void;
};

const membersSearchDebounceMs = 500;

export const MembersSearch = ({ query, value, memberships, onSearchChange, onQueryTrigger }: MembersSearchProps) => {
const { t } = useLocalizations();

const debounceTimer = useRef<ReturnType<typeof setTimeout> | null>(null);

const handleChange = (event: React.ChangeEvent<HTMLInputElement>) => {
const eventValue = event.target.value;
onSearchChange(eventValue);

const shouldClearQuery = eventValue === '';
if (shouldClearQuery) {
onQueryTrigger(eventValue);
}
};

// Debounce the input value changes until the user stops typing
// to trigger the `query` param setter
function handleKeyUp() {
if (debounceTimer.current) {
clearTimeout(debounceTimer.current);
}

debounceTimer.current = setTimeout(() => {
onQueryTrigger(value.trim());
}, membersSearchDebounceMs);
}

// If search is not performed on a initial page, resets pagination offset
// based on the response count
useEffect(() => {
if (!query || !memberships?.data) {
return;
}

const hasOnePageLeft = (memberships?.count ?? 0) <= ACTIVE_MEMBERS_PAGE_SIZE;
if (hasOnePageLeft) {
memberships?.fetchPage?.(1);
}
}, [query, memberships]);

const isFetchingNewData = value && !!memberships?.isLoading && !!memberships.data?.length;

return (
<Animated asChild>
<Flex sx={{ width: '100%' }}>
<InputWithIcon
value={value}
type='search'
autoCapitalize='none'
spellCheck={false}
aria-label='Search'
placeholder={t(localizationKeys('organizationProfile.membersPage.action__search'))}
leftIcon={
isFetchingNewData ? (
<Spinner size='xs' />
) : (
<Icon
icon={MagnifyingGlass}
elementDescriptor={descriptors.organizationProfileMembersSearchInputIcon}
/>
)
}
onKeyUp={handleKeyUp}
onChange={handleChange}
elementDescriptor={descriptors.organizationProfileMembersSearchInput}
/>
</Flex>
</Animated>
);
};
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { useOrganization } from '@clerk/shared/react';
import { useState } from 'react';

import { NotificationCountBadge, useProtect } from '../../common';
import { useEnvironment, useOrganizationProfileContext } from '../../contexts';
Expand All@@ -20,19 +21,31 @@ import { mqu } from '../../styledSystem';
import { ActiveMembersList } from './ActiveMembersList';
import { MembersActionsRow } from './MembersActions';
import { MembershipWidget } from './MembershipWidget';
import { MembersSearch } from './MembersSearch';
import { OrganizationMembersTabInvitations } from './OrganizationMembersTabInvitations';
import { OrganizationMembersTabRequests } from './OrganizationMembersTabRequests';

export const ACTIVE_MEMBERS_PAGE_SIZE = 10;

export const OrganizationMembers = withCardStateProvider(() => {
const { organizationSettings } = useEnvironment();
const card = useCardState();
const canManageMemberships = useProtect({ permission: 'org:sys_memberships:manage' });
const canReadMemberships = useProtect({ permission: 'org:sys_memberships:read' });
const isDomainsEnabled = organizationSettings?.domains?.enabled && canManageMemberships;

const [query, setQuery] = useState('');
const [search, setSearch] = useState('');

const { membershipRequests, memberships, invitations } = useOrganization({
membershipRequests: isDomainsEnabled || undefined,
invitations: canManageMemberships || undefined,
memberships: canReadMemberships || undefined,
memberships: canReadMemberships
? {
keepPreviousData: true,
query: query || undefined,
}
: undefined,
});

// @ts-expect-error This property is not typed. It is used by our dashboard in order to render a billing widget.
Expand DownExpand Up@@ -74,8 +87,9 @@ export const OrganizationMembers = withCardStateProvider(() => {
<TabsList sx={t => ({ gap: t.space.$2 })}>
{canReadMemberships && (
<Tab localizationKey={localizationKeys('organizationProfile.membersPage.start.headerTitle__members')}>
{memberships?.data && !memberships.isLoading && (
{!!memberships?.count && (
<NotificationCountBadge
shouldAnimate={!query}
notificationCount={memberships.count}
colorScheme='outline'
/>
Expand DownExpand Up@@ -123,8 +137,21 @@ export const OrganizationMembers = withCardStateProvider(() => {
width: '100%',
}}
>
<MembersActionsRow />
<ActiveMembersList />
<MembersActionsRow
actionSlot={
<MembersSearch
query={query}
value={search}
memberships={memberships}
onSearchChange={query => setSearch(query)}
onQueryTrigger={query => setQuery(query)}
/>
}
/>
<ActiveMembersList
pageSize={ACTIVE_MEMBERS_PAGE_SIZE}
memberships={memberships}
/>
</Flex>
</Flex>
</TabPanel>
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -518,7 +518,7 @@ describe('OrganizationMembers', () => {
await waitFor(async () =>
expect(await findByRole('heading', { name: /invite new members/i })).toBeInTheDocument(),
);
expect(inviteButton).not.toBeInTheDocument();
expect(inviteButton).toBeInTheDocument();

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

await userEvent.click(getByRole('button', { name: 'Cancel' }));

await waitFor(async () => expect(await findByRole('button', { name: 'Invite' })).toBeInTheDocument());
Expand Down
3 changes: 3 additions & 0 deletions packages/clerk-js/src/ui/customizables/elementDescriptors.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -155,6 +155,9 @@ export const APPEARANCE_KEYS = containsAllElementsConfigKeys([
'organizationSwitcherPopoverActionButtonIcon',
'organizationSwitcherPopoverFooter',

'organizationProfileMembersSearchInputIcon',
'organizationProfileMembersSearchInput',

'organizationListPreviewItems',
'organizationListPreviewItem',
'organizationListPreviewButton',
Expand Down
5 changes: 3 additions & 2 deletions packages/clerk-js/src/ui/elements/Action/ActionTrigger.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,18 +4,19 @@ import { useActionContext } from './ActionRoot';

type ActionTriggerProps = PropsWithChildren<{
value: string;
hideOnActive?: boolean;
}>;

export const ActionTrigger = (props: ActionTriggerProps) => {
const { children, value } = props;
const { children, value, hideOnActive = true } = props;

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

This preserves the "invite" action button alongside the search input, otherwise, it'll lead to a layout height jump:

CleanShot.2025-01-21.at.08.30.04.mp4

const { active, open } = useActionContext();

const validChildren = Children.only(children);
if (!isValidElement(validChildren)) {
throw new Error('Children of ActionTrigger must be a valid element');
}

if (active === value) {
if (hideOnActive && active === value) {
return null;
}

Expand Down
35 changes: 25 additions & 10 deletions packages/clerk-js/src/ui/elements/InputWithIcon.tsx
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import React from 'react';

import { Flex, Input } from '../customizables';
import { Box, Flex, Input } from '../customizables';
import type { PropsOfComponent } from '../styledSystem';

type InputWithIcon = PropsOfComponent<typeof Input> & { leftIcon?: React.ReactElement };
Expand All@@ -10,18 +10,33 @@ export const InputWithIcon = React.forwardRef<HTMLInputElement, InputWithIcon>((
return (
<Flex
center
sx={theme => ({
sx={{
width: '100%',
position: 'relative',
'& .cl-internal-icon': {
position: 'absolute',
left: theme.space.$4,
width: theme.sizes.$3x5,
height: theme.sizes.$3x5,
},
})}
}}
>
{leftIcon && React.cloneElement(leftIcon, { className: 'cl-internal-icon' })}
{leftIcon ? (
<Box
sx={theme => [
{
position: 'absolute',
left: theme.space.$3x5,
width: theme.sizes.$3x5,
height: theme.sizes.$3x5,
pointerEvents: 'none',
display: 'grid',
placeContent: 'center',
'& svg': {
position: 'absolute',
width: '100%',
height: '100%',
},
},
]}
>
{leftIcon}
</Box>
) : null}
<Input
{...rest}
sx={[
Expand Down
1 change: 1 addition & 0 deletions packages/localizations/src/ar-SA.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -129,6 +129,7 @@ export const arSA: LocalizationResource = {
},
membersPage: {
action__invite: 'دعوة',
action__search: undefined,
activeMembersTab: {
menuAction__remove: 'إزالة عضو',
tableHeader__actions: undefined,
Expand Down
1 change: 1 addition & 0 deletions packages/localizations/src/be-BY.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -130,6 +130,7 @@ export const beBY: LocalizationResource = {
},
membersPage: {
action__invite: 'Пригласить',
action__search: undefined,
activeMembersTab: {
menuAction__remove: 'Удалить удзельніка',
tableHeader__actions: 'Дзеянні',
Expand Down
1 change: 1 addition & 0 deletions packages/localizations/src/bg-BG.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -129,6 +129,7 @@ export const bgBG: LocalizationResource = {
},
membersPage: {
action__invite: 'Покани',
action__search: undefined,
activeMembersTab: {
menuAction__remove: 'Премахване на член',
tableHeader__actions: undefined,
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content
Merged
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
8 changes: 8 additions & 0 deletions .changeset/poor-rockets-look.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
---
'@clerk/localizations': patch
'@clerk/clerk-js': patch
'@clerk/shared': patch
'@clerk/types': patch
---

Introduced searching for members list on `OrganizationProfile`
10 changes: 6 additions & 4 deletions packages/clerk-js/src/ui/common/NotificationCountBadge.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,19 +7,21 @@ import { animations } from '../styledSystem';
type NotificationCountBadgeProps = PropsOfComponent<typeof NotificationBadge> & {
notificationCount: number;
containerSx?: ThemableCssProp;
shouldAnimate?: boolean;
};

export const NotificationCountBadge = (props: NotificationCountBadgeProps) => {
const { notificationCount, containerSx, ...restProps } = props;
const { notificationCount, containerSx, shouldAnimate = true, ...restProps } = props;
const prefersReducedMotion = usePrefersReducedMotion();
const { t } = useLocalizations();
const localeKey = t(localizationKeys('locale'));
const formattedNotificationCount = formatToCompactNumber(notificationCount, localeKey);

const enterExitAnimation: ThemableCssProp = t => ({
animation: prefersReducedMotion
? 'none'
: `${animations.notificationAnimation} ${t.transitionDuration.$textField} ${t.transitionTiming.$slowBezier} 0s 1 normal forwards`,
animation:
Comment thread
LauraBeatris marked this conversation as resolved.
shouldAnimate && !prefersReducedMotion
? `${animations.notificationAnimation} ${t.transitionDuration.$textField} ${t.transitionTiming.$slowBezier} 0s 1 normal forwards`
: 'none',
});

return (
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,16 +8,14 @@ import { useFetchRoles, useLocalizeCustomRoles } from '../../hooks/useFetchRoles
import { handleError } from '../../utils';
import { DataTable, RoleSelect, RowContainer } from './MemberListTable';

const membershipsParams = {
memberships: {
pageSize: 10,
keepPreviousData: true,
},
type ActiveMembersListProps = {
memberships: ReturnType<typeof useOrganization>['memberships'];
pageSize: number;
};

export const ActiveMembersList = () => {
export const ActiveMembersList = ({ memberships, pageSize }: ActiveMembersListProps) => {
const card = useCardState();
const { organization, memberships } = useOrganization(membershipsParams);
const { organization} = useOrganization();

const { options, isLoading: loadingRoles } = useFetchRoles();

Expand All@@ -44,8 +42,8 @@ export const ActiveMembersList = () => {
onPageChange={n => memberships?.fetchPage?.(n)}
itemCount={memberships?.count || 0}
pageCount={memberships?.pageCount || 0}
itemsPerPage={membershipsParams.memberships.pageSize}
isLoading={memberships?.isLoading || loadingRoles}
itemsPerPage={pageSize}
isLoading={(memberships?.isLoading && !memberships?.data.length) || loadingRoles}
emptyStateLocalizationKey={localizationKeys('organizationProfile.membersPage.detailsTitle__emptyRow')}
headers={[
localizationKeys('organizationProfile.membersPage.activeMembersTab.tableHeader__user'),
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,22 +4,31 @@ import { Animated } from '../../elements';
import { Action } from '../../elements/Action';
import { InviteMembersScreen } from './InviteMembersScreen';

export const MembersActionsRow = () => {
type MembersActionsRowProps = {
actionSlot?: React.ReactNode;
};

export const MembersActionsRow = ({ actionSlot }: MembersActionsRowProps) => {
const canManageMemberships = useProtect({ permission: 'org:sys_memberships:manage' });

return (
<Action.Root animate={false}>
<Animated asChild>
<Flex
justify='end'
justify={actionSlot ? 'between' : 'end'}
sx={t => ({
width: '100%',
marginLeft: 'auto',
padding: `${t.space.$none} ${t.space.$1}`,
})}
gap={actionSlot ? 2 : undefined}
>
{actionSlot}
{canManageMemberships && (
<Action.Trigger value='invite'>
<Action.Trigger
value='invite'
hideOnActive={!actionSlot}
>
<Button
elementDescriptor={descriptors.membersPageInviteButton}
aria-label='Invite'
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
import type { useOrganization } from '@clerk/shared/react';
import type { GetMembersParams } from '@clerk/types';
import { useEffect, useRef } from 'react';

import { descriptors, Flex, Icon, localizationKeys, useLocalizations } from '../../../ui/customizables';
import { Animated, InputWithIcon } from '../../../ui/elements';
import { MagnifyingGlass } from '../../../ui/icons';
import { Spinner } from '../../../ui/primitives';
import { ACTIVE_MEMBERS_PAGE_SIZE } from './OrganizationMembers';

type MembersSearchProps = {
/**
* Controlled query param state by parent component
*/
query: GetMembersParams['query'];
/**
* Controlled input field value by parent component
*/
value: string;
/**
* Paginated organization memberships
*/
memberships: ReturnType<typeof useOrganization>['memberships'];
/**
* Handler for change event on input field
*/
onSearchChange: (value: string) => void;
/**
* Handler for `query` value changes
*/
onQueryTrigger: (query: string) => void;
};

const membersSearchDebounceMs = 500;

export const MembersSearch = ({ query, value, memberships, onSearchChange, onQueryTrigger }: MembersSearchProps) => {
const { t } = useLocalizations();

const debounceTimer = useRef<ReturnType<typeof setTimeout> | null>(null);

const handleChange = (event: React.ChangeEvent<HTMLInputElement>) => {
const eventValue = event.target.value;
onSearchChange(eventValue);

const shouldClearQuery = eventValue === '';
if (shouldClearQuery) {
onQueryTrigger(eventValue);
}
};

// Debounce the input value changes until the user stops typing
// to trigger the `query` param setter
function handleKeyUp() {
if (debounceTimer.current) {
clearTimeout(debounceTimer.current);
}

debounceTimer.current = setTimeout(() => {
onQueryTrigger(value.trim());
}, membersSearchDebounceMs);
}

// If search is not performed on a initial page, resets pagination offset
// based on the response count
useEffect(() => {
if (!query || !memberships?.data) {
return;
}

const hasOnePageLeft = (memberships?.count ?? 0) <= ACTIVE_MEMBERS_PAGE_SIZE;
if (hasOnePageLeft) {
memberships?.fetchPage?.(1);
}
}, [query, memberships]);

const isFetchingNewData = value && !!memberships?.isLoading && !!memberships.data?.length;

return (
<Animated asChild>
<Flex sx={{ width: '100%' }}>
<InputWithIcon
value={value}
type='search'
autoCapitalize='none'
spellCheck={false}
aria-label='Search'
placeholder={t(localizationKeys('organizationProfile.membersPage.action__search'))}
leftIcon={
isFetchingNewData ? (
<Spinner size='xs' />
) : (
<Icon
icon={MagnifyingGlass}
elementDescriptor={descriptors.organizationProfileMembersSearchInputIcon}
/>
)
}
onKeyUp={handleKeyUp}
onChange={handleChange}
elementDescriptor={descriptors.organizationProfileMembersSearchInput}
/>
</Flex>
</Animated>
);
};
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { useOrganization } from '@clerk/shared/react';
import { useState } from 'react';

import { NotificationCountBadge, useProtect } from '../../common';
import { useEnvironment, useOrganizationProfileContext } from '../../contexts';
Expand All@@ -20,19 +21,31 @@ import { mqu } from '../../styledSystem';
import { ActiveMembersList } from './ActiveMembersList';
import { MembersActionsRow } from './MembersActions';
import { MembershipWidget } from './MembershipWidget';
import { MembersSearch } from './MembersSearch';
import { OrganizationMembersTabInvitations } from './OrganizationMembersTabInvitations';
import { OrganizationMembersTabRequests } from './OrganizationMembersTabRequests';

export const ACTIVE_MEMBERS_PAGE_SIZE = 10;

export const OrganizationMembers = withCardStateProvider(() => {
const { organizationSettings } = useEnvironment();
const card = useCardState();
const canManageMemberships = useProtect({ permission: 'org:sys_memberships:manage' });
const canReadMemberships = useProtect({ permission: 'org:sys_memberships:read' });
const isDomainsEnabled = organizationSettings?.domains?.enabled && canManageMemberships;

const [query, setQuery] = useState('');
const [search, setSearch] = useState('');

const { membershipRequests, memberships, invitations } = useOrganization({
membershipRequests: isDomainsEnabled || undefined,
invitations: canManageMemberships || undefined,
memberships: canReadMemberships || undefined,
memberships: canReadMemberships
? {
keepPreviousData: true,
query: query || undefined,
}
: undefined,
});

// @ts-expect-error This property is not typed. It is used by our dashboard in order to render a billing widget.
Expand DownExpand Up@@ -74,8 +87,9 @@ export const OrganizationMembers = withCardStateProvider(() => {
<TabsList sx={t => ({ gap: t.space.$2 })}>
{canReadMemberships && (
<Tab localizationKey={localizationKeys('organizationProfile.membersPage.start.headerTitle__members')}>
{memberships?.data && !memberships.isLoading && (
{!!memberships?.count && (
<NotificationCountBadge
shouldAnimate={!query}
notificationCount={memberships.count}
colorScheme='outline'
/>
Expand DownExpand Up@@ -123,8 +137,21 @@ export const OrganizationMembers = withCardStateProvider(() => {
width: '100%',
}}
>
<MembersActionsRow />
<ActiveMembersList />
<MembersActionsRow
actionSlot={
<MembersSearch
query={query}
value={search}
memberships={memberships}
onSearchChange={query => setSearch(query)}
onQueryTrigger={query => setQuery(query)}
/>
}
/>
<ActiveMembersList
pageSize={ACTIVE_MEMBERS_PAGE_SIZE}
memberships={memberships}
/>
</Flex>
</Flex>
</TabPanel>
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -518,7 +518,7 @@ describe('OrganizationMembers', () => {
await waitFor(async () =>
expect(await findByRole('heading', { name: /invite new members/i })).toBeInTheDocument(),
);
expect(inviteButton).not.toBeInTheDocument();
expect(inviteButton).toBeInTheDocument();

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

await userEvent.click(getByRole('button', { name: 'Cancel' }));

await waitFor(async () => expect(await findByRole('button', { name: 'Invite' })).toBeInTheDocument());
Expand Down
3 changes: 3 additions & 0 deletions packages/clerk-js/src/ui/customizables/elementDescriptors.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -155,6 +155,9 @@ export const APPEARANCE_KEYS = containsAllElementsConfigKeys([
'organizationSwitcherPopoverActionButtonIcon',
'organizationSwitcherPopoverFooter',

'organizationProfileMembersSearchInputIcon',
'organizationProfileMembersSearchInput',

'organizationListPreviewItems',
'organizationListPreviewItem',
'organizationListPreviewButton',
Expand Down
5 changes: 3 additions & 2 deletions packages/clerk-js/src/ui/elements/Action/ActionTrigger.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,18 +4,19 @@ import { useActionContext } from './ActionRoot';

type ActionTriggerProps = PropsWithChildren<{
value: string;
hideOnActive?: boolean;
}>;

export const ActionTrigger = (props: ActionTriggerProps) => {
const { children, value } = props;
const { children, value, hideOnActive = true } = props;

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

This preserves the "invite" action button alongside the search input, otherwise, it'll lead to a layout height jump:

CleanShot.2025-01-21.at.08.30.04.mp4

const { active, open } = useActionContext();

const validChildren = Children.only(children);
if (!isValidElement(validChildren)) {
throw new Error('Children of ActionTrigger must be a valid element');
}

if (active === value) {
if (hideOnActive && active === value) {
return null;
}

Expand Down
35 changes: 25 additions & 10 deletions packages/clerk-js/src/ui/elements/InputWithIcon.tsx
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import React from 'react';

import { Flex, Input } from '../customizables';
import { Box, Flex, Input } from '../customizables';
import type { PropsOfComponent } from '../styledSystem';

type InputWithIcon = PropsOfComponent<typeof Input> & { leftIcon?: React.ReactElement };
Expand All@@ -10,18 +10,33 @@ export const InputWithIcon = React.forwardRef<HTMLInputElement, InputWithIcon>((
return (
<Flex
center
sx={theme => ({
sx={{
width: '100%',
position: 'relative',
'& .cl-internal-icon': {
position: 'absolute',
left: theme.space.$4,
width: theme.sizes.$3x5,
height: theme.sizes.$3x5,
},
})}
}}
>
{leftIcon && React.cloneElement(leftIcon, { className: 'cl-internal-icon' })}
{leftIcon ? (
<Box
sx={theme => [
{
position: 'absolute',
left: theme.space.$3x5,
width: theme.sizes.$3x5,
height: theme.sizes.$3x5,
pointerEvents: 'none',
display: 'grid',
placeContent: 'center',
'& svg': {
position: 'absolute',
width: '100%',
height: '100%',
},
},
]}
>
{leftIcon}
</Box>
) : null}
<Input
{...rest}
sx={[
Expand Down
1 change: 1 addition & 0 deletions packages/localizations/src/ar-SA.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -129,6 +129,7 @@ export const arSA: LocalizationResource = {
},
membersPage: {
action__invite: 'دعوة',
action__search: undefined,
activeMembersTab: {
menuAction__remove: 'إزالة عضو',
tableHeader__actions: undefined,
Expand Down
1 change: 1 addition & 0 deletions packages/localizations/src/be-BY.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -130,6 +130,7 @@ export const beBY: LocalizationResource = {
},
membersPage: {
action__invite: 'Пригласить',
action__search: undefined,
activeMembersTab: {
menuAction__remove: 'Удалить удзельніка',
tableHeader__actions: 'Дзеянні',
Expand Down
1 change: 1 addition & 0 deletions packages/localizations/src/bg-BG.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -129,6 +129,7 @@ export const bgBG: LocalizationResource = {
},
membersPage: {
action__invite: 'Покани',
action__search: undefined,
activeMembersTab: {
menuAction__remove: 'Премахване на член',
tableHeader__actions: undefined,
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
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
8 changes: 8 additions & 0 deletions .changeset/poor-rockets-look.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
---
'@clerk/localizations': patch
'@clerk/clerk-js': patch
'@clerk/shared': patch
'@clerk/types': patch
---

Introduced searching for members list on `OrganizationProfile`
10 changes: 6 additions & 4 deletions packages/clerk-js/src/ui/common/NotificationCountBadge.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,19 +7,21 @@ import { animations } from '../styledSystem';
type NotificationCountBadgeProps = PropsOfComponent<typeof NotificationBadge> & {
notificationCount: number;
containerSx?: ThemableCssProp;
shouldAnimate?: boolean;
};

export const NotificationCountBadge = (props: NotificationCountBadgeProps) => {
const { notificationCount, containerSx, ...restProps } = props;
const { notificationCount, containerSx, shouldAnimate = true, ...restProps } = props;
const prefersReducedMotion = usePrefersReducedMotion();
const { t } = useLocalizations();
const localeKey = t(localizationKeys('locale'));
const formattedNotificationCount = formatToCompactNumber(notificationCount, localeKey);

const enterExitAnimation: ThemableCssProp = t => ({
animation: prefersReducedMotion
? 'none'
: `${animations.notificationAnimation} ${t.transitionDuration.$textField} ${t.transitionTiming.$slowBezier} 0s 1 normal forwards`,
animation:
Comment thread
LauraBeatris marked this conversation as resolved.
shouldAnimate && !prefersReducedMotion
? `${animations.notificationAnimation} ${t.transitionDuration.$textField} ${t.transitionTiming.$slowBezier} 0s 1 normal forwards`
: 'none',
});

return (
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,16 +8,14 @@ import { useFetchRoles, useLocalizeCustomRoles } from '../../hooks/useFetchRoles
import { handleError } from '../../utils';
import { DataTable, RoleSelect, RowContainer } from './MemberListTable';

const membershipsParams = {
memberships: {
pageSize: 10,
keepPreviousData: true,
},
type ActiveMembersListProps = {
memberships: ReturnType<typeof useOrganization>['memberships'];
pageSize: number;
};

export const ActiveMembersList = () => {
export const ActiveMembersList = ({ memberships, pageSize }: ActiveMembersListProps) => {
const card = useCardState();
const { organization, memberships } = useOrganization(membershipsParams);
const { organization} = useOrganization();

const { options, isLoading: loadingRoles } = useFetchRoles();

Expand All@@ -44,8 +42,8 @@ export const ActiveMembersList = () => {
onPageChange={n => memberships?.fetchPage?.(n)}
itemCount={memberships?.count || 0}
pageCount={memberships?.pageCount || 0}
itemsPerPage={membershipsParams.memberships.pageSize}
isLoading={memberships?.isLoading || loadingRoles}
itemsPerPage={pageSize}
isLoading={(memberships?.isLoading && !memberships?.data.length) || loadingRoles}
emptyStateLocalizationKey={localizationKeys('organizationProfile.membersPage.detailsTitle__emptyRow')}
headers={[
localizationKeys('organizationProfile.membersPage.activeMembersTab.tableHeader__user'),
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,22 +4,31 @@ import { Animated } from '../../elements';
import { Action } from '../../elements/Action';
import { InviteMembersScreen } from './InviteMembersScreen';

export const MembersActionsRow = () => {
type MembersActionsRowProps = {
actionSlot?: React.ReactNode;
};

export const MembersActionsRow = ({ actionSlot }: MembersActionsRowProps) => {
const canManageMemberships = useProtect({ permission: 'org:sys_memberships:manage' });

return (
<Action.Root animate={false}>
<Animated asChild>
<Flex
justify='end'
justify={actionSlot ? 'between' : 'end'}
sx={t => ({
width: '100%',
marginLeft: 'auto',
padding: `${t.space.$none} ${t.space.$1}`,
})}
gap={actionSlot ? 2 : undefined}
>
{actionSlot}
{canManageMemberships && (
<Action.Trigger value='invite'>
<Action.Trigger
value='invite'
hideOnActive={!actionSlot}
>
<Button
elementDescriptor={descriptors.membersPageInviteButton}
aria-label='Invite'
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
import type { useOrganization } from '@clerk/shared/react';
import type { GetMembersParams } from '@clerk/types';
import { useEffect, useRef } from 'react';

import { descriptors, Flex, Icon, localizationKeys, useLocalizations } from '../../../ui/customizables';
import { Animated, InputWithIcon } from '../../../ui/elements';
import { MagnifyingGlass } from '../../../ui/icons';
import { Spinner } from '../../../ui/primitives';
import { ACTIVE_MEMBERS_PAGE_SIZE } from './OrganizationMembers';

type MembersSearchProps = {
/**
* Controlled query param state by parent component
*/
query: GetMembersParams['query'];
/**
* Controlled input field value by parent component
*/
value: string;
/**
* Paginated organization memberships
*/
memberships: ReturnType<typeof useOrganization>['memberships'];
/**
* Handler for change event on input field
*/
onSearchChange: (value: string) => void;
/**
* Handler for `query` value changes
*/
onQueryTrigger: (query: string) => void;
};

const membersSearchDebounceMs = 500;

export const MembersSearch = ({ query, value, memberships, onSearchChange, onQueryTrigger }: MembersSearchProps) => {
const { t } = useLocalizations();

const debounceTimer = useRef<ReturnType<typeof setTimeout> | null>(null);

const handleChange = (event: React.ChangeEvent<HTMLInputElement>) => {
const eventValue = event.target.value;
onSearchChange(eventValue);

const shouldClearQuery = eventValue === '';
if (shouldClearQuery) {
onQueryTrigger(eventValue);
}
};

// Debounce the input value changes until the user stops typing
// to trigger the `query` param setter
function handleKeyUp() {
if (debounceTimer.current) {
clearTimeout(debounceTimer.current);
}

debounceTimer.current = setTimeout(() => {
onQueryTrigger(value.trim());
}, membersSearchDebounceMs);
}

// If search is not performed on a initial page, resets pagination offset
// based on the response count
useEffect(() => {
if (!query || !memberships?.data) {
return;
}

const hasOnePageLeft = (memberships?.count ?? 0) <= ACTIVE_MEMBERS_PAGE_SIZE;
if (hasOnePageLeft) {
memberships?.fetchPage?.(1);
}
}, [query, memberships]);

const isFetchingNewData = value && !!memberships?.isLoading && !!memberships.data?.length;

return (
<Animated asChild>
<Flex sx={{ width: '100%' }}>
<InputWithIcon
value={value}
type='search'
autoCapitalize='none'
spellCheck={false}
aria-label='Search'
placeholder={t(localizationKeys('organizationProfile.membersPage.action__search'))}
leftIcon={
isFetchingNewData ? (
<Spinner size='xs' />
) : (
<Icon
icon={MagnifyingGlass}
elementDescriptor={descriptors.organizationProfileMembersSearchInputIcon}
/>
)
}
onKeyUp={handleKeyUp}
onChange={handleChange}
elementDescriptor={descriptors.organizationProfileMembersSearchInput}
/>
</Flex>
</Animated>
);
};
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { useOrganization } from '@clerk/shared/react';
import { useState } from 'react';

import { NotificationCountBadge, useProtect } from '../../common';
import { useEnvironment, useOrganizationProfileContext } from '../../contexts';
Expand All@@ -20,19 +21,31 @@ import { mqu } from '../../styledSystem';
import { ActiveMembersList } from './ActiveMembersList';
import { MembersActionsRow } from './MembersActions';
import { MembershipWidget } from './MembershipWidget';
import { MembersSearch } from './MembersSearch';
import { OrganizationMembersTabInvitations } from './OrganizationMembersTabInvitations';
import { OrganizationMembersTabRequests } from './OrganizationMembersTabRequests';

export const ACTIVE_MEMBERS_PAGE_SIZE = 10;

export const OrganizationMembers = withCardStateProvider(() => {
const { organizationSettings } = useEnvironment();
const card = useCardState();
const canManageMemberships = useProtect({ permission: 'org:sys_memberships:manage' });
const canReadMemberships = useProtect({ permission: 'org:sys_memberships:read' });
const isDomainsEnabled = organizationSettings?.domains?.enabled && canManageMemberships;

const [query, setQuery] = useState('');
const [search, setSearch] = useState('');

const { membershipRequests, memberships, invitations } = useOrganization({
membershipRequests: isDomainsEnabled || undefined,
invitations: canManageMemberships || undefined,
memberships: canReadMemberships || undefined,
memberships: canReadMemberships
? {
keepPreviousData: true,
query: query || undefined,
}
: undefined,
});

// @ts-expect-error This property is not typed. It is used by our dashboard in order to render a billing widget.
Expand DownExpand Up@@ -74,8 +87,9 @@ export const OrganizationMembers = withCardStateProvider(() => {
<TabsList sx={t => ({ gap: t.space.$2 })}>
{canReadMemberships && (
<Tab localizationKey={localizationKeys('organizationProfile.membersPage.start.headerTitle__members')}>
{memberships?.data && !memberships.isLoading && (
{!!memberships?.count && (
<NotificationCountBadge
shouldAnimate={!query}
notificationCount={memberships.count}
colorScheme='outline'
/>
Expand DownExpand Up@@ -123,8 +137,21 @@ export const OrganizationMembers = withCardStateProvider(() => {
width: '100%',
}}
>
<MembersActionsRow />
<ActiveMembersList />
<MembersActionsRow
actionSlot={
<MembersSearch
query={query}
value={search}
memberships={memberships}
onSearchChange={query => setSearch(query)}
onQueryTrigger={query => setQuery(query)}
/>
}
/>
<ActiveMembersList
pageSize={ACTIVE_MEMBERS_PAGE_SIZE}
memberships={memberships}
/>
</Flex>
</Flex>
</TabPanel>
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -518,7 +518,7 @@ describe('OrganizationMembers', () => {
await waitFor(async () =>
expect(await findByRole('heading', { name: /invite new members/i })).toBeInTheDocument(),
);
expect(inviteButton).not.toBeInTheDocument();
expect(inviteButton).toBeInTheDocument();

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

await userEvent.click(getByRole('button', { name: 'Cancel' }));

await waitFor(async () => expect(await findByRole('button', { name: 'Invite' })).toBeInTheDocument());
Expand Down
3 changes: 3 additions & 0 deletions packages/clerk-js/src/ui/customizables/elementDescriptors.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -155,6 +155,9 @@ export const APPEARANCE_KEYS = containsAllElementsConfigKeys([
'organizationSwitcherPopoverActionButtonIcon',
'organizationSwitcherPopoverFooter',

'organizationProfileMembersSearchInputIcon',
'organizationProfileMembersSearchInput',

'organizationListPreviewItems',
'organizationListPreviewItem',
'organizationListPreviewButton',
Expand Down
5 changes: 3 additions & 2 deletions packages/clerk-js/src/ui/elements/Action/ActionTrigger.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,18 +4,19 @@ import { useActionContext } from './ActionRoot';

type ActionTriggerProps = PropsWithChildren<{
value: string;
hideOnActive?: boolean;
}>;

export const ActionTrigger = (props: ActionTriggerProps) => {
const { children, value } = props;
const { children, value, hideOnActive = true } = props;

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

This preserves the "invite" action button alongside the search input, otherwise, it'll lead to a layout height jump:

CleanShot.2025-01-21.at.08.30.04.mp4

const { active, open } = useActionContext();

const validChildren = Children.only(children);
if (!isValidElement(validChildren)) {
throw new Error('Children of ActionTrigger must be a valid element');
}

if (active === value) {
if (hideOnActive && active === value) {
return null;
}

Expand Down
35 changes: 25 additions & 10 deletions packages/clerk-js/src/ui/elements/InputWithIcon.tsx
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import React from 'react';

import { Flex, Input } from '../customizables';
import { Box, Flex, Input } from '../customizables';
import type { PropsOfComponent } from '../styledSystem';

type InputWithIcon = PropsOfComponent<typeof Input> & { leftIcon?: React.ReactElement };
Expand All@@ -10,18 +10,33 @@ export const InputWithIcon = React.forwardRef<HTMLInputElement, InputWithIcon>((
return (
<Flex
center
sx={theme => ({
sx={{
width: '100%',
position: 'relative',
'& .cl-internal-icon': {
position: 'absolute',
left: theme.space.$4,
width: theme.sizes.$3x5,
height: theme.sizes.$3x5,
},
})}
}}
>
{leftIcon && React.cloneElement(leftIcon, { className: 'cl-internal-icon' })}
{leftIcon ? (
<Box
sx={theme => [
{
position: 'absolute',
left: theme.space.$3x5,
width: theme.sizes.$3x5,
height: theme.sizes.$3x5,
pointerEvents: 'none',
display: 'grid',
placeContent: 'center',
'& svg': {
position: 'absolute',
width: '100%',
height: '100%',
},
},
]}
>
{leftIcon}
</Box>
) : null}
<Input
{...rest}
sx={[
Expand Down
1 change: 1 addition & 0 deletions packages/localizations/src/ar-SA.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -129,6 +129,7 @@ export const arSA: LocalizationResource = {
},
membersPage: {
action__invite: 'دعوة',
action__search: undefined,
activeMembersTab: {
menuAction__remove: 'إزالة عضو',
tableHeader__actions: undefined,
Expand Down
1 change: 1 addition & 0 deletions packages/localizations/src/be-BY.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -130,6 +130,7 @@ export const beBY: LocalizationResource = {
},
membersPage: {
action__invite: 'Пригласить',
action__search: undefined,
activeMembersTab: {
menuAction__remove: 'Удалить удзельніка',
tableHeader__actions: 'Дзеянні',
Expand Down
1 change: 1 addition & 0 deletions packages/localizations/src/bg-BG.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -129,6 +129,7 @@ export const bgBG: LocalizationResource = {
},
membersPage: {
action__invite: 'Покани',
action__search: undefined,
activeMembersTab: {
menuAction__remove: 'Премахване на член',
tableHeader__actions: undefined,
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
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
8 changes: 8 additions & 0 deletions .changeset/poor-rockets-look.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
---
'@clerk/localizations': patch
'@clerk/clerk-js': patch
'@clerk/shared': patch
'@clerk/types': patch
---

Introduced searching for members list on `OrganizationProfile`
10 changes: 6 additions & 4 deletions packages/clerk-js/src/ui/common/NotificationCountBadge.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,19 +7,21 @@ import { animations } from '../styledSystem';
type NotificationCountBadgeProps = PropsOfComponent<typeof NotificationBadge> & {
notificationCount: number;
containerSx?: ThemableCssProp;
shouldAnimate?: boolean;
};

export const NotificationCountBadge = (props: NotificationCountBadgeProps) => {
const { notificationCount, containerSx, ...restProps } = props;
const { notificationCount, containerSx, shouldAnimate = true, ...restProps } = props;
const prefersReducedMotion = usePrefersReducedMotion();
const { t } = useLocalizations();
const localeKey = t(localizationKeys('locale'));
const formattedNotificationCount = formatToCompactNumber(notificationCount, localeKey);

const enterExitAnimation: ThemableCssProp = t => ({
animation: prefersReducedMotion
? 'none'
: `${animations.notificationAnimation} ${t.transitionDuration.$textField} ${t.transitionTiming.$slowBezier} 0s 1 normal forwards`,
animation:
Comment thread
LauraBeatris marked this conversation as resolved.
shouldAnimate && !prefersReducedMotion
? `${animations.notificationAnimation} ${t.transitionDuration.$textField} ${t.transitionTiming.$slowBezier} 0s 1 normal forwards`
: 'none',
});

return (
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,16 +8,14 @@ import { useFetchRoles, useLocalizeCustomRoles } from '../../hooks/useFetchRoles
import { handleError } from '../../utils';
import { DataTable, RoleSelect, RowContainer } from './MemberListTable';

const membershipsParams = {
memberships: {
pageSize: 10,
keepPreviousData: true,
},
type ActiveMembersListProps = {
memberships: ReturnType<typeof useOrganization>['memberships'];
pageSize: number;
};

export const ActiveMembersList = () => {
export const ActiveMembersList = ({ memberships, pageSize }: ActiveMembersListProps) => {
const card = useCardState();
const { organization, memberships } = useOrganization(membershipsParams);
const { organization} = useOrganization();

const { options, isLoading: loadingRoles } = useFetchRoles();

Expand All@@ -44,8 +42,8 @@ export const ActiveMembersList = () => {
onPageChange={n => memberships?.fetchPage?.(n)}
itemCount={memberships?.count || 0}
pageCount={memberships?.pageCount || 0}
itemsPerPage={membershipsParams.memberships.pageSize}
isLoading={memberships?.isLoading || loadingRoles}
itemsPerPage={pageSize}
isLoading={(memberships?.isLoading && !memberships?.data.length) || loadingRoles}
emptyStateLocalizationKey={localizationKeys('organizationProfile.membersPage.detailsTitle__emptyRow')}
headers={[
localizationKeys('organizationProfile.membersPage.activeMembersTab.tableHeader__user'),
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,22 +4,31 @@ import { Animated } from '../../elements';
import { Action } from '../../elements/Action';
import { InviteMembersScreen } from './InviteMembersScreen';

export const MembersActionsRow = () => {
type MembersActionsRowProps = {
actionSlot?: React.ReactNode;
};

export const MembersActionsRow = ({ actionSlot }: MembersActionsRowProps) => {
const canManageMemberships = useProtect({ permission: 'org:sys_memberships:manage' });

return (
<Action.Root animate={false}>
<Animated asChild>
<Flex
justify='end'
justify={actionSlot ? 'between' : 'end'}
sx={t => ({
width: '100%',
marginLeft: 'auto',
padding: `${t.space.$none} ${t.space.$1}`,
})}
gap={actionSlot ? 2 : undefined}
>
{actionSlot}
{canManageMemberships && (
<Action.Trigger value='invite'>
<Action.Trigger
value='invite'
hideOnActive={!actionSlot}
>
<Button
elementDescriptor={descriptors.membersPageInviteButton}
aria-label='Invite'
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
import type { useOrganization } from '@clerk/shared/react';
import type { GetMembersParams } from '@clerk/types';
import { useEffect, useRef } from 'react';

import { descriptors, Flex, Icon, localizationKeys, useLocalizations } from '../../../ui/customizables';
import { Animated, InputWithIcon } from '../../../ui/elements';
import { MagnifyingGlass } from '../../../ui/icons';
import { Spinner } from '../../../ui/primitives';
import { ACTIVE_MEMBERS_PAGE_SIZE } from './OrganizationMembers';

type MembersSearchProps = {
/**
* Controlled query param state by parent component
*/
query: GetMembersParams['query'];
/**
* Controlled input field value by parent component
*/
value: string;
/**
* Paginated organization memberships
*/
memberships: ReturnType<typeof useOrganization>['memberships'];
/**
* Handler for change event on input field
*/
onSearchChange: (value: string) => void;
/**
* Handler for `query` value changes
*/
onQueryTrigger: (query: string) => void;
};

const membersSearchDebounceMs = 500;

export const MembersSearch = ({ query, value, memberships, onSearchChange, onQueryTrigger }: MembersSearchProps) => {
const { t } = useLocalizations();

const debounceTimer = useRef<ReturnType<typeof setTimeout> | null>(null);

const handleChange = (event: React.ChangeEvent<HTMLInputElement>) => {
const eventValue = event.target.value;
onSearchChange(eventValue);

const shouldClearQuery = eventValue === '';
if (shouldClearQuery) {
onQueryTrigger(eventValue);
}
};

// Debounce the input value changes until the user stops typing
// to trigger the `query` param setter
function handleKeyUp() {
if (debounceTimer.current) {
clearTimeout(debounceTimer.current);
}

debounceTimer.current = setTimeout(() => {
onQueryTrigger(value.trim());
}, membersSearchDebounceMs);
}

// If search is not performed on a initial page, resets pagination offset
// based on the response count
useEffect(() => {
if (!query || !memberships?.data) {
return;
}

const hasOnePageLeft = (memberships?.count ?? 0) <= ACTIVE_MEMBERS_PAGE_SIZE;
if (hasOnePageLeft) {
memberships?.fetchPage?.(1);
}
}, [query, memberships]);

const isFetchingNewData = value && !!memberships?.isLoading && !!memberships.data?.length;

return (
<Animated asChild>
<Flex sx={{ width: '100%' }}>
<InputWithIcon
value={value}
type='search'
autoCapitalize='none'
spellCheck={false}
aria-label='Search'
placeholder={t(localizationKeys('organizationProfile.membersPage.action__search'))}
leftIcon={
isFetchingNewData ? (
<Spinner size='xs' />
) : (
<Icon
icon={MagnifyingGlass}
elementDescriptor={descriptors.organizationProfileMembersSearchInputIcon}
/>
)
}
onKeyUp={handleKeyUp}
onChange={handleChange}
elementDescriptor={descriptors.organizationProfileMembersSearchInput}
/>
</Flex>
</Animated>
);
};
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { useOrganization } from '@clerk/shared/react';
import { useState } from 'react';

import { NotificationCountBadge, useProtect } from '../../common';
import { useEnvironment, useOrganizationProfileContext } from '../../contexts';
Expand All@@ -20,19 +21,31 @@ import { mqu } from '../../styledSystem';
import { ActiveMembersList } from './ActiveMembersList';
import { MembersActionsRow } from './MembersActions';
import { MembershipWidget } from './MembershipWidget';
import { MembersSearch } from './MembersSearch';
import { OrganizationMembersTabInvitations } from './OrganizationMembersTabInvitations';
import { OrganizationMembersTabRequests } from './OrganizationMembersTabRequests';

export const ACTIVE_MEMBERS_PAGE_SIZE = 10;

export const OrganizationMembers = withCardStateProvider(() => {
const { organizationSettings } = useEnvironment();
const card = useCardState();
const canManageMemberships = useProtect({ permission: 'org:sys_memberships:manage' });
const canReadMemberships = useProtect({ permission: 'org:sys_memberships:read' });
const isDomainsEnabled = organizationSettings?.domains?.enabled && canManageMemberships;

const [query, setQuery] = useState('');
const [search, setSearch] = useState('');

const { membershipRequests, memberships, invitations } = useOrganization({
membershipRequests: isDomainsEnabled || undefined,
invitations: canManageMemberships || undefined,
memberships: canReadMemberships || undefined,
memberships: canReadMemberships
? {
keepPreviousData: true,
query: query || undefined,
}
: undefined,
});

// @ts-expect-error This property is not typed. It is used by our dashboard in order to render a billing widget.
Expand DownExpand Up@@ -74,8 +87,9 @@ export const OrganizationMembers = withCardStateProvider(() => {
<TabsList sx={t => ({ gap: t.space.$2 })}>
{canReadMemberships && (
<Tab localizationKey={localizationKeys('organizationProfile.membersPage.start.headerTitle__members')}>
{memberships?.data && !memberships.isLoading && (
{!!memberships?.count && (
<NotificationCountBadge
shouldAnimate={!query}
notificationCount={memberships.count}
colorScheme='outline'
/>
Expand DownExpand Up@@ -123,8 +137,21 @@ export const OrganizationMembers = withCardStateProvider(() => {
width: '100%',
}}
>
<MembersActionsRow />
<ActiveMembersList />
<MembersActionsRow
actionSlot={
<MembersSearch
query={query}
value={search}
memberships={memberships}
onSearchChange={query => setSearch(query)}
onQueryTrigger={query => setQuery(query)}
/>
}
/>
<ActiveMembersList
pageSize={ACTIVE_MEMBERS_PAGE_SIZE}
memberships={memberships}
/>
</Flex>
</Flex>
</TabPanel>
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -518,7 +518,7 @@ describe('OrganizationMembers', () => {
await waitFor(async () =>
expect(await findByRole('heading', { name: /invite new members/i })).toBeInTheDocument(),
);
expect(inviteButton).not.toBeInTheDocument();
expect(inviteButton).toBeInTheDocument();

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

await userEvent.click(getByRole('button', { name: 'Cancel' }));

await waitFor(async () => expect(await findByRole('button', { name: 'Invite' })).toBeInTheDocument());
Expand Down
3 changes: 3 additions & 0 deletions packages/clerk-js/src/ui/customizables/elementDescriptors.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -155,6 +155,9 @@ export const APPEARANCE_KEYS = containsAllElementsConfigKeys([
'organizationSwitcherPopoverActionButtonIcon',
'organizationSwitcherPopoverFooter',

'organizationProfileMembersSearchInputIcon',
'organizationProfileMembersSearchInput',

'organizationListPreviewItems',
'organizationListPreviewItem',
'organizationListPreviewButton',
Expand Down
5 changes: 3 additions & 2 deletions packages/clerk-js/src/ui/elements/Action/ActionTrigger.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,18 +4,19 @@ import { useActionContext } from './ActionRoot';

type ActionTriggerProps = PropsWithChildren<{
value: string;
hideOnActive?: boolean;
}>;

export const ActionTrigger = (props: ActionTriggerProps) => {
const { children, value } = props;
const { children, value, hideOnActive = true } = props;

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

This preserves the "invite" action button alongside the search input, otherwise, it'll lead to a layout height jump:

CleanShot.2025-01-21.at.08.30.04.mp4

const { active, open } = useActionContext();

const validChildren = Children.only(children);
if (!isValidElement(validChildren)) {
throw new Error('Children of ActionTrigger must be a valid element');
}

if (active === value) {
if (hideOnActive && active === value) {
return null;
}

Expand Down
35 changes: 25 additions & 10 deletions packages/clerk-js/src/ui/elements/InputWithIcon.tsx
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import React from 'react';

import { Flex, Input } from '../customizables';
import { Box, Flex, Input } from '../customizables';
import type { PropsOfComponent } from '../styledSystem';

type InputWithIcon = PropsOfComponent<typeof Input> & { leftIcon?: React.ReactElement };
Expand All@@ -10,18 +10,33 @@ export const InputWithIcon = React.forwardRef<HTMLInputElement, InputWithIcon>((
return (
<Flex
center
sx={theme => ({
sx={{
width: '100%',
position: 'relative',
'& .cl-internal-icon': {
position: 'absolute',
left: theme.space.$4,
width: theme.sizes.$3x5,
height: theme.sizes.$3x5,
},
})}
}}
>
{leftIcon && React.cloneElement(leftIcon, { className: 'cl-internal-icon' })}
{leftIcon ? (
<Box
sx={theme => [
{
position: 'absolute',
left: theme.space.$3x5,
width: theme.sizes.$3x5,
height: theme.sizes.$3x5,
pointerEvents: 'none',
display: 'grid',
placeContent: 'center',
'& svg': {
position: 'absolute',
width: '100%',
height: '100%',
},
},
]}
>
{leftIcon}
</Box>
) : null}
<Input
{...rest}
sx={[
Expand Down
1 change: 1 addition & 0 deletions packages/localizations/src/ar-SA.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -129,6 +129,7 @@ export const arSA: LocalizationResource = {
},
membersPage: {
action__invite: 'دعوة',
action__search: undefined,
activeMembersTab: {
menuAction__remove: 'إزالة عضو',
tableHeader__actions: undefined,
Expand Down
1 change: 1 addition & 0 deletions packages/localizations/src/be-BY.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -130,6 +130,7 @@ export const beBY: LocalizationResource = {
},
membersPage: {
action__invite: 'Пригласить',
action__search: undefined,
activeMembersTab: {
menuAction__remove: 'Удалить удзельніка',
tableHeader__actions: 'Дзеянні',
Expand Down
1 change: 1 addition & 0 deletions packages/localizations/src/bg-BG.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -129,6 +129,7 @@ export const bgBG: LocalizationResource = {
},
membersPage: {
action__invite: 'Покани',
action__search: undefined,
activeMembersTab: {
menuAction__remove: 'Премахване на член',
tableHeader__actions: undefined,
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content
Merged
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
8 changes: 8 additions & 0 deletions .changeset/poor-rockets-look.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
---
'@clerk/localizations': patch
'@clerk/clerk-js': patch
'@clerk/shared': patch
'@clerk/types': patch
---

Introduced searching for members list on `OrganizationProfile`
10 changes: 6 additions & 4 deletions packages/clerk-js/src/ui/common/NotificationCountBadge.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,19 +7,21 @@ import { animations } from '../styledSystem';
type NotificationCountBadgeProps = PropsOfComponent<typeof NotificationBadge> & {
notificationCount: number;
containerSx?: ThemableCssProp;
shouldAnimate?: boolean;
};

export const NotificationCountBadge = (props: NotificationCountBadgeProps) => {
const { notificationCount, containerSx, ...restProps } = props;
const { notificationCount, containerSx, shouldAnimate = true, ...restProps } = props;
const prefersReducedMotion = usePrefersReducedMotion();
const { t } = useLocalizations();
const localeKey = t(localizationKeys('locale'));
const formattedNotificationCount = formatToCompactNumber(notificationCount, localeKey);

const enterExitAnimation: ThemableCssProp = t => ({
animation: prefersReducedMotion
? 'none'
: `${animations.notificationAnimation} ${t.transitionDuration.$textField} ${t.transitionTiming.$slowBezier} 0s 1 normal forwards`,
animation:
Comment thread
LauraBeatris marked this conversation as resolved.
shouldAnimate && !prefersReducedMotion
? `${animations.notificationAnimation} ${t.transitionDuration.$textField} ${t.transitionTiming.$slowBezier} 0s 1 normal forwards`
: 'none',
});

return (
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,16 +8,14 @@ import { useFetchRoles, useLocalizeCustomRoles } from '../../hooks/useFetchRoles
import { handleError } from '../../utils';
import { DataTable, RoleSelect, RowContainer } from './MemberListTable';

const membershipsParams = {
memberships: {
pageSize: 10,
keepPreviousData: true,
},
type ActiveMembersListProps = {
memberships: ReturnType<typeof useOrganization>['memberships'];
pageSize: number;
};

export const ActiveMembersList = () => {
export const ActiveMembersList = ({ memberships, pageSize }: ActiveMembersListProps) => {
const card = useCardState();
const { organization, memberships } = useOrganization(membershipsParams);
const { organization} = useOrganization();

const { options, isLoading: loadingRoles } = useFetchRoles();

Expand All@@ -44,8 +42,8 @@ export const ActiveMembersList = () => {
onPageChange={n => memberships?.fetchPage?.(n)}
itemCount={memberships?.count || 0}
pageCount={memberships?.pageCount || 0}
itemsPerPage={membershipsParams.memberships.pageSize}
isLoading={memberships?.isLoading || loadingRoles}
itemsPerPage={pageSize}
isLoading={(memberships?.isLoading && !memberships?.data.length) || loadingRoles}
emptyStateLocalizationKey={localizationKeys('organizationProfile.membersPage.detailsTitle__emptyRow')}
headers={[
localizationKeys('organizationProfile.membersPage.activeMembersTab.tableHeader__user'),
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,22 +4,31 @@ import { Animated } from '../../elements';
import { Action } from '../../elements/Action';
import { InviteMembersScreen } from './InviteMembersScreen';

export const MembersActionsRow = () => {
type MembersActionsRowProps = {
actionSlot?: React.ReactNode;
};

export const MembersActionsRow = ({ actionSlot }: MembersActionsRowProps) => {
const canManageMemberships = useProtect({ permission: 'org:sys_memberships:manage' });

return (
<Action.Root animate={false}>
<Animated asChild>
<Flex
justify='end'
justify={actionSlot ? 'between' : 'end'}
sx={t => ({
width: '100%',
marginLeft: 'auto',
padding: `${t.space.$none} ${t.space.$1}`,
})}
gap={actionSlot ? 2 : undefined}
>
{actionSlot}
{canManageMemberships && (
<Action.Trigger value='invite'>
<Action.Trigger
value='invite'
hideOnActive={!actionSlot}
>
<Button
elementDescriptor={descriptors.membersPageInviteButton}
aria-label='Invite'
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
import type { useOrganization } from '@clerk/shared/react';
import type { GetMembersParams } from '@clerk/types';
import { useEffect, useRef } from 'react';

import { descriptors, Flex, Icon, localizationKeys, useLocalizations } from '../../../ui/customizables';
import { Animated, InputWithIcon } from '../../../ui/elements';
import { MagnifyingGlass } from '../../../ui/icons';
import { Spinner } from '../../../ui/primitives';
import { ACTIVE_MEMBERS_PAGE_SIZE } from './OrganizationMembers';

type MembersSearchProps = {
/**
* Controlled query param state by parent component
*/
query: GetMembersParams['query'];
/**
* Controlled input field value by parent component
*/
value: string;
/**
* Paginated organization memberships
*/
memberships: ReturnType<typeof useOrganization>['memberships'];
/**
* Handler for change event on input field
*/
onSearchChange: (value: string) => void;
/**
* Handler for `query` value changes
*/
onQueryTrigger: (query: string) => void;
};

const membersSearchDebounceMs = 500;

export const MembersSearch = ({ query, value, memberships, onSearchChange, onQueryTrigger }: MembersSearchProps) => {
const { t } = useLocalizations();

const debounceTimer = useRef<ReturnType<typeof setTimeout> | null>(null);

const handleChange = (event: React.ChangeEvent<HTMLInputElement>) => {
const eventValue = event.target.value;
onSearchChange(eventValue);

const shouldClearQuery = eventValue === '';
if (shouldClearQuery) {
onQueryTrigger(eventValue);
}
};

// Debounce the input value changes until the user stops typing
// to trigger the `query` param setter
function handleKeyUp() {
if (debounceTimer.current) {
clearTimeout(debounceTimer.current);
}

debounceTimer.current = setTimeout(() => {
onQueryTrigger(value.trim());
}, membersSearchDebounceMs);
}

// If search is not performed on a initial page, resets pagination offset
// based on the response count
useEffect(() => {
if (!query || !memberships?.data) {
return;
}

const hasOnePageLeft = (memberships?.count ?? 0) <= ACTIVE_MEMBERS_PAGE_SIZE;
if (hasOnePageLeft) {
memberships?.fetchPage?.(1);
}
}, [query, memberships]);

const isFetchingNewData = value && !!memberships?.isLoading && !!memberships.data?.length;

return (
<Animated asChild>
<Flex sx={{ width: '100%' }}>
<InputWithIcon
value={value}
type='search'
autoCapitalize='none'
spellCheck={false}
aria-label='Search'
placeholder={t(localizationKeys('organizationProfile.membersPage.action__search'))}
leftIcon={
isFetchingNewData ? (
<Spinner size='xs' />
) : (
<Icon
icon={MagnifyingGlass}
elementDescriptor={descriptors.organizationProfileMembersSearchInputIcon}
/>
)
}
onKeyUp={handleKeyUp}
onChange={handleChange}
elementDescriptor={descriptors.organizationProfileMembersSearchInput}
/>
</Flex>
</Animated>
);
};
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { useOrganization } from '@clerk/shared/react';
import { useState } from 'react';

import { NotificationCountBadge, useProtect } from '../../common';
import { useEnvironment, useOrganizationProfileContext } from '../../contexts';
Expand All@@ -20,19 +21,31 @@ import { mqu } from '../../styledSystem';
import { ActiveMembersList } from './ActiveMembersList';
import { MembersActionsRow } from './MembersActions';
import { MembershipWidget } from './MembershipWidget';
import { MembersSearch } from './MembersSearch';
import { OrganizationMembersTabInvitations } from './OrganizationMembersTabInvitations';
import { OrganizationMembersTabRequests } from './OrganizationMembersTabRequests';

export const ACTIVE_MEMBERS_PAGE_SIZE = 10;

export const OrganizationMembers = withCardStateProvider(() => {
const { organizationSettings } = useEnvironment();
const card = useCardState();
const canManageMemberships = useProtect({ permission: 'org:sys_memberships:manage' });
const canReadMemberships = useProtect({ permission: 'org:sys_memberships:read' });
const isDomainsEnabled = organizationSettings?.domains?.enabled && canManageMemberships;

const [query, setQuery] = useState('');
const [search, setSearch] = useState('');

const { membershipRequests, memberships, invitations } = useOrganization({
membershipRequests: isDomainsEnabled || undefined,
invitations: canManageMemberships || undefined,
memberships: canReadMemberships || undefined,
memberships: canReadMemberships
? {
keepPreviousData: true,
query: query || undefined,
}
: undefined,
});

// @ts-expect-error This property is not typed. It is used by our dashboard in order to render a billing widget.
Expand DownExpand Up@@ -74,8 +87,9 @@ export const OrganizationMembers = withCardStateProvider(() => {
<TabsList sx={t => ({ gap: t.space.$2 })}>
{canReadMemberships && (
<Tab localizationKey={localizationKeys('organizationProfile.membersPage.start.headerTitle__members')}>
{memberships?.data && !memberships.isLoading && (
{!!memberships?.count && (
<NotificationCountBadge
shouldAnimate={!query}
notificationCount={memberships.count}
colorScheme='outline'
/>
Expand DownExpand Up@@ -123,8 +137,21 @@ export const OrganizationMembers = withCardStateProvider(() => {
width: '100%',
}}
>
<MembersActionsRow />
<ActiveMembersList />
<MembersActionsRow
actionSlot={
<MembersSearch
query={query}
value={search}
memberships={memberships}
onSearchChange={query => setSearch(query)}
onQueryTrigger={query => setQuery(query)}
/>
}
/>
<ActiveMembersList
pageSize={ACTIVE_MEMBERS_PAGE_SIZE}
memberships={memberships}
/>
</Flex>
</Flex>
</TabPanel>
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -518,7 +518,7 @@ describe('OrganizationMembers', () => {
await waitFor(async () =>
expect(await findByRole('heading', { name: /invite new members/i })).toBeInTheDocument(),
);
expect(inviteButton).not.toBeInTheDocument();
expect(inviteButton).toBeInTheDocument();

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

await userEvent.click(getByRole('button', { name: 'Cancel' }));

await waitFor(async () => expect(await findByRole('button', { name: 'Invite' })).toBeInTheDocument());
Expand Down
3 changes: 3 additions & 0 deletions packages/clerk-js/src/ui/customizables/elementDescriptors.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -155,6 +155,9 @@ export const APPEARANCE_KEYS = containsAllElementsConfigKeys([
'organizationSwitcherPopoverActionButtonIcon',
'organizationSwitcherPopoverFooter',

'organizationProfileMembersSearchInputIcon',
'organizationProfileMembersSearchInput',

'organizationListPreviewItems',
'organizationListPreviewItem',
'organizationListPreviewButton',
Expand Down
5 changes: 3 additions & 2 deletions packages/clerk-js/src/ui/elements/Action/ActionTrigger.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,18 +4,19 @@ import { useActionContext } from './ActionRoot';

type ActionTriggerProps = PropsWithChildren<{
value: string;
hideOnActive?: boolean;
}>;

export const ActionTrigger = (props: ActionTriggerProps) => {
const { children, value } = props;
const { children, value, hideOnActive = true } = props;

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

This preserves the "invite" action button alongside the search input, otherwise, it'll lead to a layout height jump:

CleanShot.2025-01-21.at.08.30.04.mp4

const { active, open } = useActionContext();

const validChildren = Children.only(children);
if (!isValidElement(validChildren)) {
throw new Error('Children of ActionTrigger must be a valid element');
}

if (active === value) {
if (hideOnActive && active === value) {
return null;
}

Expand Down
35 changes: 25 additions & 10 deletions packages/clerk-js/src/ui/elements/InputWithIcon.tsx
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import React from 'react';

import { Flex, Input } from '../customizables';
import { Box, Flex, Input } from '../customizables';
import type { PropsOfComponent } from '../styledSystem';

type InputWithIcon = PropsOfComponent<typeof Input> & { leftIcon?: React.ReactElement };
Expand All@@ -10,18 +10,33 @@ export const InputWithIcon = React.forwardRef<HTMLInputElement, InputWithIcon>((
return (
<Flex
center
sx={theme => ({
sx={{
width: '100%',
position: 'relative',
'& .cl-internal-icon': {
position: 'absolute',
left: theme.space.$4,
width: theme.sizes.$3x5,
height: theme.sizes.$3x5,
},
})}
}}
>
{leftIcon && React.cloneElement(leftIcon, { className: 'cl-internal-icon' })}
{leftIcon ? (
<Box
sx={theme => [
{
position: 'absolute',
left: theme.space.$3x5,
width: theme.sizes.$3x5,
height: theme.sizes.$3x5,
pointerEvents: 'none',
display: 'grid',
placeContent: 'center',
'& svg': {
position: 'absolute',
width: '100%',
height: '100%',
},
},
]}
>
{leftIcon}
</Box>
) : null}
<Input
{...rest}
sx={[
Expand Down
1 change: 1 addition & 0 deletions packages/localizations/src/ar-SA.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -129,6 +129,7 @@ export const arSA: LocalizationResource = {
},
membersPage: {
action__invite: 'دعوة',
action__search: undefined,
activeMembersTab: {
menuAction__remove: 'إزالة عضو',
tableHeader__actions: undefined,
Expand Down
1 change: 1 addition & 0 deletions packages/localizations/src/be-BY.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -130,6 +130,7 @@ export const beBY: LocalizationResource = {
},
membersPage: {
action__invite: 'Пригласить',
action__search: undefined,
activeMembersTab: {
menuAction__remove: 'Удалить удзельніка',
tableHeader__actions: 'Дзеянні',
Expand Down
1 change: 1 addition & 0 deletions packages/localizations/src/bg-BG.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -129,6 +129,7 @@ export const bgBG: LocalizationResource = {
},
membersPage: {
action__invite: 'Покани',
action__search: undefined,
activeMembersTab: {
menuAction__remove: 'Премахване на член',
tableHeader__actions: undefined,
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
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
8 changes: 8 additions & 0 deletions .changeset/poor-rockets-look.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
---
'@clerk/localizations': patch
'@clerk/clerk-js': patch
'@clerk/shared': patch
'@clerk/types': patch
---

Introduced searching for members list on `OrganizationProfile`
10 changes: 6 additions & 4 deletions packages/clerk-js/src/ui/common/NotificationCountBadge.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,19 +7,21 @@ import { animations } from '../styledSystem';
type NotificationCountBadgeProps = PropsOfComponent<typeof NotificationBadge> & {
notificationCount: number;
containerSx?: ThemableCssProp;
shouldAnimate?: boolean;
};

export const NotificationCountBadge = (props: NotificationCountBadgeProps) => {
const { notificationCount, containerSx, ...restProps } = props;
const { notificationCount, containerSx, shouldAnimate = true, ...restProps } = props;
const prefersReducedMotion = usePrefersReducedMotion();
const { t } = useLocalizations();
const localeKey = t(localizationKeys('locale'));
const formattedNotificationCount = formatToCompactNumber(notificationCount, localeKey);

const enterExitAnimation: ThemableCssProp = t => ({
animation: prefersReducedMotion
? 'none'
: `${animations.notificationAnimation} ${t.transitionDuration.$textField} ${t.transitionTiming.$slowBezier} 0s 1 normal forwards`,
animation:
Comment thread
LauraBeatris marked this conversation as resolved.
shouldAnimate && !prefersReducedMotion
? `${animations.notificationAnimation} ${t.transitionDuration.$textField} ${t.transitionTiming.$slowBezier} 0s 1 normal forwards`
: 'none',
});

return (
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,16 +8,14 @@ import { useFetchRoles, useLocalizeCustomRoles } from '../../hooks/useFetchRoles
import { handleError } from '../../utils';
import { DataTable, RoleSelect, RowContainer } from './MemberListTable';

const membershipsParams = {
memberships: {
pageSize: 10,
keepPreviousData: true,
},
type ActiveMembersListProps = {
memberships: ReturnType<typeof useOrganization>['memberships'];
pageSize: number;
};

export const ActiveMembersList = () => {
export const ActiveMembersList = ({ memberships, pageSize }: ActiveMembersListProps) => {
const card = useCardState();
const { organization, memberships } = useOrganization(membershipsParams);
const { organization} = useOrganization();

const { options, isLoading: loadingRoles } = useFetchRoles();

Expand All@@ -44,8 +42,8 @@ export const ActiveMembersList = () => {
onPageChange={n => memberships?.fetchPage?.(n)}
itemCount={memberships?.count || 0}
pageCount={memberships?.pageCount || 0}
itemsPerPage={membershipsParams.memberships.pageSize}
isLoading={memberships?.isLoading || loadingRoles}
itemsPerPage={pageSize}
isLoading={(memberships?.isLoading && !memberships?.data.length) || loadingRoles}
emptyStateLocalizationKey={localizationKeys('organizationProfile.membersPage.detailsTitle__emptyRow')}
headers={[
localizationKeys('organizationProfile.membersPage.activeMembersTab.tableHeader__user'),
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,22 +4,31 @@ import { Animated } from '../../elements';
import { Action } from '../../elements/Action';
import { InviteMembersScreen } from './InviteMembersScreen';

export const MembersActionsRow = () => {
type MembersActionsRowProps = {
actionSlot?: React.ReactNode;
};

export const MembersActionsRow = ({ actionSlot }: MembersActionsRowProps) => {
const canManageMemberships = useProtect({ permission: 'org:sys_memberships:manage' });

return (
<Action.Root animate={false}>
<Animated asChild>
<Flex
justify='end'
justify={actionSlot ? 'between' : 'end'}
sx={t => ({
width: '100%',
marginLeft: 'auto',
padding: `${t.space.$none} ${t.space.$1}`,
})}
gap={actionSlot ? 2 : undefined}
>
{actionSlot}
{canManageMemberships && (
<Action.Trigger value='invite'>
<Action.Trigger
value='invite'
hideOnActive={!actionSlot}
>
<Button
elementDescriptor={descriptors.membersPageInviteButton}
aria-label='Invite'
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
import type { useOrganization } from '@clerk/shared/react';
import type { GetMembersParams } from '@clerk/types';
import { useEffect, useRef } from 'react';

import { descriptors, Flex, Icon, localizationKeys, useLocalizations } from '../../../ui/customizables';
import { Animated, InputWithIcon } from '../../../ui/elements';
import { MagnifyingGlass } from '../../../ui/icons';
import { Spinner } from '../../../ui/primitives';
import { ACTIVE_MEMBERS_PAGE_SIZE } from './OrganizationMembers';

type MembersSearchProps = {
/**
* Controlled query param state by parent component
*/
query: GetMembersParams['query'];
/**
* Controlled input field value by parent component
*/
value: string;
/**
* Paginated organization memberships
*/
memberships: ReturnType<typeof useOrganization>['memberships'];
/**
* Handler for change event on input field
*/
onSearchChange: (value: string) => void;
/**
* Handler for `query` value changes
*/
onQueryTrigger: (query: string) => void;
};

const membersSearchDebounceMs = 500;

export const MembersSearch = ({ query, value, memberships, onSearchChange, onQueryTrigger }: MembersSearchProps) => {
const { t } = useLocalizations();

const debounceTimer = useRef<ReturnType<typeof setTimeout> | null>(null);

const handleChange = (event: React.ChangeEvent<HTMLInputElement>) => {
const eventValue = event.target.value;
onSearchChange(eventValue);

const shouldClearQuery = eventValue === '';
if (shouldClearQuery) {
onQueryTrigger(eventValue);
}
};

// Debounce the input value changes until the user stops typing
// to trigger the `query` param setter
function handleKeyUp() {
if (debounceTimer.current) {
clearTimeout(debounceTimer.current);
}

debounceTimer.current = setTimeout(() => {
onQueryTrigger(value.trim());
}, membersSearchDebounceMs);
}

// If search is not performed on a initial page, resets pagination offset
// based on the response count
useEffect(() => {
if (!query || !memberships?.data) {
return;
}

const hasOnePageLeft = (memberships?.count ?? 0) <= ACTIVE_MEMBERS_PAGE_SIZE;
if (hasOnePageLeft) {
memberships?.fetchPage?.(1);
}
}, [query, memberships]);

const isFetchingNewData = value && !!memberships?.isLoading && !!memberships.data?.length;

return (
<Animated asChild>
<Flex sx={{ width: '100%' }}>
<InputWithIcon
value={value}
type='search'
autoCapitalize='none'
spellCheck={false}
aria-label='Search'
placeholder={t(localizationKeys('organizationProfile.membersPage.action__search'))}
leftIcon={
isFetchingNewData ? (
<Spinner size='xs' />
) : (
<Icon
icon={MagnifyingGlass}
elementDescriptor={descriptors.organizationProfileMembersSearchInputIcon}
/>
)
}
onKeyUp={handleKeyUp}
onChange={handleChange}
elementDescriptor={descriptors.organizationProfileMembersSearchInput}
/>
</Flex>
</Animated>
);
};
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { useOrganization } from '@clerk/shared/react';
import { useState } from 'react';

import { NotificationCountBadge, useProtect } from '../../common';
import { useEnvironment, useOrganizationProfileContext } from '../../contexts';
Expand All@@ -20,19 +21,31 @@ import { mqu } from '../../styledSystem';
import { ActiveMembersList } from './ActiveMembersList';
import { MembersActionsRow } from './MembersActions';
import { MembershipWidget } from './MembershipWidget';
import { MembersSearch } from './MembersSearch';
import { OrganizationMembersTabInvitations } from './OrganizationMembersTabInvitations';
import { OrganizationMembersTabRequests } from './OrganizationMembersTabRequests';

export const ACTIVE_MEMBERS_PAGE_SIZE = 10;

export const OrganizationMembers = withCardStateProvider(() => {
const { organizationSettings } = useEnvironment();
const card = useCardState();
const canManageMemberships = useProtect({ permission: 'org:sys_memberships:manage' });
const canReadMemberships = useProtect({ permission: 'org:sys_memberships:read' });
const isDomainsEnabled = organizationSettings?.domains?.enabled && canManageMemberships;

const [query, setQuery] = useState('');
const [search, setSearch] = useState('');

const { membershipRequests, memberships, invitations } = useOrganization({
membershipRequests: isDomainsEnabled || undefined,
invitations: canManageMemberships || undefined,
memberships: canReadMemberships || undefined,
memberships: canReadMemberships
? {
keepPreviousData: true,
query: query || undefined,
}
: undefined,
});

// @ts-expect-error This property is not typed. It is used by our dashboard in order to render a billing widget.
Expand DownExpand Up@@ -74,8 +87,9 @@ export const OrganizationMembers = withCardStateProvider(() => {
<TabsList sx={t => ({ gap: t.space.$2 })}>
{canReadMemberships && (
<Tab localizationKey={localizationKeys('organizationProfile.membersPage.start.headerTitle__members')}>
{memberships?.data && !memberships.isLoading && (
{!!memberships?.count && (
<NotificationCountBadge
shouldAnimate={!query}
notificationCount={memberships.count}
colorScheme='outline'
/>
Expand DownExpand Up@@ -123,8 +137,21 @@ export const OrganizationMembers = withCardStateProvider(() => {
width: '100%',
}}
>
<MembersActionsRow />
<ActiveMembersList />
<MembersActionsRow
actionSlot={
<MembersSearch
query={query}
value={search}
memberships={memberships}
onSearchChange={query => setSearch(query)}
onQueryTrigger={query => setQuery(query)}
/>
}
/>
<ActiveMembersList
pageSize={ACTIVE_MEMBERS_PAGE_SIZE}
memberships={memberships}
/>
</Flex>
</Flex>
</TabPanel>
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -518,7 +518,7 @@ describe('OrganizationMembers', () => {
await waitFor(async () =>
expect(await findByRole('heading', { name: /invite new members/i })).toBeInTheDocument(),
);
expect(inviteButton).not.toBeInTheDocument();
expect(inviteButton).toBeInTheDocument();

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

await userEvent.click(getByRole('button', { name: 'Cancel' }));

await waitFor(async () => expect(await findByRole('button', { name: 'Invite' })).toBeInTheDocument());
Expand Down
3 changes: 3 additions & 0 deletions packages/clerk-js/src/ui/customizables/elementDescriptors.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -155,6 +155,9 @@ export const APPEARANCE_KEYS = containsAllElementsConfigKeys([
'organizationSwitcherPopoverActionButtonIcon',
'organizationSwitcherPopoverFooter',

'organizationProfileMembersSearchInputIcon',
'organizationProfileMembersSearchInput',

'organizationListPreviewItems',
'organizationListPreviewItem',
'organizationListPreviewButton',
Expand Down
5 changes: 3 additions & 2 deletions packages/clerk-js/src/ui/elements/Action/ActionTrigger.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,18 +4,19 @@ import { useActionContext } from './ActionRoot';

type ActionTriggerProps = PropsWithChildren<{
value: string;
hideOnActive?: boolean;
}>;

export const ActionTrigger = (props: ActionTriggerProps) => {
const { children, value } = props;
const { children, value, hideOnActive = true } = props;

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

This preserves the "invite" action button alongside the search input, otherwise, it'll lead to a layout height jump:

CleanShot.2025-01-21.at.08.30.04.mp4

const { active, open } = useActionContext();

const validChildren = Children.only(children);
if (!isValidElement(validChildren)) {
throw new Error('Children of ActionTrigger must be a valid element');
}

if (active === value) {
if (hideOnActive && active === value) {
return null;
}

Expand Down
35 changes: 25 additions & 10 deletions packages/clerk-js/src/ui/elements/InputWithIcon.tsx
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import React from 'react';

import { Flex, Input } from '../customizables';
import { Box, Flex, Input } from '../customizables';
import type { PropsOfComponent } from '../styledSystem';

type InputWithIcon = PropsOfComponent<typeof Input> & { leftIcon?: React.ReactElement };
Expand All@@ -10,18 +10,33 @@ export const InputWithIcon = React.forwardRef<HTMLInputElement, InputWithIcon>((
return (
<Flex
center
sx={theme => ({
sx={{
width: '100%',
position: 'relative',
'& .cl-internal-icon': {
position: 'absolute',
left: theme.space.$4,
width: theme.sizes.$3x5,
height: theme.sizes.$3x5,
},
})}
}}
>
{leftIcon && React.cloneElement(leftIcon, { className: 'cl-internal-icon' })}
{leftIcon ? (
<Box
sx={theme => [
{
position: 'absolute',
left: theme.space.$3x5,
width: theme.sizes.$3x5,
height: theme.sizes.$3x5,
pointerEvents: 'none',
display: 'grid',
placeContent: 'center',
'& svg': {
position: 'absolute',
width: '100%',
height: '100%',
},
},
]}
>
{leftIcon}
</Box>
) : null}
<Input
{...rest}
sx={[
Expand Down
1 change: 1 addition & 0 deletions packages/localizations/src/ar-SA.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -129,6 +129,7 @@ export const arSA: LocalizationResource = {
},
membersPage: {
action__invite: 'دعوة',
action__search: undefined,
activeMembersTab: {
menuAction__remove: 'إزالة عضو',
tableHeader__actions: undefined,
Expand Down
1 change: 1 addition & 0 deletions packages/localizations/src/be-BY.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -130,6 +130,7 @@ export const beBY: LocalizationResource = {
},
membersPage: {
action__invite: 'Пригласить',
action__search: undefined,
activeMembersTab: {
menuAction__remove: 'Удалить удзельніка',
tableHeader__actions: 'Дзеянні',
Expand Down
1 change: 1 addition & 0 deletions packages/localizations/src/bg-BG.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -129,6 +129,7 @@ export const bgBG: LocalizationResource = {
},
membersPage: {
action__invite: 'Покани',
action__search: undefined,
activeMembersTab: {
menuAction__remove: 'Премахване на член',
tableHeader__actions: undefined,
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
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
8 changes: 8 additions & 0 deletions .changeset/poor-rockets-look.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
---
'@clerk/localizations': patch
'@clerk/clerk-js': patch
'@clerk/shared': patch
'@clerk/types': patch
---

Introduced searching for members list on `OrganizationProfile`
10 changes: 6 additions & 4 deletions packages/clerk-js/src/ui/common/NotificationCountBadge.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,19 +7,21 @@ import { animations } from '../styledSystem';
type NotificationCountBadgeProps = PropsOfComponent<typeof NotificationBadge> & {
notificationCount: number;
containerSx?: ThemableCssProp;
shouldAnimate?: boolean;
};

export const NotificationCountBadge = (props: NotificationCountBadgeProps) => {
const { notificationCount, containerSx, ...restProps } = props;
const { notificationCount, containerSx, shouldAnimate = true, ...restProps } = props;
const prefersReducedMotion = usePrefersReducedMotion();
const { t } = useLocalizations();
const localeKey = t(localizationKeys('locale'));
const formattedNotificationCount = formatToCompactNumber(notificationCount, localeKey);

const enterExitAnimation: ThemableCssProp = t => ({
animation: prefersReducedMotion
? 'none'
: `${animations.notificationAnimation} ${t.transitionDuration.$textField} ${t.transitionTiming.$slowBezier} 0s 1 normal forwards`,
animation:
Comment thread
LauraBeatris marked this conversation as resolved.
shouldAnimate && !prefersReducedMotion
? `${animations.notificationAnimation} ${t.transitionDuration.$textField} ${t.transitionTiming.$slowBezier} 0s 1 normal forwards`
: 'none',
});

return (
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,16 +8,14 @@ import { useFetchRoles, useLocalizeCustomRoles } from '../../hooks/useFetchRoles
import { handleError } from '../../utils';
import { DataTable, RoleSelect, RowContainer } from './MemberListTable';

const membershipsParams = {
memberships: {
pageSize: 10,
keepPreviousData: true,
},
type ActiveMembersListProps = {
memberships: ReturnType<typeof useOrganization>['memberships'];
pageSize: number;
};

export const ActiveMembersList = () => {
export const ActiveMembersList = ({ memberships, pageSize }: ActiveMembersListProps) => {
const card = useCardState();
const { organization, memberships } = useOrganization(membershipsParams);
const { organization} = useOrganization();

const { options, isLoading: loadingRoles } = useFetchRoles();

Expand All@@ -44,8 +42,8 @@ export const ActiveMembersList = () => {
onPageChange={n => memberships?.fetchPage?.(n)}
itemCount={memberships?.count || 0}
pageCount={memberships?.pageCount || 0}
itemsPerPage={membershipsParams.memberships.pageSize}
isLoading={memberships?.isLoading || loadingRoles}
itemsPerPage={pageSize}
isLoading={(memberships?.isLoading && !memberships?.data.length) || loadingRoles}
emptyStateLocalizationKey={localizationKeys('organizationProfile.membersPage.detailsTitle__emptyRow')}
headers={[
localizationKeys('organizationProfile.membersPage.activeMembersTab.tableHeader__user'),
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,22 +4,31 @@ import { Animated } from '../../elements';
import { Action } from '../../elements/Action';
import { InviteMembersScreen } from './InviteMembersScreen';

export const MembersActionsRow = () => {
type MembersActionsRowProps = {
actionSlot?: React.ReactNode;
};

export const MembersActionsRow = ({ actionSlot }: MembersActionsRowProps) => {
const canManageMemberships = useProtect({ permission: 'org:sys_memberships:manage' });

return (
<Action.Root animate={false}>
<Animated asChild>
<Flex
justify='end'
justify={actionSlot ? 'between' : 'end'}
sx={t => ({
width: '100%',
marginLeft: 'auto',
padding: `${t.space.$none} ${t.space.$1}`,
})}
gap={actionSlot ? 2 : undefined}
>
{actionSlot}
{canManageMemberships && (
<Action.Trigger value='invite'>
<Action.Trigger
value='invite'
hideOnActive={!actionSlot}
>
<Button
elementDescriptor={descriptors.membersPageInviteButton}
aria-label='Invite'
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
import type { useOrganization } from '@clerk/shared/react';
import type { GetMembersParams } from '@clerk/types';
import { useEffect, useRef } from 'react';

import { descriptors, Flex, Icon, localizationKeys, useLocalizations } from '../../../ui/customizables';
import { Animated, InputWithIcon } from '../../../ui/elements';
import { MagnifyingGlass } from '../../../ui/icons';
import { Spinner } from '../../../ui/primitives';
import { ACTIVE_MEMBERS_PAGE_SIZE } from './OrganizationMembers';

type MembersSearchProps = {
/**
* Controlled query param state by parent component
*/
query: GetMembersParams['query'];
/**
* Controlled input field value by parent component
*/
value: string;
/**
* Paginated organization memberships
*/
memberships: ReturnType<typeof useOrganization>['memberships'];
/**
* Handler for change event on input field
*/
onSearchChange: (value: string) => void;
/**
* Handler for `query` value changes
*/
onQueryTrigger: (query: string) => void;
};

const membersSearchDebounceMs = 500;

export const MembersSearch = ({ query, value, memberships, onSearchChange, onQueryTrigger }: MembersSearchProps) => {
const { t } = useLocalizations();

const debounceTimer = useRef<ReturnType<typeof setTimeout> | null>(null);

const handleChange = (event: React.ChangeEvent<HTMLInputElement>) => {
const eventValue = event.target.value;
onSearchChange(eventValue);

const shouldClearQuery = eventValue === '';
if (shouldClearQuery) {
onQueryTrigger(eventValue);
}
};

// Debounce the input value changes until the user stops typing
// to trigger the `query` param setter
function handleKeyUp() {
if (debounceTimer.current) {
clearTimeout(debounceTimer.current);
}

debounceTimer.current = setTimeout(() => {
onQueryTrigger(value.trim());
}, membersSearchDebounceMs);
}

// If search is not performed on a initial page, resets pagination offset
// based on the response count
useEffect(() => {
if (!query || !memberships?.data) {
return;
}

const hasOnePageLeft = (memberships?.count ?? 0) <= ACTIVE_MEMBERS_PAGE_SIZE;
if (hasOnePageLeft) {
memberships?.fetchPage?.(1);
}
}, [query, memberships]);

const isFetchingNewData = value && !!memberships?.isLoading && !!memberships.data?.length;

return (
<Animated asChild>
<Flex sx={{ width: '100%' }}>
<InputWithIcon
value={value}
type='search'
autoCapitalize='none'
spellCheck={false}
aria-label='Search'
placeholder={t(localizationKeys('organizationProfile.membersPage.action__search'))}
leftIcon={
isFetchingNewData ? (
<Spinner size='xs' />
) : (
<Icon
icon={MagnifyingGlass}
elementDescriptor={descriptors.organizationProfileMembersSearchInputIcon}
/>
)
}
onKeyUp={handleKeyUp}
onChange={handleChange}
elementDescriptor={descriptors.organizationProfileMembersSearchInput}
/>
</Flex>
</Animated>
);
};
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { useOrganization } from '@clerk/shared/react';
import { useState } from 'react';

import { NotificationCountBadge, useProtect } from '../../common';
import { useEnvironment, useOrganizationProfileContext } from '../../contexts';
Expand All@@ -20,19 +21,31 @@ import { mqu } from '../../styledSystem';
import { ActiveMembersList } from './ActiveMembersList';
import { MembersActionsRow } from './MembersActions';
import { MembershipWidget } from './MembershipWidget';
import { MembersSearch } from './MembersSearch';
import { OrganizationMembersTabInvitations } from './OrganizationMembersTabInvitations';
import { OrganizationMembersTabRequests } from './OrganizationMembersTabRequests';

export const ACTIVE_MEMBERS_PAGE_SIZE = 10;

export const OrganizationMembers = withCardStateProvider(() => {
const { organizationSettings } = useEnvironment();
const card = useCardState();
const canManageMemberships = useProtect({ permission: 'org:sys_memberships:manage' });
const canReadMemberships = useProtect({ permission: 'org:sys_memberships:read' });
const isDomainsEnabled = organizationSettings?.domains?.enabled && canManageMemberships;

const [query, setQuery] = useState('');
const [search, setSearch] = useState('');

const { membershipRequests, memberships, invitations } = useOrganization({
membershipRequests: isDomainsEnabled || undefined,
invitations: canManageMemberships || undefined,
memberships: canReadMemberships || undefined,
memberships: canReadMemberships
? {
keepPreviousData: true,
query: query || undefined,
}
: undefined,
});

// @ts-expect-error This property is not typed. It is used by our dashboard in order to render a billing widget.
Expand DownExpand Up@@ -74,8 +87,9 @@ export const OrganizationMembers = withCardStateProvider(() => {
<TabsList sx={t => ({ gap: t.space.$2 })}>
{canReadMemberships && (
<Tab localizationKey={localizationKeys('organizationProfile.membersPage.start.headerTitle__members')}>
{memberships?.data && !memberships.isLoading && (
{!!memberships?.count && (
<NotificationCountBadge
shouldAnimate={!query}
notificationCount={memberships.count}
colorScheme='outline'
/>
Expand DownExpand Up@@ -123,8 +137,21 @@ export const OrganizationMembers = withCardStateProvider(() => {
width: '100%',
}}
>
<MembersActionsRow />
<ActiveMembersList />
<MembersActionsRow
actionSlot={
<MembersSearch
query={query}
value={search}
memberships={memberships}
onSearchChange={query => setSearch(query)}
onQueryTrigger={query => setQuery(query)}
/>
}
/>
<ActiveMembersList
pageSize={ACTIVE_MEMBERS_PAGE_SIZE}
memberships={memberships}
/>
</Flex>
</Flex>
</TabPanel>
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -518,7 +518,7 @@ describe('OrganizationMembers', () => {
await waitFor(async () =>
expect(await findByRole('heading', { name: /invite new members/i })).toBeInTheDocument(),
);
expect(inviteButton).not.toBeInTheDocument();
expect(inviteButton).toBeInTheDocument();

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

await userEvent.click(getByRole('button', { name: 'Cancel' }));

await waitFor(async () => expect(await findByRole('button', { name: 'Invite' })).toBeInTheDocument());
Expand Down
3 changes: 3 additions & 0 deletions packages/clerk-js/src/ui/customizables/elementDescriptors.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -155,6 +155,9 @@ export const APPEARANCE_KEYS = containsAllElementsConfigKeys([
'organizationSwitcherPopoverActionButtonIcon',
'organizationSwitcherPopoverFooter',

'organizationProfileMembersSearchInputIcon',
'organizationProfileMembersSearchInput',

'organizationListPreviewItems',
'organizationListPreviewItem',
'organizationListPreviewButton',
Expand Down
5 changes: 3 additions & 2 deletions packages/clerk-js/src/ui/elements/Action/ActionTrigger.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,18 +4,19 @@ import { useActionContext } from './ActionRoot';

type ActionTriggerProps = PropsWithChildren<{
value: string;
hideOnActive?: boolean;
}>;

export const ActionTrigger = (props: ActionTriggerProps) => {
const { children, value } = props;
const { children, value, hideOnActive = true } = props;

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

This preserves the "invite" action button alongside the search input, otherwise, it'll lead to a layout height jump:

CleanShot.2025-01-21.at.08.30.04.mp4

const { active, open } = useActionContext();

const validChildren = Children.only(children);
if (!isValidElement(validChildren)) {
throw new Error('Children of ActionTrigger must be a valid element');
}

if (active === value) {
if (hideOnActive && active === value) {
return null;
}

Expand Down
35 changes: 25 additions & 10 deletions packages/clerk-js/src/ui/elements/InputWithIcon.tsx
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import React from 'react';

import { Flex, Input } from '../customizables';
import { Box, Flex, Input } from '../customizables';
import type { PropsOfComponent } from '../styledSystem';

type InputWithIcon = PropsOfComponent<typeof Input> & { leftIcon?: React.ReactElement };
Expand All@@ -10,18 +10,33 @@ export const InputWithIcon = React.forwardRef<HTMLInputElement, InputWithIcon>((
return (
<Flex
center
sx={theme => ({
sx={{
width: '100%',
position: 'relative',
'& .cl-internal-icon': {
position: 'absolute',
left: theme.space.$4,
width: theme.sizes.$3x5,
height: theme.sizes.$3x5,
},
})}
}}
>
{leftIcon && React.cloneElement(leftIcon, { className: 'cl-internal-icon' })}
{leftIcon ? (
<Box
sx={theme => [
{
position: 'absolute',
left: theme.space.$3x5,
width: theme.sizes.$3x5,
height: theme.sizes.$3x5,
pointerEvents: 'none',
display: 'grid',
placeContent: 'center',
'& svg': {
position: 'absolute',
width: '100%',
height: '100%',
},
},
]}
>
{leftIcon}
</Box>
) : null}
<Input
{...rest}
sx={[
Expand Down
1 change: 1 addition & 0 deletions packages/localizations/src/ar-SA.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -129,6 +129,7 @@ export const arSA: LocalizationResource = {
},
membersPage: {
action__invite: 'دعوة',
action__search: undefined,
activeMembersTab: {
menuAction__remove: 'إزالة عضو',
tableHeader__actions: undefined,
Expand Down
1 change: 1 addition & 0 deletions packages/localizations/src/be-BY.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -130,6 +130,7 @@ export const beBY: LocalizationResource = {
},
membersPage: {
action__invite: 'Пригласить',
action__search: undefined,
activeMembersTab: {
menuAction__remove: 'Удалить удзельніка',
tableHeader__actions: 'Дзеянні',
Expand Down
1 change: 1 addition & 0 deletions packages/localizations/src/bg-BG.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -129,6 +129,7 @@ export const bgBG: LocalizationResource = {
},
membersPage: {
action__invite: 'Покани',
action__search: undefined,
activeMembersTab: {
menuAction__remove: 'Премахване на член',
tableHeader__actions: undefined,
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content
Merged
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
8 changes: 8 additions & 0 deletions .changeset/poor-rockets-look.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
---
'@clerk/localizations': patch
'@clerk/clerk-js': patch
'@clerk/shared': patch
'@clerk/types': patch
---

Introduced searching for members list on `OrganizationProfile`
10 changes: 6 additions & 4 deletions packages/clerk-js/src/ui/common/NotificationCountBadge.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,19 +7,21 @@ import { animations } from '../styledSystem';
type NotificationCountBadgeProps = PropsOfComponent<typeof NotificationBadge> & {
notificationCount: number;
containerSx?: ThemableCssProp;
shouldAnimate?: boolean;
};

export const NotificationCountBadge = (props: NotificationCountBadgeProps) => {
const { notificationCount, containerSx, ...restProps } = props;
const { notificationCount, containerSx, shouldAnimate = true, ...restProps } = props;
const prefersReducedMotion = usePrefersReducedMotion();
const { t } = useLocalizations();
const localeKey = t(localizationKeys('locale'));
const formattedNotificationCount = formatToCompactNumber(notificationCount, localeKey);

const enterExitAnimation: ThemableCssProp = t => ({
animation: prefersReducedMotion
? 'none'
: `${animations.notificationAnimation} ${t.transitionDuration.$textField} ${t.transitionTiming.$slowBezier} 0s 1 normal forwards`,
animation:
Comment thread
LauraBeatris marked this conversation as resolved.
shouldAnimate && !prefersReducedMotion
? `${animations.notificationAnimation} ${t.transitionDuration.$textField} ${t.transitionTiming.$slowBezier} 0s 1 normal forwards`
: 'none',
});

return (
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,16 +8,14 @@ import { useFetchRoles, useLocalizeCustomRoles } from '../../hooks/useFetchRoles
import { handleError } from '../../utils';
import { DataTable, RoleSelect, RowContainer } from './MemberListTable';

const membershipsParams = {
memberships: {
pageSize: 10,
keepPreviousData: true,
},
type ActiveMembersListProps = {
memberships: ReturnType<typeof useOrganization>['memberships'];
pageSize: number;
};

export const ActiveMembersList = () => {
export const ActiveMembersList = ({ memberships, pageSize }: ActiveMembersListProps) => {
const card = useCardState();
const { organization, memberships } = useOrganization(membershipsParams);
const { organization} = useOrganization();

const { options, isLoading: loadingRoles } = useFetchRoles();

Expand All@@ -44,8 +42,8 @@ export const ActiveMembersList = () => {
onPageChange={n => memberships?.fetchPage?.(n)}
itemCount={memberships?.count || 0}
pageCount={memberships?.pageCount || 0}
itemsPerPage={membershipsParams.memberships.pageSize}
isLoading={memberships?.isLoading || loadingRoles}
itemsPerPage={pageSize}
isLoading={(memberships?.isLoading && !memberships?.data.length) || loadingRoles}
emptyStateLocalizationKey={localizationKeys('organizationProfile.membersPage.detailsTitle__emptyRow')}
headers={[
localizationKeys('organizationProfile.membersPage.activeMembersTab.tableHeader__user'),
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,22 +4,31 @@ import { Animated } from '../../elements';
import { Action } from '../../elements/Action';
import { InviteMembersScreen } from './InviteMembersScreen';

export const MembersActionsRow = () => {
type MembersActionsRowProps = {
actionSlot?: React.ReactNode;
};

export const MembersActionsRow = ({ actionSlot }: MembersActionsRowProps) => {
const canManageMemberships = useProtect({ permission: 'org:sys_memberships:manage' });

return (
<Action.Root animate={false}>
<Animated asChild>
<Flex
justify='end'
justify={actionSlot ? 'between' : 'end'}
sx={t => ({
width: '100%',
marginLeft: 'auto',
padding: `${t.space.$none} ${t.space.$1}`,
})}
gap={actionSlot ? 2 : undefined}
>
{actionSlot}
{canManageMemberships && (
<Action.Trigger value='invite'>
<Action.Trigger
value='invite'
hideOnActive={!actionSlot}
>
<Button
elementDescriptor={descriptors.membersPageInviteButton}
aria-label='Invite'
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
import type { useOrganization } from '@clerk/shared/react';
import type { GetMembersParams } from '@clerk/types';
import { useEffect, useRef } from 'react';

import { descriptors, Flex, Icon, localizationKeys, useLocalizations } from '../../../ui/customizables';
import { Animated, InputWithIcon } from '../../../ui/elements';
import { MagnifyingGlass } from '../../../ui/icons';
import { Spinner } from '../../../ui/primitives';
import { ACTIVE_MEMBERS_PAGE_SIZE } from './OrganizationMembers';

type MembersSearchProps = {
/**
* Controlled query param state by parent component
*/
query: GetMembersParams['query'];
/**
* Controlled input field value by parent component
*/
value: string;
/**
* Paginated organization memberships
*/
memberships: ReturnType<typeof useOrganization>['memberships'];
/**
* Handler for change event on input field
*/
onSearchChange: (value: string) => void;
/**
* Handler for `query` value changes
*/
onQueryTrigger: (query: string) => void;
};

const membersSearchDebounceMs = 500;

export const MembersSearch = ({ query, value, memberships, onSearchChange, onQueryTrigger }: MembersSearchProps) => {
const { t } = useLocalizations();

const debounceTimer = useRef<ReturnType<typeof setTimeout> | null>(null);

const handleChange = (event: React.ChangeEvent<HTMLInputElement>) => {
const eventValue = event.target.value;
onSearchChange(eventValue);

const shouldClearQuery = eventValue === '';
if (shouldClearQuery) {
onQueryTrigger(eventValue);
}
};

// Debounce the input value changes until the user stops typing
// to trigger the `query` param setter
function handleKeyUp() {
if (debounceTimer.current) {
clearTimeout(debounceTimer.current);
}

debounceTimer.current = setTimeout(() => {
onQueryTrigger(value.trim());
}, membersSearchDebounceMs);
}

// If search is not performed on a initial page, resets pagination offset
// based on the response count
useEffect(() => {
if (!query || !memberships?.data) {
return;
}

const hasOnePageLeft = (memberships?.count ?? 0) <= ACTIVE_MEMBERS_PAGE_SIZE;
if (hasOnePageLeft) {
memberships?.fetchPage?.(1);
}
}, [query, memberships]);

const isFetchingNewData = value && !!memberships?.isLoading && !!memberships.data?.length;

return (
<Animated asChild>
<Flex sx={{ width: '100%' }}>
<InputWithIcon
value={value}
type='search'
autoCapitalize='none'
spellCheck={false}
aria-label='Search'
placeholder={t(localizationKeys('organizationProfile.membersPage.action__search'))}
leftIcon={
isFetchingNewData ? (
<Spinner size='xs' />
) : (
<Icon
icon={MagnifyingGlass}
elementDescriptor={descriptors.organizationProfileMembersSearchInputIcon}
/>
)
}
onKeyUp={handleKeyUp}
onChange={handleChange}
elementDescriptor={descriptors.organizationProfileMembersSearchInput}
/>
</Flex>
</Animated>
);
};
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { useOrganization } from '@clerk/shared/react';
import { useState } from 'react';

import { NotificationCountBadge, useProtect } from '../../common';
import { useEnvironment, useOrganizationProfileContext } from '../../contexts';
Expand All@@ -20,19 +21,31 @@ import { mqu } from '../../styledSystem';
import { ActiveMembersList } from './ActiveMembersList';
import { MembersActionsRow } from './MembersActions';
import { MembershipWidget } from './MembershipWidget';
import { MembersSearch } from './MembersSearch';
import { OrganizationMembersTabInvitations } from './OrganizationMembersTabInvitations';
import { OrganizationMembersTabRequests } from './OrganizationMembersTabRequests';

export const ACTIVE_MEMBERS_PAGE_SIZE = 10;

export const OrganizationMembers = withCardStateProvider(() => {
const { organizationSettings } = useEnvironment();
const card = useCardState();
const canManageMemberships = useProtect({ permission: 'org:sys_memberships:manage' });
const canReadMemberships = useProtect({ permission: 'org:sys_memberships:read' });
const isDomainsEnabled = organizationSettings?.domains?.enabled && canManageMemberships;

const [query, setQuery] = useState('');
const [search, setSearch] = useState('');

const { membershipRequests, memberships, invitations } = useOrganization({
membershipRequests: isDomainsEnabled || undefined,
invitations: canManageMemberships || undefined,
memberships: canReadMemberships || undefined,
memberships: canReadMemberships
? {
keepPreviousData: true,
query: query || undefined,
}
: undefined,
});

// @ts-expect-error This property is not typed. It is used by our dashboard in order to render a billing widget.
Expand DownExpand Up@@ -74,8 +87,9 @@ export const OrganizationMembers = withCardStateProvider(() => {
<TabsList sx={t => ({ gap: t.space.$2 })}>
{canReadMemberships && (
<Tab localizationKey={localizationKeys('organizationProfile.membersPage.start.headerTitle__members')}>
{memberships?.data && !memberships.isLoading && (
{!!memberships?.count && (
<NotificationCountBadge
shouldAnimate={!query}
notificationCount={memberships.count}
colorScheme='outline'
/>
Expand DownExpand Up@@ -123,8 +137,21 @@ export const OrganizationMembers = withCardStateProvider(() => {
width: '100%',
}}
>
<MembersActionsRow />
<ActiveMembersList />
<MembersActionsRow
actionSlot={
<MembersSearch
query={query}
value={search}
memberships={memberships}
onSearchChange={query => setSearch(query)}
onQueryTrigger={query => setQuery(query)}
/>
}
/>
<ActiveMembersList
pageSize={ACTIVE_MEMBERS_PAGE_SIZE}
memberships={memberships}
/>
</Flex>
</Flex>
</TabPanel>
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -518,7 +518,7 @@ describe('OrganizationMembers', () => {
await waitFor(async () =>
expect(await findByRole('heading', { name: /invite new members/i })).toBeInTheDocument(),
);
expect(inviteButton).not.toBeInTheDocument();
expect(inviteButton).toBeInTheDocument();

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

await userEvent.click(getByRole('button', { name: 'Cancel' }));

await waitFor(async () => expect(await findByRole('button', { name: 'Invite' })).toBeInTheDocument());
Expand Down
3 changes: 3 additions & 0 deletions packages/clerk-js/src/ui/customizables/elementDescriptors.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -155,6 +155,9 @@ export const APPEARANCE_KEYS = containsAllElementsConfigKeys([
'organizationSwitcherPopoverActionButtonIcon',
'organizationSwitcherPopoverFooter',

'organizationProfileMembersSearchInputIcon',
'organizationProfileMembersSearchInput',

'organizationListPreviewItems',
'organizationListPreviewItem',
'organizationListPreviewButton',
Expand Down
5 changes: 3 additions & 2 deletions packages/clerk-js/src/ui/elements/Action/ActionTrigger.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,18 +4,19 @@ import { useActionContext } from './ActionRoot';

type ActionTriggerProps = PropsWithChildren<{
value: string;
hideOnActive?: boolean;
}>;

export const ActionTrigger = (props: ActionTriggerProps) => {
const { children, value } = props;
const { children, value, hideOnActive = true } = props;

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

This preserves the "invite" action button alongside the search input, otherwise, it'll lead to a layout height jump:

CleanShot.2025-01-21.at.08.30.04.mp4

const { active, open } = useActionContext();

const validChildren = Children.only(children);
if (!isValidElement(validChildren)) {
throw new Error('Children of ActionTrigger must be a valid element');
}

if (active === value) {
if (hideOnActive && active === value) {
return null;
}

Expand Down
35 changes: 25 additions & 10 deletions packages/clerk-js/src/ui/elements/InputWithIcon.tsx
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import React from 'react';

import { Flex, Input } from '../customizables';
import { Box, Flex, Input } from '../customizables';
import type { PropsOfComponent } from '../styledSystem';

type InputWithIcon = PropsOfComponent<typeof Input> & { leftIcon?: React.ReactElement };
Expand All@@ -10,18 +10,33 @@ export const InputWithIcon = React.forwardRef<HTMLInputElement, InputWithIcon>((
return (
<Flex
center
sx={theme => ({
sx={{
width: '100%',
position: 'relative',
'& .cl-internal-icon': {
position: 'absolute',
left: theme.space.$4,
width: theme.sizes.$3x5,
height: theme.sizes.$3x5,
},
})}
}}
>
{leftIcon && React.cloneElement(leftIcon, { className: 'cl-internal-icon' })}
{leftIcon ? (
<Box
sx={theme => [
{
position: 'absolute',
left: theme.space.$3x5,
width: theme.sizes.$3x5,
height: theme.sizes.$3x5,
pointerEvents: 'none',
display: 'grid',
placeContent: 'center',
'& svg': {
position: 'absolute',
width: '100%',
height: '100%',
},
},
]}
>
{leftIcon}
</Box>
) : null}
<Input
{...rest}
sx={[
Expand Down
1 change: 1 addition & 0 deletions packages/localizations/src/ar-SA.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -129,6 +129,7 @@ export const arSA: LocalizationResource = {
},
membersPage: {
action__invite: 'دعوة',
action__search: undefined,
activeMembersTab: {
menuAction__remove: 'إزالة عضو',
tableHeader__actions: undefined,
Expand Down
1 change: 1 addition & 0 deletions packages/localizations/src/be-BY.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -130,6 +130,7 @@ export const beBY: LocalizationResource = {
},
membersPage: {
action__invite: 'Пригласить',
action__search: undefined,
activeMembersTab: {
menuAction__remove: 'Удалить удзельніка',
tableHeader__actions: 'Дзеянні',
Expand Down
1 change: 1 addition & 0 deletions packages/localizations/src/bg-BG.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -129,6 +129,7 @@ export const bgBG: LocalizationResource = {
},
membersPage: {
action__invite: 'Покани',
action__search: undefined,
activeMembersTab: {
menuAction__remove: 'Премахване на член',
tableHeader__actions: undefined,
Expand Down
Loading