nylas-list-configurations

Overview

The nylas-list-configurations component displays a list of scheduling pages.

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

Example


Properties

PropertyAttributeDescriptionTypeDefault
configurationsThe list of configurations to display.Configuration[][]
listConfigurationsNextCursorThe next cursor for list configurations, if any.null | string | undefinedundefined
schedulerPreviewLinkThe scheduler preview link to use when the user clicks on the preview button. You can use a placeholder {config.id} to replace the configuration id anywhere in the link.string''
selectedLanguageThe 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 | undefinedundefined

Events

EventDescriptionType
createButtonClickEvent emitted when the user clicks the create event button.CustomEvent<HTMLNylasListConfigurationsElement>
deleteButtonClickEvent emitted when the user clicks the delete event button.CustomEvent<{ host: HTMLNylasListConfigurationsElement; configuration: Configuration; }>
editButtonClickEvent emitted when the user clicks the edit event button.CustomEvent<{ host: HTMLNylasListConfigurationsElement; configuration: Configuration; }>
initListConfigurationsEvent emitted when the component is initialized.CustomEvent<{ host: HTMLNylasListConfigurationsElement; cursor?: string | undefined; }>

Methods

getState() => Promise<"loading" | "error" | "loaded">

Returns

Type: Promise<"loading" | "error" | "loaded">

hideDeleteConfirmation() => Promise<void>

Returns

Type: Promise<void>

registerCallback() => Promise<void>

Returns

Type: Promise<void>

setError(error: string) => Promise<void>

Parameters

NameTypeDescription
errorstring

Returns

Type: Promise<void>

setState(state: 'loading' | 'loaded' | 'error') => Promise<void>

Parameters

NameTypeDescription
state"loading" | "error" | "loaded"

Returns

Type: Promise<void>

Shadow Parts

PartDescription
"nfbf__button-outline"
"nfbf__cancel-cta"
"nfbf__close-button"
"nfbf__reschedule-cta"
"nfbf__title"
"nlc__create-new-cta"The create new configuration CTA.

Built with StencilJS