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
| Hook | Description |
|---|---|
useAvailability | Debounced availability search with compound filters |
useBooking | Fetch a single booking by ID |
useBookings | List bookings with filters and cursor pagination |
useCreateBooking | Create a booking mutation with idempotency |
useModifyBooking | Modify a booking mutation with optimistic concurrency |
useCancelBooking | Cancel a booking mutation |
useRoomDetail | Fetch room with equipment and accessibility |
useLocationTree | Fetch hierarchical location tree |
useExamSessions | List exam sessions with filters |
useRecurrence | Fetch a recurrence rule by ID |
useBlackouts | List blackout windows with filters |
useBulkOperationStatus | Poll bulk operation progress |
Components
| Component | Description |
|---|---|
AvailabilitySearch | Search form with time range, capacity, equipment, and location filters |
BookingForm | Booking creation/edit form |
BookingStatusBadge | Status indicator with color coding |
BookingTimeline | Visual timeline of bookings |
BulkImportProgress | Progress bar for bulk operations |
ConflictBanner | Conflict notification with alternative suggestions |
ExamScheduleView | Exam session schedule display |
LocationBrowser | Hierarchical location tree browser |
RecurrenceEditor | Recurrence rule editor with frequency, days, and calendar weeks |
RoomCard | Room summary card with capacity and equipment |
Peer Dependencies
{
"react": "^18.0.0 || ^19.0.0",
"react-dom": "^18.0.0 || ^19.0.0"
}