nylas-page-name
Overview
The nylas-page-name component is a UI component that allows users to add a custom page name which will appear in the top left corner of the date picker.
| Version | 1.3.3 |
| Install (React) | npm install @nylas/react |
| Import (React) | import { NylasPageName } from '@nylas/react'; |
| Import (CDN) | <script type="module">
import { defineCustomElement } from "https://cdn.jsdelivr.net/npm/@nylas/web-elements@latest/dist/cdn/nylas-page-name/nylas-page-name.es.js";
defineCustomElement();
</script> |
Example
Properties
| Property | Attribute | Description | Type | Default |
|---|---|---|---|---|
selectedLanguage | The 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 | 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 |
|---|---|---|---|---|
isOpen | Is the page name container card expanded | boolean | true | |
name | The name of the component | string | 'page-name' | |
pageName | The default page name | string | undefined | undefined | |
selectedConfiguration | The selected config | Configuration | undefined | undefined | |
showToggle | Show toggle button that allows users to expand or collapse the card | boolean | true |
Events
| Event | Description | Type |
|---|---|---|
valueChanged | This event is fired when the page name value changes | CustomEvent<{ value: string; name: string; valueChanged?: ((event: CustomEvent<{ value: string; name: string; }>) => void) | undefined; }> |
Shadow Parts
| Part | Description |
|---|---|
"nces" | |
"nces__body" | |
"nces__drawer-toggle--container" | |
"nces__header" | |
"npn" | The nylas-page-name container |
"npn__body" | The body of the event communication section |
"npn__drawer-toggle--container" | The card’s drawer toggle container |
"npn__header" | The header of the event communication section |
"npn__input-textfield" | The page name input textfield |
Built with StencilJS