My App
RoomKitFrontend

Frontend Overview

Overview of the @roomkit/react package

The @roomkit/react package provides React hooks and components for building room booking UIs.

What's Included

Hooks

HookDescription
useAvailabilityDebounced availability search with compound filters
useBookingFetch a single booking by ID
useBookingsList bookings with filters and cursor pagination
useCreateBookingCreate a booking mutation with idempotency
useModifyBookingModify a booking mutation with optimistic concurrency
useCancelBookingCancel a booking mutation
useRoomDetailFetch room with equipment and accessibility
useLocationTreeFetch hierarchical location tree
useExamSessionsList exam sessions with filters
useRecurrenceFetch a recurrence rule by ID
useBlackoutsList blackout windows with filters
useBulkOperationStatusPoll bulk operation progress

Components

ComponentDescription
AvailabilitySearchSearch form with time range, capacity, equipment, and location filters
BookingFormBooking creation/edit form
BookingStatusBadgeStatus indicator with color coding
BookingTimelineVisual timeline of bookings
BulkImportProgressProgress bar for bulk operations
ConflictBannerConflict notification with alternative suggestions
ExamScheduleViewExam session schedule display
LocationBrowserHierarchical location tree browser
RecurrenceEditorRecurrence rule editor with frequency, days, and calendar weeks
RoomCardRoom summary card with capacity and equipment

Peer Dependencies

{
    "react": "^18.0.0 || ^19.0.0",
    "react-dom": "^18.0.0 || ^19.0.0"
}

On this page