nylas-availability-picker

The nylas-availability-picker element is a form input for selecting availability (open hours).

import { NylasAvailabilityPicker } from '@nylas/react';
import { mockConfig } from './mock-data';

export default function NylasAvailabilityPickerExample() {
return (
<div className="inline-block border border-dashed border-gray-300 min-w-[500px] rounded-md p-4 justify-center">
  <NylasAvailabilityPicker
    config={mockConfig}
    selectedConfiguration={mockConfig}
  />
</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`

Standalone properties

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

`defaultTimezone?`


Name	`defaultTimezone`
Description	The default timezone or preset timezone.
Type	string
Default	`Intl.DateTimeFormat().resolvedOptions().timeZone`

`hideHeader?`


Name	`hideHeader`
Description	Hide the header of the availability picker.
Type	boolean
Default	`false`

`name?`


Name	`name`
Description	The name of the availability picker.
Type	string
Default	`'availability'`

`openHours?`


Name	`openHours`
Description	The open hours to display.
Type	`OpenHours[] \| undefined`

`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 selected availability/open hours change.

CSS parts

Part	Description
`nap`
`nap__add-time-range`	The add time range button.
`nap__availability`	The availability container.
`nap__day`	The day container.
`nap__error-message`
`nap__header`	The header of the availability picker.
`nap__select-timezone`	The timezone selection container.
`nap__select-timezone-button`	The timezone selection button.
`nap__select-timezone-dropdown-content`	The timezone selection dropdown content.
`nap__time-picker-container`	The time picker container.
`nap__time-picker-input`	The time picker input.
`nap__time-picker-times`	The time picker times.
`nap__time-range`	The time range container.
`nap__time-ranges`	The time ranges container.

Code samples

The nylas-availability-picker 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('Availability changed:', { value, name });

  // Parse the availability value
  const availability = JSON.parse(value);
  console.log('New availability:', availability);

  // Update your configuration
  updateAvailability(availability, name);
});

<nylas-availability-picker
  name="availability"
  open-hours="your-open-hours"
  default-timezone="America/New_York"
  theme-config='{
    "--nylas-primary": "#007bff",
    "--nylas-base-100": "#ffffff",
    "--nylas-border-radius": "8px"
  }'>
</nylas-availability-picker>