nylas-list-configurations
Overview
The nylas-list-configurations component displays a list of scheduling pages.
| Version | 1.1.4 |
| 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
| Property | Attribute | Description | Type | Default |
|---|---|---|---|---|
configurations | The list of configurations to display. | Configuration[] | [] | |
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 | '' |
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; }> |
editButtonClick | Event emitted when the user clicks the edit event button. | CustomEvent<{ host: HTMLNylasListConfigurationsElement; configuration: Configuration; }> |
initListConfigurations | Event emitted when the component is initialized. | CustomEvent<{ host: HTMLNylasListConfigurationsElement; cursor?: string | undefined; }> |
Methods
getState() => Promise<"loading" | "error" | "loaded">
Returns
Type: Promise<"loading" | "error" | "loaded">
setError(error: string) => Promise<void>
Parameters
| Name | Type | Description |
|---|---|---|
error | 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 |
|---|---|
"nlc__create-new-cta" | The create new configuration CTA. |
Built with StencilJS