nylas-customize-booking-settings

The nylas-customize-booking-settings element displays the booking calendar picker.

import { NylasCustomizeBookingSettings } from '@nylas/react';

export default function NylasCustomizeBookingSettingsExample() {
return (
<div className="inline-block border border-dashed border-gray-300 min-w-[700px] rounded-md p-4 justify-center">
  <NylasCustomizeBookingSettings defaultHideAdditionalGuests={false} defaultHideCancellationOptions={true} defaultHideReschedulingOptions={false} />
</div>
);
}

Properties

`selectedLanguage?`


Name	`selectedLanguage`
Description	The selected language.
Type	`LANGUAGE_CODE.de \| LANGUAGE_CODE.en \| LANGUAGE_CODE.es \| LANGUAGE_CODE.fr \| LANGUAGE_CODE.ja \|` `LANGUAGE_CODE.ko \| LANGUAGE_CODE.nl \| LANGUAGE_CODE.sv \| LANGUAGE_CODE.zh \| undefined`

`showSettings?`


Name	`showSettings`
Description	This prop is used to determined which settings are visible in the element.
Type	`string[]`
Default	`['allowGuestsToInvite', 'hideCancellationOptions', 'hideReschedulingOptions']`

Standalone properties

The following props are automatically configured when used within NylasSchedulerEditor. Set these props manually only if you’re using the component independently.

`defaultHideAdditionalGuests?`


Name	`defaultHideAdditionalGuests`
Description	The default additional guests hidden setting as set in the Configuration.
Type	boolean
Default	`this.selectedConfiguration?.scheduler?.hide_additional_guests ?? false`

`defaultHideCancellationOptions?`


Name	`defaultHideCancellationOptions`
Description	The default hide cancellation options setting as set in the Configuration.
Type	boolean
Default	`this.selectedConfiguration?.scheduler?.hide_cancellation_options ?? false`

`defaultHideReschedulingOptions?`


Name	`defaultHideReschedulingOptions`
Description	The default hide rescheduling options setting as set in the Configuration.
Type	boolean
Default	`this.selectedConfiguration?.scheduler?.hide_rescheduling_options ?? false`

`name?`


Name	`name`
Description	The name of the calendar picker.
Type	string
Default	`'customize-booking-settings'`

`selectedConfiguration?`


Name	`selectedConfiguration`
Description	The selected Configuration.
Type	`Configuration \| undefined`

`themeConfig?`


Name	`themeConfig`
Description	The theme configuration.
Type	`undefined \| { '--nylas-primary'?: string \| undefined; '--nylas-info'?: string \| undefined;` `'--nylas-success'?: string \| undefined; '--nylas-warning'?: string \| undefined;` `'--nylas-error'?: string \| undefined; '--nylas-error-pressed'?: string \| undefined;` `'--nylas-base-0'?: string \| undefined; '--nylas-base-25'?: string \| undefined;` `'--nylas-base-50'?: string \| undefined; '--nylas-base-100'?: string \| undefined;` `'--nylas-base-200'?: string \| undefined; '--nylas-base-300'?: string \| undefined;` `'--nylas-base-400'?: string \| undefined; '--nylas-base-500'?: string \| undefined;` `'--nylas-base-600'?: string \| undefined; '--nylas-base-700'?: string \| undefined;` `'--nylas-base-800'?: string \| undefined; '--nylas-base-900'?: string \| undefined;` `'--nylas-base-950'?: string \| undefined; '--nylas-color-blue-50'?: string \| undefined;` `'--nylas-color-blue-100'?: string \| undefined; '--nylas-color-blue-300'?: string \| undefined;` `'--nylas-color-blue-500'?: string \| undefined; '--nylas-color-blue-700'?: string \| undefined;` `'--nylas-color-blue-900'?: string \| undefined; '--nylas-color-red-50'?: string \| undefined;` `'--nylas-color-red-100'?: string \| undefined; '--nylas-color-red-300'?: string \| undefined;` `'--nylas-color-red-500'?: string \| undefined; '--nylas-color-red-700'?: string \| undefined;` `'--nylas-color-red-900'?: string \| undefined; '--nylas-color-green-50'?: string \| undefined;` `'--nylas-color-green-100'?: string \| undefined; '--nylas-color-green-300'?: string \|` `undefined;'--nylas-color-green-500'?: string \| undefined; '--nylas-color-green-700'?: string \|` `undefined; '--nylas-color-green-900'?: string \| undefined; '--nylas-color-yellow-50'?: string` `\| undefined; '--nylas-color-yellow-100'?: string \| undefined; '--nylas-color-yellow-300'?:` `string \| undefined; '--nylas-color-yellow-500'?: string \| undefined;` `'--nylas-color-yellow-700'?: string \| undefined; '--nylas-color-yellow-900'?: string` `\| undefined; '--nylas-color-purple-50'?: string \| undefined; '--nylas-color-purple-100'?:` `string \| undefined; '--nylas-color-purple-300'?: string \| undefined;` `'--nylas-color-purple-500'?: string \| undefined; '--nylas-color-purple-700'?: string \|` `undefined; '--nylas-color-purple-900'?: string \| undefined; '--nylas-color-sky-50'?: string \|` `undefined; '--nylas-color-sky-100'?: string \| undefined; '--nylas-color-sky-300'?: string \|` `undefined; '--nylas-color-sky-500'?: string \| undefined; '--nylas-color-sky-700'?: string \|` `undefined; '--nylas-color-sky-900'?: string \| undefined; '--nylas-color-black'?: string \|` `undefined; '--nylas-color-grey-900'?: string \| undefined; '--nylas-color-grey-800'?: string \|` `undefined; '--nylas-color-grey-700'?: string \| undefined; '--nylas-color-grey-600'?: string \|` `undefined; '--nylas-color-grey-500'?: string \| undefined; '--nylas-color-grey-400'?: string \|` `undefined; '--nylas-color-grey-300'?: string \| undefined; '--nylas-color-grey-200'?: string \|` `undefined; '--nylas-color-grey-100'?: string \| undefined; '--nylas-color-grey-50'?: string \|` `undefined; '--nylas-color-white'?: string \| undefined; '--nylas-font-family'?: string \|` `undefined; '--nylas-font-size'?: string \| undefined; '--nylas-border-radius'?: string \|` `undefined; '--nylas-border-radius-2x'?: string \| undefined; '--nylas-border-radius-3x'?:` `string \| undefined; }`

Events

Event	Description
`valueChanged`	Fired when the booking settings are changed.

CSS 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.

Code samples

The nylas-customize-booking-settings element is automatically included in the main NylasSchedulerEditor component. The following code samples show how to use the element on its own.

// Listen for value changes
element.addEventListener('valueChanged', (event) => {
  const { value, name } = event.detail;
  console.log('Booking settings changed:', { value, name });

  // Update your configuration
  updateBookingSettings(value, name);
});

<nylas-customize-booking-settings
  name="customize-booking-settings"
  show-settings='["allowGuestsToInvite", "hideCancellationOptions", "hideReschedulingOptions"]'
  theme-config='{
    "--nylas-primary": "#007bff",
    "--nylas-base-100": "#ffffff",
    "--nylas-border-radius": "8px"
  }'>
</nylas-customize-booking-settings>