The nylas-min-booking-notice
element is a form input for the minimum period of notice (minutes) that a guest must provide to book an event.
import { NylasMinBookingNotice } from '@nylas/react';import { mockConfig } from './mock-data';
export default function NylasMinBookingNoticeExample() {return (<div className="inline-block border border-dashed border-gray-300 min-w-[400px] rounded-md p-4 justify-center"> <NylasMinBookingNotice config={mockConfig} selectedConfiguration={mockConfig} /></div>);}
Properties
Section titled “Properties”selectedLanguage?
Section titled “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 |
themeConfig?
Section titled “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; } |
Standalone properties
Section titled “Standalone properties”The following props are automatically configured when used within NylasSchedulerEditor
. Set these props manually only if you’re using the component independently.
minBookingNotice?
Section titled “minBookingNotice?”Name | minBookingNotice |
Description | The minimum booking notice (minutes) stored in the Configuration. |
Type | number | undefined |
Name | name |
Description | The name of the min booking notice input. |
Type | string |
Default | 'min-booking-notice' |
selectedConfiguration?
Section titled “selectedConfiguration?”Name | selectedConfiguration |
Description | The selected Configuration. |
Type | Configuration | undefined |
Events
Section titled “Events”Event | Description |
---|---|
valueChanged | Fired when the value of the min booking notice changes. |
CSS parts
Section titled “CSS parts”Part | Description |
---|---|
nmbn | The minimum booking notice container. |
nmbn__number-dropdown | The number dropdown container. |
nmbn__number-dropdown-button | The number dropdown button. |
nmbn__number-dropdown-content | The number dropdown content. |
nmbn__period-dropdown | The period dropdown container. |
nmbn__period-dropdown-button | The period dropdown button. |
nmbn__period-dropdown-content | The period dropdown content. |
Code samples
Section titled “Code samples”The nylas-min-booking-notice
element is automatically included in the main NylasSchedulerEditor
component. The following code samples show how to use the element on its own.
<nylas-min-booking-notice name="min-booking-notice" min-booking-notice="60" selected-configuration="your-config"></nylas-min-booking-notice>
// Listen for value changeselement.addEventListener('valueChanged', (event) => { const { value, name } = event.detail; console.log('Value changed:', { value, name });
// Update your configuration updateMinBookingNotice(value, name);});
<nylas-min-booking-notice name="min-booking-notice" min-booking-notice="60" selected-configuration="your-config" theme-config='{ "--nylas-primary": "#007bff", "--nylas-base-100": "#ffffff", "--nylas-border-radius": "8px" }'></nylas-min-booking-notice>