nylas-list-configurations

Overview

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

Version	`2.1.0`
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	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`

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
`themeConfig`		The theme configuration.	undefined \| { '--nylas-primary'?: string \| undefined; '--nylas-info'?: string \| undefined; '--nylas-success'?: string \| undefined; '--nylas-warning'?: string \| undefined; '--nylas-error'?: string \| undefined; '--nylas-error-pressed'?: string \| undefined; '--nylas-base-0'?: string \| undefined; '--nylas-base-25'?: string \| undefined; '--nylas-base-50'?: string \| undefined; '--nylas-base-100'?: string \| undefined; '--nylas-base-200'?: string \| undefined; '--nylas-base-300'?: string \| undefined; '--nylas-base-400'?: string \| undefined; '--nylas-base-500'?: string \| undefined; '--nylas-base-600'?: string \| undefined; '--nylas-base-700'?: string \| undefined; '--nylas-base-800'?: string \| undefined; '--nylas-base-900'?: string \| undefined; '--nylas-base-950'?: string \| undefined; '--nylas-color-blue-50'?: string \| undefined; '--nylas-color-blue-100'?: string \| undefined; '--nylas-color-blue-300'?: string \| undefined; '--nylas-color-blue-500'?: string \| undefined; '--nylas-color-blue-700'?: string \| undefined; '--nylas-color-blue-900'?: string \| undefined; '--nylas-color-red-50'?: string \| undefined; '--nylas-color-red-100'?: string \| undefined; '--nylas-color-red-300'?: string \| undefined; '--nylas-color-red-500'?: string \| undefined; '--nylas-color-red-700'?: string \| undefined; '--nylas-color-red-900'?: string \| undefined; '--nylas-color-green-50'?: string \| undefined; '--nylas-color-green-100'?: string \| undefined; '--nylas-color-green-300'?: string \| undefined; '--nylas-color-green-500'?: string \| undefined; '--nylas-color-green-700'?: string \| undefined; '--nylas-color-green-900'?: string \| undefined; '--nylas-color-yellow-50'?: string \| undefined; '--nylas-color-yellow-100'?: string \| undefined; '--nylas-color-yellow-300'?: string \| undefined; '--nylas-color-yellow-500'?: string \| undefined; '--nylas-color-yellow-700'?: string \| undefined; '--nylas-color-yellow-900'?: string \| undefined; '--nylas-color-purple-50'?: string \| undefined; '--nylas-color-purple-100'?: string \| undefined; '--nylas-color-purple-300'?: string \| undefined; '--nylas-color-purple-500'?: string \| undefined; '--nylas-color-purple-700'?: string \| undefined; '--nylas-color-purple-900'?: string \| undefined; '--nylas-color-sky-50'?: string \| undefined; '--nylas-color-sky-100'?: string \| undefined; '--nylas-color-sky-300'?: string \| undefined; '--nylas-color-sky-500'?: string \| undefined; '--nylas-color-sky-700'?: string \| undefined; '--nylas-color-sky-900'?: string \| undefined; '--nylas-color-black'?: string \| undefined; '--nylas-color-grey-900'?: string \| undefined; '--nylas-color-grey-800'?: string \| undefined; '--nylas-color-grey-700'?: string \| undefined; '--nylas-color-grey-600'?: string \| undefined; '--nylas-color-grey-500'?: string \| undefined; '--nylas-color-grey-400'?: string \| undefined; '--nylas-color-grey-300'?: string \| undefined; '--nylas-color-grey-200'?: string \| undefined; '--nylas-color-grey-100'?: string \| undefined; '--nylas-color-grey-50'?: string \| undefined; '--nylas-color-white'?: string \| undefined; '--nylas-font-family'?: string \| undefined; '--nylas-font-size'?: string \| undefined; '--nylas-border-radius'?: string \| undefined; '--nylas-border-radius-2x'?: string \| undefined; '--nylas-border-radius-3x'?: string \| 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