nylas-calendar-picker
Overview
The nylas-calendar-picker component is a form input for selecting calendars to check availability.
| Version | 1.3.3 |
| Install (React) | npm install @nylas/react |
| Import (React) | import { NylasCalendarPicker } from '@nylas/react'; |
| Import (CDN) | <script type="module">
import { defineCustomElement } from "https://cdn.jsdelivr.net/npm/@nylas/web-elements@latest/dist/cdn/nylas-calendar-picker/nylas-calendar-picker.es.js";
defineCustomElement();
</script> |
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.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 | Attribute | Description | Type | Default |
|---|---|---|---|---|
calendars | The calendars to choose from. | Calendar[] | undefined | undefined | |
currentUser | The logged in user. | undefined | { id: string; email: string; name?: string | undefined; provider?: string | undefined; } | undefined | |
defaultSelectedCalendars | The default selected calendars. | string[] | [] | |
name | The name of the calendar picker. | string | 'calendar' |
Events
| Event | Description | Type |
|---|---|---|
valueChanged | This event is fired when the selected calendars change. | CustomEvent<{ value: string[]; name: string; valueChangedHandler?: ((event: CustomEvent<{ value: string[]; name: string; }>) => void) | undefined; }> |
Shadow Parts
| Part | Description |
|---|---|
"ncp" | The calendar picker container |
"ncp__dropdown" | The dropdown container |
"ncp__dropdown-button" | The dropdown button |
"ncp__dropdown-content" | The dropdown content |
Built with StencilJS