nylas-booked-event-card
Overview
The nylas-booked-event-card
component is a UI component that displays the booked event card.
Version | 1.1.0-canary.14 |
Install (React) | npm install @nylas/react |
Import (React) | import { NylasBookedEventCard } from '@nylas/react'; |
Example
Properties
Property | Attribute | Description | Type | Default |
---|---|---|---|---|
bookingInfo | booking-info | The booking info used to book / reschedule the event. | any | undefined |
configSettings | config-settings | The config settings for the scheduler. | any | undefined |
eventInfo (required) | — | The booked event. | { booking_id: string; organizer: { email: string; name: string; is_organizer?: boolean | undefined; }; title: string; description: string; status: string; } | undefined |
rescheduleBookingId | reschedule-booking-id | Booking flow type. | string | undefined | undefined |
selectedTimeslot (required) | — | The selected timeslot. | { start_time: Date; end_time: Date; } | undefined |
selectedTimezone | selected-timezone | The selected timezone. | string | Intl.DateTimeFormat().resolvedOptions().timeZone |
Events
Event | Description | Type |
---|---|---|
cancelBookedEventValidationError | This event is fired when an error occurs while cancelling the booking. | CustomEvent<{ error: { title: string; message: string; }; }> |
cancelBookingButtonClicked | Cancel booking button clicked event. | CustomEvent<{ bookingId: string; }> |
rescheduleBookedEventError | This event is fired when an error occurs while rescheduling the booking. | CustomEvent<NylasSchedulerErrorResponse> |
rescheduleButtonClicked | Reschedule button clicked event. | CustomEvent<{ bookingId: string; errorHandler?: ((error: NylasSchedulerErrorResponse) => void) | undefined; }> |
Shadow Parts
Part | Description |
---|---|
"nbec" | The booked event card host. |
"nbec__button-outline" | The cancel & reschedule button CTA. |
"nbec__cancel-cta" | The cancel button CTA. |
"nbec__card" | The booked event card. |
"nbec__description" | The description of the booked event card. |
"nbec__reschedule-cta" | The reschedule button CTA. |
"nbec__title" | The title of the booked event card. |
Built with StencilJS