Scheduler Editor Components

nylas-scheduler-editor

Overview

The nylas-scheduler-editor component is a form that allows users to configure the settings for the Nylas Scheduler.

Version1.3.6
Install (React)npm install @nylas/react
Import (React)import { NylasSchedulerEditor } from '@nylas/react';
Import (CDN)<script type="module"> import { defineCustomElement } from "https://cdn.jsdelivr.net/npm/@nylas/web-elements@latest/dist/cdn/nylas-scheduler-editor/nylas-scheduler-editor.es.js"; defineCustomElement(); </script>

Example


Properties

PropertyAttributeDescriptionTypeDefault
additionalParticipantsThis prop is used to populate the additional participants and their availability in the scheduler editor.AdditionalParticipant[]undefined
conferenceProvidersThis prop will be used to populate the conference provider options in the editor.Record<string, string>undefined
configurationIdThe configuration id to use for the scheduler editor.stringundefined
defaultAuthArgsThe default authentication arguments to use when authenticating a user.AuthArgs[]undefined
defaultLanguageThis prop will allow to set a default language for the Nylas scheduling page.LANGUAGE_CODEundefined
defaultSchedulerConfigStateThe default scheduler config store state.SchedulerConfigStateundefined
enableUserFeedbackIndicates if the user feedback feature is enabled.booleantrue
eventOverridesThis provides a way to override the default event handlers.EventOverrides{}
experimentalFeaturesThis prop is to opt in to experimental features.Record<string, boolean>undefined
hideEditorTabsThis optional prop is used to hide tabs in the editor.Tab[][]
localizationThis prop will allow to override the default localization strings for each language.Localeundefined
modeThis is used to set the mode for the scheduler config."app" | "composable"'app'
nylasApiRequestThe Nylas Api Request instance.NylasApiRequestundefined
nylasBrandingThis prop will allow to show/hide the option to manage nylas branding in the email template.booleantrue
nylasSessionsConfigThe Nylas Sessions configuration.Configundefined
requiresSlugIndicates if a slug is required for the configuration.booleanfalse
schedulerPreviewLinkThe scheduler preview link used when the user clicks the preview button.string''

Events

EventDescriptionType
initThis event is fired when the provider is initialized.CustomEvent<HTMLNylasSchedulerEditorElement>
loggedInThis event is fired when the NylasAuth isAuthenticated state changes to true.CustomEvent<HTMLNylasSchedulerEditorElement>
loggedOutThis event is fired when the NylasAuth isAuthenticated state changes to false.CustomEvent<HTMLNylasSchedulerEditorElement>
schedulerConfigCloseClickedThis event is fired when the close button on scheduler config is clicked.CustomEvent<HTMLNylasSchedulerEditorElement>

Methods

schedulerConnector() => Promise<NylasSchedulerConfigConnector | undefined>

This method is used to get the NylasSchedulerConfigConnector instance.

store() => Promise<NylasSchedulerConfigStoreType | undefined>

This method is used to get the NylasSchedulerConfigStore instance.

Slots

SlotDescription
"custom-page-style-inputs"This slot is used in “app” mode to pass a custom page style form.
"login-required"This slot is used to display a message when the user is not logged in.

Shadow Parts

PartDescription
"nse__close-button"The close button of the scheduler editor.
"nse__content"The content of the scheduler editor.
"nse__header"The header of the scheduler editor.
"nse__language"
"nse__list-configurations"The list of configurations.
"nse__login-required"The login required component.
"nse__login-required-card"The card of the login required component.
"nse__login-required-disclaimer-text"The icon of the login required component.
"nse__login-required-google-button"The Google button of the login required component.
"nse__login-required-microsoft-button"The Microsoft button of the login required component.
"nse__login-required-other-provider-button"The other provider button of the login required component.
"nse__login-required-text"The text of the login required component.
"nse__title"The title of the scheduler editor.

Built with StencilJS