nylas-list-configurations
Overview
The nylas-list-configurations component displays a list of scheduling pages.
| Version | 2.0.4 |
| Install (React) | npm install @nylas/react |
| Import (React) | import { NylasListConfigurations } 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 |
|---|---|---|---|---|
configurations | The list of configurations to display. | (Configuration | GroupConfiguration)[] | [] | |
listConfigurationsNextCursor | The next cursor for list configurations, if any. | null | string | undefined | undefined | |
schedulerPreviewLink | The 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 | '' | |
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 |
Events
| Event | Description | Type |
|---|---|---|
createButtonClick | Event emitted when the user clicks the create event button. | CustomEvent<HTMLNylasListConfigurationsElement> |
deleteButtonClick | Event emitted when the user clicks the delete event button. | CustomEvent<{ host: HTMLNylasListConfigurationsElement; configuration: Configuration | GroupConfiguration; }> |
dismissNotification | Event emitted when the user dismisses the error notification. | CustomEvent<{ id: string; host: HTMLNylasListConfigurationsElement; }> |
editButtonClick | Event emitted when the user clicks the edit event button. | CustomEvent<{ host: HTMLNylasListConfigurationsElement; configuration: Configuration | GroupConfiguration; }> |
initListConfigurations | Event emitted when the component is initialized. | CustomEvent<{ host: HTMLNylasListConfigurationsElement; cursor?: string | undefined; }> |
nylasSchedulerError | This event is fired when there is an error in the component. | CustomEvent<{ notification: Notification; host: HTMLElement; }> |
Methods
getState() => Promise<"loading" | "error" | "loaded">
Returns
Type: Promise<"loading" | "error" | "loaded">
hideDeleteConfirmation() => Promise<void>
Returns
Type: Promise<void>
hideEditButtonLoading() => Promise<void>
Returns
Type: Promise<void>
registerCallback() => Promise<void>
Returns
Type: Promise<void>
setError(error: { message: string; type: NotificationType; category: ErrorCategory; title: string; }) => Promise<void>
Parameters
| Name | Type | Description |
|---|---|---|
error | { message: string; type: NotificationType; category: ErrorCategory; title: string; } |
Returns
Type: Promise<void>
setState(state: 'loading' | 'loaded' | 'error') => Promise<void>
Parameters
| Name | Type | Description |
|---|---|---|
state | "loading" | "error" | "loaded" |
Returns
Type: Promise<void>
Shadow Parts
| Part | Description |
|---|---|
"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