Skip to main content

Hooks

CommonPlace uses 44 custom hooks for data fetching, state management, and feature logic. All hooks are in src/hooks/.

Friendship & Social​

HookPurpose
useFriendshipFull friendship lifecycle (send, accept, decline, cancel, remove)
useFriendsFriends list with search, filtering, and selection
useBlockBlock state, blocked users list, interaction permissions
useSharedCirclesCircles shared between two users, block status within circles
useSteppedBackTemporary private breaks from friends
useRelationshipTypesCustom relationship type CRUD
useRelationshipEdgesRelationship edges between users
useRelationshipEncryptionClient-side encryption for relationship data

Circles​

HookPurpose
useCirclesCircle list, single circle CRUD, members, posts
useCircleCharterCircle charter toggle definitions and management
useCircleFeedStatePer-circle feed state, new post counts
useShareToCircleShare-to-circle modal workflow with W.E.L. prompts

Posts & Feed​

HookPurpose
useIntentStylesIntent style customization (global and per-user)
usePostPresetsPost style presets
useBuildOn"Build On" post creation with dialogue chains
useAutoSaveAuto-save drafts with debouncing
useDraftsDraft CRUD with pinning and auto-save

Messaging​

HookPurpose
useConversationConversation management and participants
useMessageReactionsMessage emoji reactions
useSteppedAway"Stepped away" status for conversations

Notifications​

HookPurpose
useNotificationsFull notification management with optimistic UI
useShareNotificationsBatch share notification processing

MeBook​

HookPurpose
useMeBookQuestionMeBook questionnaire interaction

Security & Rate Limiting​

HookPurpose
useRateLimitRate limit checking, recording, and status
useAccountTierAccount tier state and tier-aware rate limiting
useDataRetentionRetention settings, post archiving, GDPR export
useReportReport submission with rate limiting
usePrivacyCurtainPrivacy curtain with idle detection

Admin​

HookPurpose
useAdminAdmin role checking and permissions
useAdminUsersUser search, detail views, moderation actions
useAuditLogAudit log viewing and CSV export
useDashboardMetricsAdmin dashboard metrics

UI & Utility​

HookPurpose
useClickOutsideDetect clicks outside a referenced element
useEscapeKeyListen for Escape key presses
useFocusTrapKeyboard focus trap for accessible modals
useLocalStoragePersistent state in localStorage
useIsMobileMobile/tablet/desktop breakpoint detection
useIdleDetectionUser idle detection with configurable timeout
useDragDrag and resize interactions
useThemeSwitcherTheme cycling (default, neon, forest, circus)

Style​

HookPurpose
useHomeroomStyleFetch, save, and manage Homeroom style tokens
usePostStylePost-specific style tokens for composition and rendering
useModuleStyleModule-specific style tokens with Homeroom inheritance

Other​

HookPurpose
useUserLookupExact username lookup with rate limiting
useInviteLinksInvite link management and lookup

Last updated: 2026-02-08