nylas-scheduling-method
Overview
The nylas-scheduling-method component is a UI component that displays the booking calendar picker.
| Version | 1.3.3 |
| Install (React) | npm install @nylas/react |
| Import (React) | import { NylasSchedulingMethod } from '@nylas/react'; |
| Import (CDN) | <script type="module">
import { defineCustomElement } from "https://cdn.jsdelivr.net/npm/@nylas/web-elements@latest/dist/cdn/nylas-scheduling-method/nylas-scheduling-method.es.js";
defineCustomElement();
</script> |
Example
Properties
| Property | Attribute | Description | Type | Default |
|---|---|---|---|---|
readOnly | This prop is used to display the component in a disabled state / read-only mode. | boolean | false | |
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 |
|---|---|---|---|---|
name | The name of the booking type picker. | string | 'availability-method' | |
participantOptions | The participant options passed in the additionalParticipants prop from the nylas-scheduler-editor component. | AdditionalParticipant[] | undefined | undefined | |
selectedConfiguration | The selected config | Configuration | undefined | undefined |
Events
| Event | Description | Type |
|---|---|---|
valueChanged | This event is fired when the selected booking calendar changes. | CustomEvent<{ value: string; name: string; valueChanged?: ((event: CustomEvent<{ value: string; name: string; }>) => void) | undefined; }> |
Shadow Parts
| Part | Description |
|---|---|
"nsm" | The booking calendar picker container |
"nsm__dropdown" | The dropdown container |
"nsm__dropdown-button" | The dropdown button |
"nsm__dropdown-content" | The dropdown content |
"nsm__header" | The header of the booking calendar picker |
"nsm__input-label" | The input label of the booking calendar picker |
Built with StencilJS