nylas-customize-booking-settings
Overview
The nylas-customize-booking-settings component is a UI component that displays the booking calendar picker.
| Version | 1.3.3 |
| Install (React) | npm install @nylas/react |
| Import (React) | import { NylasCustomizeBookingSettings } from '@nylas/react'; |
| Import (CDN) | <script type="module">
import { defineCustomElement } from "https://cdn.jsdelivr.net/npm/@nylas/web-elements@latest/dist/cdn/nylas-customize-booking-settings/nylas-customize-booking-settings.es.js";
defineCustomElement();
</script> |
Example
Properties
| Property | Attribute | Description | Type | Default |
|---|---|---|---|---|
selectedLanguage | The selected language. | LANGUAGE_CODE.de | LANGUAGE_CODE.en | LANGUAGE_CODE.es | LANGUAGE_CODE.fr | LANGUAGE_CODE.ja | LANGUAGE_CODE.nl | LANGUAGE_CODE.sv | LANGUAGE_CODE.zh | undefined | undefined |
Standalone Props
ⓘ NOTE: The following props are automatically configured when used within nylas-scheduler-editor. Set these props manually only if you’re using the component independently.
| Property | Attribute | Description | Type | Default |
|---|---|---|---|---|
defaultHideAdditionalGuests | The default additional guests hidden setting as set in the configuration. | boolean | this.selectedConfiguration?.scheduler?.hide_additional_guests ?? false | |
defaultHideCancellationOptions | The default hide cancellation options setting as set in the configuration. | boolean | this.selectedConfiguration?.scheduler?.hide_cancellation_options ?? false | |
defaultHideReschedulingOptions | The default hide rescheduling options setting as set in the configuration. | boolean | this.selectedConfiguration?.scheduler?.hide_rescheduling_options ?? false | |
name | The name of the calendar picker. | string | 'customize-booking-settings' | |
selectedConfiguration | The selected config | Configuration | undefined | undefined |
Events
| Event | Description | Type |
|---|---|---|
valueChanged | This event is fired when the selected booking calendar changes. | CustomEvent<{ value: string; name: string; valueChanged?: ((event: CustomEvent<{ value: string; name: string; }>) => void) | undefined; }> |
Shadow Parts
| Part | Description |
|---|---|
"," | |
"ncbs" | The booking calendar picker container |
"ncbs__additional_guests" | The additional guests setting |
"ncbs__cancellation_options" | The cancellation options setting |
"ncbs__header" | The header of the booking calendar picker |
"ncbs__rescheduling_options" | The rescheduling options setting |
"ncbs__settings" | The settings container |
"ncbs__settings-div" | The div inside the settings container that contains the checkbox and tooltip for each setting |
Built with StencilJS