nylas-cancelled-event-card
Overview
The nylas-cancelled-event-card component is a UI component that displays the cancelled event card.
| Version | 1.3.3 |
| Install (React) | npm install @nylas/react |
| Import (React) | import { NylasCancelledEventCard } from '@nylas/react'; |
| Import (CDN) | <script type="module">
import { defineCustomElement } from "https://cdn.jsdelivr.net/npm/@nylas/web-elements@latest/dist/cdn/nylas-cancelled-event-card/nylas-cancelled-event-card.es.js";
defineCustomElement();
</script> |
Example
Properties
| Property | Attribute | Description | Type | Default |
|---|---|---|---|---|
cancelledEventInfo _(required)_ | The participant’s name who booked the event / is logged in. | { booking_id?: string | undefined; organizer?: { email: string; name: string; is_organizer?: boolean | undefined; } | undefined; title?: string | undefined; description?: string | undefined; status?: string | undefined; } | undefined |
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 | |
themeConfig | The theme configuration. | any | undefined |
Events
| Event | Description | Type |
|---|---|---|
cancelledEventCardError | This event is fired when an error occurs. | CustomEvent<NylasSchedulerErrorResponse> |
closeCancelEventCardClicked | This event is fired when the close button is clicked on the cancelled event card. | CustomEvent<{ errorHandler?: ((error: NylasSchedulerErrorResponse) => void) | undefined; }> |
Shadow Parts
| Part | Description |
|---|---|
"ncec" | The cancelled event card host. |
"ncec__button-outline" | The close button CTA. |
"ncec__card" | The cancelled event card. |
"ncec__description" | The description of the cancelled event card. |
"ncec__icon" | The calendar icon. |
"ncec__title" | The title of the cancelled event card. |
Built with StencilJS