nylas-organizer-confirmation-card
Overview
The nylas-organizer-confirmation-card component is a UI component that displays the booked event card.
| Version | 1.4.3 |
| Install (React) | npm install @nylas/react |
| Import (React) | import { NylasOrganizerConfirmationCard } from '@nylas/react'; |
| Import (CDN) | You do not need to individually import the component, just import the parent component either nylas-scheduling or nylas-scheduler-editor. |
Properties
| Property | Attribute | Description | Type | Default |
|---|---|---|---|---|
organizerConfirmationBookingId | Booking flow type. | string | undefined | undefined | |
selectedLanguage | The selected language. | string | navigator.language |
Standalone Props
ⓘ NOTE: The following props are automatically configured when used within nylas-scheduling. Set these props manually only if you’re using the component independently.
| Property | Attribute | Description | Type | Default |
|---|---|---|---|---|
configSettings | The config settings for the scheduler. | undefined | { configuration_id: string; booking?: { additional_fields: Record<string, string>; additional_guests: { email: string; name: string; }[]; booking_ref: string; booking_ref_salt: string; guest: { email: string; name: string; }; timezone: string; email_language: string; event_data: { location: string; when: { start_time: Date; end_time: Date; end_timezone: string; start_timezone: string; object: string; }; }; event_organizer: { name: string; email: string; is_organizer: boolean; }; } | undefined; scheduler: { available_days_in_future: number; min_cancellation_notice: number; min_booking_notice: number; rescheduling_url?: string | undefined; cancellation_url?: string | undefined; cancellation_policy?: string | undefined; hide_additional_guests?: boolean | undefined; hide_cancellation_options?: boolean | undefined; hide_rescheduling_options?: boolean | undefined; additional_fields?: Record<string, AdditionalFields> | undefined; confirmation_redirect_url?: string | undefined; organizer_confirmation_url?: string | undefined; }; organizer: { name: string; email: string; }; slug: string; appearance: Appearance; booking_type: string; name: string; } | undefined | |
isLoading | The loading state prop. Used to display loading state when fetching availability. | boolean | undefined | undefined | |
themeConfig | The theme configuration. | any | undefined |
Events
| Event | Description | Type |
|---|---|---|
confirmBookingButtonClicked | Reschedule button clicked event. | CustomEvent<{ bookingId: string; host: HTMLNylasOrganizerConfirmationCardElement; errorHandler?: ((error: NylasSchedulerErrorResponse) => void) | undefined; }> |
confirmBookingError | This event is fired when an error occurs while rescheduling the booking. | CustomEvent<NylasSchedulerErrorResponse> |
rejectBookingButtonClicked | Reject booking button clicked event. | CustomEvent<{ bookingId: string; host: HTMLNylasOrganizerConfirmationCardElement; }> |
Methods
resetAction() => Promise<void>
Returns
Type: Promise<void>
Shadow Parts
| Part | Description |
|---|---|
"nmcc" | The booked event card host. |
"nmcc__button-outline" | The cancel & reschedule button CTA. |
"nmcc__cancel-cta" | The cancel button CTA. |
"nmcc__card" | The booked event card. |
"nmcc__description" | The description of the booked event card. |
"nmcc__reschedule-cta" | The reschedule button CTA. |
"nmcc__title" | The title of the booked event card. |
"nmccc__card" |
Built with StencilJS