nylas-cancel-booking-form
Overview
The nylas-cancel-booking-form component is a UI component that allows users to cancel a booking.
| Version | 1.1.0-canary.14 |
| Install (React) | npm install @nylas/react |
| Import (React) | import { NylasCancelBookingForm } from '@nylas/react'; |
Example
Properties
| Property | Attribute | Description | Type | Default |
|---|---|---|---|---|
cancelBookingId (required) | cancel-booking-id | The booking ID to cancel. | string | undefined |
configSettings | — | The config settings. | undefined | { scheduler: { available_days_in_future: number; min_cancellation_notice: number; min_booking_notice: number; cancellation_policy: string; }; organizer: { name: string; email: string; }; } | undefined |
Events
| Event | Description | Type |
|---|---|---|
cancelBookedEventError | This event is fired when an error occurs while cancelling the booking. | CustomEvent<NylasSchedulerErrorResponse> |
cancelBookingFormError | This event is fired when an error occurs in the booking form. | CustomEvent<{ id?: string | undefined; type?: NotificationType | undefined; title?: string | undefined; code?: number | undefined; category?: string | undefined; description?: string | undefined; ttl?: number | "none" | undefined; }> |
cancelBookingFormSubmitted | This event is fired when the cancel booking form is submitted. | CustomEvent<{ bookingId: string; reason: string; errorHandler?: ((error: NylasSchedulerErrorResponse) => void) | undefined; }> |
goBackButtonClicked | This event is fired when the Go back button is clicked on the cancel booking form. | CustomEvent<void> |
Shadow Parts
| Part | Description |
|---|---|
"ncec" | |
"ncec__button-cta" | |
"ncec__button-outline" | |
"ncec__card" | |
"ncec__description" | |
"ncec__icon" | |
"ncec__reason-textarea" | |
"ncec__title" |
Built with StencilJS