The Postgres development platform. Supabase gives you a dedicated Postgres database to build your web, mobile, and AI applications.
TypeScript aialternativeauthdatabasedenoembeddingsexamplefirebasenextjsoauth2pgvectorpostgispostgrespostgresqlpostgrestrealtimesupabasevectorswebsockets
feat(auth-users): add keyboard shortcuts to users page (#45650)
Ali Waseemf06b877ac6e1
diff --git a/apps/studio/components/interfaces/Auth/Users/AddUserDropdown.tsx b/apps/studio/components/interfaces/Auth/Users/AddUserDropdown.tsxindex 56cfc295bee..a0e90fa8f01 100644--- a/apps/studio/components/interfaces/Auth/Users/AddUserDropdown.tsx+++ b/apps/studio/components/interfaces/Auth/Users/AddUserDropdown.tsx@@ -6,8 +6,10 @@ import { Button, DropdownMenu, DropdownMenuContent, DropdownMenuTrigger } from 'import CreateUserModal from './CreateUserModal'import InviteUserModal from './InviteUserModal'import { DropdownMenuItemTooltip } from '@/components/ui/DropdownMenuItemTooltip'+import { ShortcutBadge } from '@/components/ui/ShortcutBadge'import { useAsyncCheckPermissions } from '@/hooks/misc/useCheckPermissions'import { useIsFeatureEnabled } from '@/hooks/misc/useIsFeatureEnabled'+import { SHORTCUT_IDS } from '@/state/shortcuts/registry'export const AddUserDropdown = () => {const showSendInvitation = useIsFeatureEnabled('authentication:show_send_invitation')@@ -38,7 +40,7 @@ export const AddUserDropdown = () => {Add user</Button></DropdownMenuTrigger>- <DropdownMenuContent side="bottom" align="end" className="w-40">+ <DropdownMenuContent side="bottom" align="end" className="w-52">{showSendInvitation && (<DropdownMenuItemTooltipclassName="gap-x-2"@@ -50,13 +52,19 @@ export const AddUserDropdown = () => {content: { side: 'left', text: 'You need additional permissions to invite users' },}}>- <Mail size={14} />- <p>Send invitation</p>+ <Mail size={14} className="shrink-0" />+ <p className="flex-1 min-w-0">Send invitation</p>+ {canInviteUsers && (+ <ShortcutBadge+ shortcutId={SHORTCUT_IDS.AUTH_USERS_INVITE_USER}+ className="shrink-0"+ />+ )}</DropdownMenuItemTooltip>)}<DropdownMenuItemTooltip- className="space-x-2 pointer-events-auto!"+ className="gap-x-2 pointer-events-auto!"disabled={!canCreateUsers}onClick={() => {if (canCreateUsers) setCreateVisible(true)@@ -65,8 +73,14 @@ export const AddUserDropdown = () => {content: { side: 'left', text: 'You need additional permissions to create users' },}}>- <UserPlus size={14} />- <p>Create new user</p>+ <UserPlus size={14} className="shrink-0" />+ <p className="flex-1 min-w-0">Create new user</p>+ {canCreateUsers && (+ <ShortcutBadge+ shortcutId={SHORTCUT_IDS.AUTH_USERS_CREATE_USER}+ className="shrink-0"+ />+ )}</DropdownMenuItemTooltip></DropdownMenuContent></DropdownMenu>diff --git a/apps/studio/components/interfaces/Auth/Users/UsersSearch.tsx b/apps/studio/components/interfaces/Auth/Users/UsersSearch.tsxindex 8eaaa1f620a..d33de9f1015 100644--- a/apps/studio/components/interfaces/Auth/Users/UsersSearch.tsx+++ b/apps/studio/components/interfaces/Auth/Users/UsersSearch.tsx@@ -1,7 +1,7 @@import { AuthUsersSearchSubmittedEvent } from 'common/telemetry-constants'import { Search, X } from 'lucide-react'import { parseAsString, parseAsStringEnum, useQueryState } from 'nuqs'-import { useState } from 'react'+import { Dispatch, forwardRef, SetStateAction } from 'react'import {Button,cn,@@ -24,6 +24,7 @@ import {UUIDV4_LEFT_PREFIX_REGEX,} from './Users.constants'import { useSendEventMutation } from '@/data/telemetry/send-event-mutation'+import { onSearchInputEscape } from '@/lib/keyboard'const getSearchPlaceholder = (column: SpecificFilterColumn): string => {switch (column) {@@ -43,23 +44,30 @@ const getSearchPlaceholder = (column: SpecificFilterColumn): string => {}interface UsersSearchProps {+ search: string+ setSearch: Dispatch<SetStateAction<string>>improvedSearchEnabled?: booleantelemetryProps: Omit<AuthUsersSearchSubmittedEvent['properties'], 'trigger'>telemetryGroups: AuthUsersSearchSubmittedEvent['groups']onSelectFilterColumn: (value: SpecificFilterColumn) => void}-export const UsersSearch = ({- improvedSearchEnabled = false,- telemetryProps,- telemetryGroups,- onSelectFilterColumn,-}: UsersSearchProps) => {+export const UsersSearch = forwardRef<HTMLInputElement, UsersSearchProps>(function UsersSearch(+ {+ search,+ setSearch,+ improvedSearchEnabled = false,+ telemetryProps,+ telemetryGroups,+ onSelectFilterColumn,+ },+ ref+) {const [, setSelectedId] = useQueryState('show',parseAsString.withOptions({ history: 'push', clearOnDefault: true }))- const [filterKeywords, setFilterKeywords] = useQueryState('keywords', { defaultValue: '' })+ const [, setFilterKeywords] = useQueryState('keywords', { defaultValue: '' })const [specificFilterColumn] = useQueryState<SpecificFilterColumn>('filter',parseAsStringEnum<SpecificFilterColumn>([@@ -71,7 +79,6 @@ export const UsersSearch = ({]).withDefault('email'))- const [search, setSearch] = useState(filterKeywords)const { mutate: sendEvent } = useSendEventMutation()const searchInvalid =@@ -155,6 +162,7 @@ export const UsersSearch = ({</Select_Shadcn_><Input+ ref={ref}size="tiny"containerClassName="w-[245px] rounded-l-none -ml-px"className={cn(@@ -168,7 +176,12 @@ export const UsersSearch = ({onKeyDown={(e) => {if (e.code === 'Enter' || e.code === 'NumpadEnter') {if (!searchInvalid) onSubmitSearch()+ return}+ onSearchInputEscape(search, () => {+ setSearch('')+ setFilterKeywords('')+ })(e)}}actions={search ? (@@ -187,4 +200,4 @@ export const UsersSearch = ({/></div>)-}+})diff --git a/apps/studio/components/interfaces/Auth/Users/UsersV2.tsx b/apps/studio/components/interfaces/Auth/Users/UsersV2.tsxindex 66513b1fa94..dc6a376784d 100644--- a/apps/studio/components/interfaces/Auth/Users/UsersV2.tsx+++ b/apps/studio/components/interfaces/Auth/Users/UsersV2.tsx@@ -43,6 +43,7 @@ import { GenericSkeletonLoader } from 'ui-patterns/ShimmeringLoader'import { AddUserDropdown } from './AddUserDropdown'import { DeleteUserModal } from './DeleteUserModal'import { SortDropdown } from './SortDropdown'+import { useAuthUsersShortcuts } from './useAuthUsersShortcuts'import { UserPanel } from './UserPanel'import type { SpecificFilterColumn } from './Users.constants'import {@@ -101,6 +102,7 @@ export const UsersV2 = () => {const roleImpersonationState = useRoleImpersonationStateSnapshot()const gridRef = useRef<DataGridHandle>(null)+ const searchInputRef = useRef<HTMLInputElement>(null)const xScroll = useRef<number>(0)const { mutate: sendEvent } = useSendEventMutation()@@ -192,10 +194,10 @@ export const UsersV2 = () => {const [columns, setColumns] = useState<Column<any>[]>([])const [selectedUsers, setSelectedUsers] = useState<Set<any>>(new Set([]))const [selectedUserToDelete, setSelectedUserToDelete] = useState<User>()- const [showDeleteModal, setShowDeleteModal] = useState(false)const [isDeletingUsers, setIsDeletingUsers] = useState(false)const [showFreeformWarning, setShowFreeformWarning] = useState(false)const [showCreateIndexesModal, setShowCreateIndexesModal] = useState(false)+ const [search, setSearch] = useState(filterKeywords)const { data: totalUsersCountData, isSuccess: isCountLoaded } = useUsersCountQuery({@@ -453,6 +455,28 @@ export const UsersV2 = () => {}}+ const handleRefresh = () => {+ refetch()+ sendEvent({+ action: 'auth_users_search_submitted',+ properties: {+ trigger: 'refresh_button',+ ...telemetryProps,+ },+ groups: telemetryGroups,+ })+ }++ const { onCellKeyDown, showDeleteModal, setShowDeleteModal } = useAuthUsersShortcuts({+ gridRef,+ searchInputRef,+ users,+ selectedUsers,+ setSelectedUsers,+ setSearch,+ onRefresh: handleRefresh,+ })+useEffect(() => {if (!isRefetching &&@@ -578,6 +602,9 @@ export const UsersV2 = () => {<><div className="flex flex-wrap items-center gap-2"><UsersSearch+ ref={searchInputRef}+ search={search}+ setSearch={setSearch}improvedSearchEnabled={improvedSearchEnabled}telemetryProps={telemetryProps}telemetryGroups={telemetryGroups}@@ -748,17 +775,7 @@ export const UsersV2 = () => {type="default"className="w-7"loading={isRefetching && !isFetchingNextPage}- onClick={() => {- refetch()- sendEvent({- action: 'auth_users_search_submitted',- properties: {- trigger: 'refresh_button',- ...telemetryProps,- },- groups: telemetryGroups,- })- }}+ onClick={handleRefresh}tooltip={{ content: { side: 'bottom', text: 'Refresh' } }}/><AddUserDropdown />@@ -797,6 +814,7 @@ export const UsersV2 = () => {toast(`Only up to ${MAX_BULK_DELETE} users can be selected at a time`)} else setSelectedUsers(rows)}}+ onCellKeyDown={onCellKeyDown}onColumnResize={(idx, width) => saveColumnConfiguration('resize', { idx, width })}onColumnsReorder={(source, target) => {const sourceIdx = columns.findIndex((col) => col.key === source)diff --git a/apps/studio/components/interfaces/Auth/Users/useAuthUsersShortcuts.ts b/apps/studio/components/interfaces/Auth/Users/useAuthUsersShortcuts.tsnew file mode 100644index 00000000000..e6fb6c98f67--- /dev/null+++ b/apps/studio/components/interfaces/Auth/Users/useAuthUsersShortcuts.ts@@ -0,0 +1,187 @@+import { PermissionAction } from '@supabase/shared-types/out/constants'+import {+ parseAsArrayOf,+ parseAsBoolean,+ parseAsString,+ parseAsStringEnum,+ useQueryState,+} from 'nuqs'+import { Dispatch, RefObject, SetStateAction, useEffect, useState } from 'react'+import type { CellKeyboardEvent, DataGridHandle } from 'react-data-grid'++import { MAX_BULK_DELETE } from './Users.constants'+import type { User } from '@/data/auth/users-infinite-query'+import { useAsyncCheckPermissions } from '@/hooks/misc/useCheckPermissions'+import { useIsFeatureEnabled } from '@/hooks/misc/useIsFeatureEnabled'+import { SHORTCUT_IDS } from '@/state/shortcuts/registry'+import { useShortcut } from '@/state/shortcuts/useShortcut'++interface UseAuthUsersShortcutsParams {+ gridRef: RefObject<DataGridHandle>+ searchInputRef: RefObject<HTMLInputElement>+ users: User[]+ selectedUsers: Set<unknown>+ setSelectedUsers: Dispatch<SetStateAction<Set<unknown>>>+ setSearch: Dispatch<SetStateAction<string>>+ onRefresh: () => void+}++interface GridCellKeyDownArgs {+ mode: 'SELECT' | 'EDIT'+ row: unknown+ rowIdx: number+}++interface UseAuthUsersShortcutsResult {+ onCellKeyDown: (args: GridCellKeyDownArgs, event: CellKeyboardEvent) => void+ showDeleteModal: boolean+ setShowDeleteModal: Dispatch<SetStateAction<boolean>>+}++export function useAuthUsersShortcuts({+ gridRef,+ searchInputRef,+ users,+ selectedUsers,+ setSelectedUsers,+ setSearch,+ onRefresh,+}: UseAuthUsersShortcutsParams): UseAuthUsersShortcutsResult {+ const [hasCellSelected, setHasCellSelected] = useState(false)+ const [showDeleteModal, setShowDeleteModal] = useState(false)++ const [selectedId, setSelectedId] = useQueryState(+ 'show',+ parseAsString.withOptions({ history: 'push', clearOnDefault: true })+ )+ const [, setFilterKeywords] = useQueryState('keywords', { defaultValue: '' })+ const [, setFilterUserType] = useQueryState(+ 'userType',+ parseAsStringEnum(['all', 'verified', 'unverified', 'anonymous']).withDefault('all')+ )+ const [, setSelectedProviders] = useQueryState(+ 'providers',+ parseAsArrayOf(parseAsString, ',').withDefault([])+ )+ const [sortByValue, setSortByValue] = useQueryState('sortBy', {+ defaultValue: 'created_at:desc',+ })+ const [, setInviteVisible] = useQueryState(+ 'invite',+ parseAsBoolean.withDefault(false).withOptions({ history: 'push', clearOnDefault: true })+ )+ const [, setCreateVisible] = useQueryState(+ 'new',+ parseAsBoolean.withDefault(false).withOptions({ history: 'push', clearOnDefault: true })+ )++ const { can: canCreateUsers } = useAsyncCheckPermissions(+ PermissionAction.AUTH_EXECUTE,+ 'create_user'+ )+ const { can: canInviteUsers } = useAsyncCheckPermissions(+ PermissionAction.AUTH_EXECUTE,+ 'invite_user'+ )+ const showSendInvitation = useIsFeatureEnabled('authentication:show_send_invitation')++ useEffect(() => {+ const el = gridRef.current?.element+ if (!el) return+ const onFocusIn = () => setHasCellSelected(true)+ const onFocusOut = (event: FocusEvent) => {+ if (!el.contains(event.relatedTarget as Node | null)) {+ setHasCellSelected(false)+ }+ }+ el.addEventListener('focusin', onFocusIn)+ el.addEventListener('focusout', onFocusOut)+ return () => {+ el.removeEventListener('focusin', onFocusIn)+ el.removeEventListener('focusout', onFocusOut)+ }+ }, [gridRef])++ useShortcut(+ SHORTCUT_IDS.LIST_PAGE_FOCUS_SEARCH,+ () => {+ searchInputRef.current?.focus()+ searchInputRef.current?.select()+ },+ { label: 'Search users' }+ )++ useShortcut(SHORTCUT_IDS.LIST_PAGE_RESET_FILTERS, () => {+ setSearch('')+ setFilterKeywords('')+ setFilterUserType('all')+ setSelectedProviders([])+ })++ useShortcut(SHORTCUT_IDS.AUTH_USERS_REFRESH, onRefresh)++ useShortcut(SHORTCUT_IDS.AUTH_USERS_CLEAR_SORT, () => setSortByValue('created_at:desc'), {+ enabled: sortByValue !== 'created_at:desc',+ })++ useShortcut(+ SHORTCUT_IDS.AUTH_USERS_TOGGLE_ALL_SELECTION,+ () => {+ if (selectedUsers.size === users.length) {+ setSelectedUsers(new Set([]))+ } else {+ setSelectedUsers(new Set(users.map((u) => u.id)))+ }+ },+ { enabled: users.length > 0 && users.length <= MAX_BULK_DELETE }+ )++ useShortcut(SHORTCUT_IDS.AUTH_USERS_DELETE_SELECTED, () => setShowDeleteModal(true), {+ enabled: selectedUsers.size > 0,+ })++ useShortcut(+ SHORTCUT_IDS.AUTH_USERS_EXIT_SELECTION,+ () => {+ setSelectedUsers(new Set([]))+ setHasCellSelected(false)+ ;(document.activeElement as HTMLElement | null)?.blur()+ },+ { enabled: !selectedId && (selectedUsers.size > 0 || hasCellSelected) }+ )++ useShortcut(SHORTCUT_IDS.AUTH_USERS_CLOSE_PANEL, () => setSelectedId(null), {+ enabled: !!selectedId,+ })++ const startGridNavigation = () => {+ if (users.length === 0) return+ gridRef.current?.selectCell({ idx: 1, rowIdx: 0 })+ }++ useShortcut(SHORTCUT_IDS.AUTH_USERS_START_NAV_DOWN, startGridNavigation, {+ enabled: !hasCellSelected && users.length > 0,+ })++ useShortcut(SHORTCUT_IDS.AUTH_USERS_START_NAV_UP, startGridNavigation, {+ enabled: !hasCellSelected && users.length > 0,+ })++ useShortcut(SHORTCUT_IDS.AUTH_USERS_CREATE_USER, () => setCreateVisible(true), {+ enabled: canCreateUsers,+ })++ useShortcut(SHORTCUT_IDS.AUTH_USERS_INVITE_USER, () => setInviteVisible(true), {+ enabled: canInviteUsers && showSendInvitation,+ })++ const onCellKeyDown = (args: GridCellKeyDownArgs, event: CellKeyboardEvent) => {+ if (args.mode !== 'SELECT' || event.key !== 'Enter') return+ const id = (args.row as { id?: unknown } | null | undefined)?.id+ if (typeof id !== 'string') return+ setSelectedId(id)+ gridRef.current?.scrollToCell({ idx: 0, rowIdx: args.rowIdx })+ }++ return { onCellKeyDown, showDeleteModal, setShowDeleteModal }+}diff --git a/apps/studio/state/shortcuts/registry.ts b/apps/studio/state/shortcuts/registry.tsindex 8fffb317ebc..fbec3caaf84 100644--- a/apps/studio/state/shortcuts/registry.ts+++ b/apps/studio/state/shortcuts/registry.ts@@ -1,5 +1,6 @@import { SHORTCUT_REFERENCE_GROUPS } from './referenceGroups'import { AUTH_NAV_SHORTCUT_IDS, authNavRegistry } from './registry/auth-nav'+import { AUTH_USERS_SHORTCUT_IDS, authUsersRegistry } from './registry/auth-users'import { DATABASE_NAV_SHORTCUT_IDS, databaseNavRegistry } from './registry/database-nav'import { LIST_PAGE_SHORTCUT_IDS, listPageRegistry } from './registry/list-page'import {@@ -71,6 +72,8 @@ export const SHORTCUT_IDS = {// Database sub-page navigation chords...DATABASE_NAV_SHORTCUT_IDS,+ // Auth users page shortcuts+ ...AUTH_USERS_SHORTCUT_IDS,// Auth sub-page navigation chords...AUTH_NAV_SHORTCUT_IDS,} as const@@ -353,6 +356,8 @@ export const SHORTCUT_DEFINITIONS: Record<ShortcutId, ShortcutDefinition> = {// Database sub-page navigation chord registration...databaseNavRegistry,+ // Auth users page shortcut registration+ ...authUsersRegistry,// Auth sub-page navigation chord registration...authNavRegistry,}diff --git a/apps/studio/state/shortcuts/registry/auth-users.ts b/apps/studio/state/shortcuts/registry/auth-users.tsnew file mode 100644index 00000000000..9bcae02edbd--- /dev/null+++ b/apps/studio/state/shortcuts/registry/auth-users.ts@@ -0,0 +1,90 @@+import { RegistryDefinations } from '../types'++export const AUTH_USERS_SHORTCUT_IDS = {+ AUTH_USERS_REFRESH: 'auth-users.refresh',+ AUTH_USERS_CLEAR_SORT: 'auth-users.clear-sort',+ AUTH_USERS_TOGGLE_ALL_SELECTION: 'auth-users.toggle-all-selection',+ AUTH_USERS_DELETE_SELECTED: 'auth-users.delete-selected',+ AUTH_USERS_EXIT_SELECTION: 'auth-users.exit-selection',+ AUTH_USERS_CLOSE_PANEL: 'auth-users.close-panel',+ AUTH_USERS_START_NAV_DOWN: 'auth-users.start-nav-down',+ AUTH_USERS_START_NAV_UP: 'auth-users.start-nav-up',+ AUTH_USERS_CREATE_USER: 'auth-users.create-user',+ AUTH_USERS_INVITE_USER: 'auth-users.invite-user',+}++export type AuthUsersShortcutId =+ (typeof AUTH_USERS_SHORTCUT_IDS)[keyof typeof AUTH_USERS_SHORTCUT_IDS]++export const authUsersRegistry: RegistryDefinations<AuthUsersShortcutId> = {+ [AUTH_USERS_SHORTCUT_IDS.AUTH_USERS_REFRESH]: {+ id: AUTH_USERS_SHORTCUT_IDS.AUTH_USERS_REFRESH,+ label: 'Refresh users',+ sequence: ['Shift+R'],+ showInSettings: false,+ options: { ignoreInputs: true, registerInCommandMenu: true },+ },+ [AUTH_USERS_SHORTCUT_IDS.AUTH_USERS_CLEAR_SORT]: {+ id: AUTH_USERS_SHORTCUT_IDS.AUTH_USERS_CLEAR_SORT,+ label: 'Clear sort',+ sequence: ['S', 'C'],+ showInSettings: false,+ options: { ignoreInputs: true, registerInCommandMenu: true },+ },+ [AUTH_USERS_SHORTCUT_IDS.AUTH_USERS_TOGGLE_ALL_SELECTION]: {+ id: AUTH_USERS_SHORTCUT_IDS.AUTH_USERS_TOGGLE_ALL_SELECTION,+ label: 'Toggle selection on all displayed users',+ sequence: ['Mod+A'],+ showInSettings: false,+ options: { ignoreInputs: true },+ },+ [AUTH_USERS_SHORTCUT_IDS.AUTH_USERS_DELETE_SELECTED]: {+ id: AUTH_USERS_SHORTCUT_IDS.AUTH_USERS_DELETE_SELECTED,+ label: 'Delete selected users',+ sequence: ['Mod+Backspace'],+ showInSettings: false,+ options: { ignoreInputs: true },+ },+ [AUTH_USERS_SHORTCUT_IDS.AUTH_USERS_EXIT_SELECTION]: {+ id: AUTH_USERS_SHORTCUT_IDS.AUTH_USERS_EXIT_SELECTION,+ label: 'Clear user selection',+ sequence: ['Escape'],+ showInSettings: false,+ options: { ignoreInputs: true },+ },+ [AUTH_USERS_SHORTCUT_IDS.AUTH_USERS_CLOSE_PANEL]: {+ id: AUTH_USERS_SHORTCUT_IDS.AUTH_USERS_CLOSE_PANEL,+ label: 'Close user details panel',+ sequence: ['Escape'],+ showInSettings: false,+ options: { ignoreInputs: true },+ },+ [AUTH_USERS_SHORTCUT_IDS.AUTH_USERS_START_NAV_DOWN]: {+ id: AUTH_USERS_SHORTCUT_IDS.AUTH_USERS_START_NAV_DOWN,+ label: 'Move focus into users grid',+ sequence: ['ArrowDown'],+ showInSettings: false,+ options: { ignoreInputs: true },+ },+ [AUTH_USERS_SHORTCUT_IDS.AUTH_USERS_START_NAV_UP]: {+ id: AUTH_USERS_SHORTCUT_IDS.AUTH_USERS_START_NAV_UP,+ label: 'Move focus into users grid',+ sequence: ['ArrowUp'],+ showInSettings: false,+ options: { ignoreInputs: true },+ },+ [AUTH_USERS_SHORTCUT_IDS.AUTH_USERS_CREATE_USER]: {+ id: AUTH_USERS_SHORTCUT_IDS.AUTH_USERS_CREATE_USER,+ label: 'Create new user',+ sequence: ['I', 'U'],+ showInSettings: false,+ options: { ignoreInputs: true, registerInCommandMenu: true },+ },+ [AUTH_USERS_SHORTCUT_IDS.AUTH_USERS_INVITE_USER]: {+ id: AUTH_USERS_SHORTCUT_IDS.AUTH_USERS_INVITE_USER,+ label: 'Send user invitation',+ sequence: ['I', 'I'],+ showInSettings: false,+ options: { ignoreInputs: true, registerInCommandMenu: true },+ },+}