nylas-connected-calendars

The nylas-connected-calendars element is a form input for selecting calendars to check availability for participants.

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

export default function NylasConnectedCalendarsExample() {
return (
<div className="inline-block border border-dashed border-gray-300 min-w-[700px] rounded-md p-4 justify-center">
  <NylasConnectedCalendars
    participants={[
      {
        email: '[email protected]',
        name: 'John Doe',
        is_organizer: true,
        availability: {
          calendar_ids: ['[email protected]'],
        },
      },
      {
        email: '[email protected]',
        name: 'Jane Doe',
        is_organizer: false,
        availability: {
          calendar_ids: ['[email protected]'],
        },
      },
    ]}
    participantOptions={[
      {
        name: 'Jane Doe',
        email: '[email protected]',
        calendars: [
          {
            id: 'jane',
            name: 'Jane Doe',
            is_primary: true,
          } as any,
        ],
      },
    ]}
    calendars={[
      {
        id: '[email protected]',
        name: 'John Doe',
        is_primary: true,
      } as any,
      {
        id: 'new_calendar',
        name: 'New Calendar',
        is_primary: false,
      } as any,
    ]}
  />
</div>
);
}

Properties

`name?`


Name	`name`
Description	The name of the participants custom availability.
Type	string
Default	`'connected-calendars'`

`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`

Standalone properties

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

`calendars?`


Name	`calendars`
Description	The calendars to choose from for the organizer/logged in user.
Type	`Calendar[] \| undefined`

`participantOptions?`


Name	`participantOptions`
Description	The participant options passed in the `additionalParticipants` prop from the `nylas-scheduler-editor` component.
Type	`AdditionalParticipant[] \| undefined`

`participants?`


Name	`participants`
Description	The participants selected in the add participants section.
Type	`Participant[]`
Default	`this.selectedConfiguration?.participants`

`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 participant’s custom availability changes.

CSS parts

Part	Description
`nccals`	The connected calendars host.
`nccals__container`	The container.
`nccals__content`	The content.
`nccals__header`	The header.
`nccals__title`	The title.
`nccals__toggle-container`	The toggle container.

Code samples

The nylas-connected-calendars 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('Connected calendars changed:', { value, name });

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

<nylas-connected-calendars
  name="connected-calendars"
  calendars="your-calendars"
  participant-options="your-participant-options"
  participants="your-participants"
  theme-config='{
    "--nylas-primary": "#007bff",
    "--nylas-base-100": "#ffffff",
    "--nylas-border-radius": "8px"
  }'>
</nylas-connected-calendars>