nylas-availability-picker

Overview

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

Version	`2.2.4`
Install (React)	`npm install @nylas/react`
Import (React)	`import { NylasAvailabilityPicker } from '@nylas/react';`
Import (CDN)	You do not need to individually import the component, just import the parent component either `nylas-scheduling` or `nylas-scheduler-editor`.

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.ko \| 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	Description	Type	Default
`defaultTimezone`	The default timezone or preset timezone.	`string`	`Intl.DateTimeFormat().resolvedOptions().timeZone`
`hideHeader`	Hide the header of the availability picker.	`boolean`	`false`
`name`	The name of the availability picker.	`string`	`'availability'`
`openHours`	The open hours to display.	`OpenHours[] \| undefined`	`undefined`
`selectedConfiguration`	The selected configuration.	`Configuration \| undefined`	`undefined`
`themeConfig`	The theme configuration.	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; }	`undefined`

Events

Event	Description	Type
`valueChanged`	This event is fired when the selected availability / open hours change. The value is a stringified JSON object with the open hours and timezone. `{ openHours: OpenHours[], timezone: string }`	`CustomEvent<{ value: string; name: string; }>`

Shadow 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

Built with StencilJS