@nylas/components-conversation
Advanced tools
Nylas Conversation (`<nylas-conversation>`) is part of the Nylas Components library that lets you build event/calendar applications in minutes. Use Nylas Conversation with your Nylas account or by passing in your own JSON data.
Nylas Conversation (<nylas-conversation>) is part of the Nylas Components library that lets you build event/calendar applications in minutes. Use Nylas Conversation with your Nylas account or by passing in your own JSON data.
Nylas Conversation is currently in active development. Want to contribute? Find out how!
In your JavaScript application, you can install Nylas Conversation with:
npm i @nylas/components-conversationyarn add @nylas/components-conversationAlternatively, on an html page, you can load the Conversation using a script tag:
<head>
<!-- Import the script from CDN -->
<script src="https://unpkg.com/@nylas/components-conversation"></script>
</head>
For both installation options, in the body of your page, you can instantiate the conversation component with <nylas-conversation></nylas-conversation>.
All Nylas components have two ways of displaying data to your end-user:
If you haven't registered for a Nylas account yet, you can do so at dashboard.nylas.com. Once there, head to the Components tab and create a new Conversation component.
You'll be guided through the component setup and be given the option to tie your component to a thread. Review the Conversation Documentation.
During the setup process, you'll be prompted to provide a list of allowed domains. Be sure to add any domains you'll be testing your app on, including localhost, and any staging and production URLs you might use.
Nylas Conversation can be used as a UI on top of any thread data that you provide. Threads should follow the Nylas thread object standard.
The property to use for this is messages. You can pass in a list of JSON message objects.
const staticMessages =
[
{
"account_id": "ehiyqnpjag93ylo6etchcdhr9",
"bcc": [],
"cc": [],
"date": 1629163362,
"files": [],
"from": [{ "email": "demo@nylas.com", "name": "Demo User" }],
"id": "bp1y6jnepx3t9uyr548b4nsdp",
"labels": [
{
"display_name": "Sent Mail",
"id": "6n0whoxa8tdpvreq01mrgvr3d",
"name": "sent"
}
],
"object": "message",
"reply_to": [],
"snippet": "Hey there, Welcome to Nylas! Glad to have you onboard",
"starred": false,
"subject": "Welcome to Nylas",
"thread_id": "dclpsfd1i46mukv77b8y0qe4s",
"to": [
{
"email": "jack.smith@gmail.com",
"name": "Jack Smith"
}
],
"unread": false
},
{
"account_id": "ehiyqnpjag93ylo6etchcdhr9",
"bcc": [],
"cc": [],
"date": 1629163387,
"files": [],
"from": [
{
"email": "jack.smith@gmail.com",
"name": "Jack Smith"
}
],
"id": "60mqc30m5cfffi7mii61oajxt",
"labels": [
{
"display_name": "Inbox",
"id": "5izbd0saul1qtmdp1jakkkdhx",
"name": "inbox"
},
{
"display_name": "Important",
"id": "2wx96u918ncyeuv9yzjroo43g",
"name": "important"
}
],
"object": "message",
"reply_to": [],
"snippet": "Thank you! Excited to be here.",
"starred": false,
"subject": "Re: Welcome to Nylas",
"thread_id": "dclpsfd1i46mukv77b8y0qe4s",
"to": [{ "email": "demo@nylas.com", "name": "Demo User" }],
"unread": false
}
]
Then pass the array into your component using any JavaScript.
<nylas-conversation thread_id={thread_id}>
<nylas-conversation messages={messages}>
You can also use plain JavaScript as an attribute.
document.querySelector("nylas-conversation").thread_id = staticThreadID;
document.querySelector("nylas-conversation").messages = staticMessages;
Nylas Conversation allows for several properties that affect the layout and functionality of your component. You can find a complete list of properties within our Documentation for Nylas Conversation
You can listen to certain user events from your application by adding an event listener to your component.
For example, you can listen for a threadClicked event with the following code:
document
.querySelector("nylas-conversation")
.addEventListener("sendMessageClicked", (event) => {
let { detail } = event;
console.log("Send message clicked: ", detail.thread);
});
A list of emitted events is available on our Documentation for Nylas Conversation
Please refer to our Contributing Guidelines for information about how to get involved. We welcome bug reports, questions, and pull requests.
git@github.com:nylas/components.gityarn installyarn start; your browser will load http://localhost:8000 and show you a list of available running componentsyarn cy:open will launch our end-to-end tests in a browser
tests will automatically be run on push from push.yaml
FAQs
Nylas Conversation (`<nylas-conversation>`) is part of the Nylas Components library that lets you build event/calendar applications in minutes. Use Nylas Conversation with your Nylas account or by passing in your own JSON data.
We found that @nylas/components-conversation demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 9 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
/Security News
Compromised intercom-client@7.0.4 npm package is tied to the ongoing Mini Shai-Hulud worm attack targeting developer and CI/CD secrets.
Research
Socket detected a malicious supply chain attack on PyPI package lightning versions 2.6.2 and 2.6.3, which execute credential-stealing malware on import.
Research
A brand-squatted TanStack npm package used postinstall scripts to steal .env files and exfiltrate developer secrets to an attacker-controlled endpoint.