@nylas/components-agenda
Advanced tools
Nylas Agenda (`<nylas-agenda>`) is part of the Nylas Components library that lets you build user-facing calendar applications in minutes. Use Nylas Agenda with your Nylas account or by passing in your own JSON data.
Nylas Agenda (<nylas-agenda>) is part of the Nylas Components library that lets you build user-facing calendar applications in minutes. Use Nylas Agenda with your Nylas account or by passing in your own JSON data.
In your JavaScript application, you can install Nylas Agenda with:
npm i @nylas/components-agendayarn add npm i @nylas/components-agendaAlternatively, on an html page, you can load the Agenda using a script tag:
<head>
<!-- Import the script from CDN -->
<script src="https://unpkg.com/@nylas/components-agenda"></script>
</head>
For both installation options, in the body of your page, you can instantiate the agenda with <nylas-agenda></nylas-agenda>.
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 Agenda component.
You'll be guided through the component setup and be given the option to tie your component to your calendar account. Review the Agenda 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 Agenda can be used as a UI on top of any event data that you provide. Events should follow the Nylas events object standard.
:bell:
Events
whenSubobjectMake sure to review the events
whensubobject since that determines where your Agenda events will appear.
The property to use for this is events. You can pass in a JSON array of events.
const staticEvents = [
{
"title": "Some event that I am manipulating outside of the context of Nylas",
"description": "Passed in from HTML!",
"participants": [],
"when": { "end_time": 1600444800, "object": "timespan", "start_time": 1600438500 }
},
{
"title": "Some I got from elsewhere",
"description": "Passed in from HTML!",
"participants": [],
"when": { "end_time": 1600449999, "object": "timespan", "start_time": 1600448500 }
}
]
Then pass the array into your component using any JavaScript.
<nylas-agenda events={events}>
You can also use plain JavaScript as an attribute.
document.querySelector("nylas-agenda").events = staticEvents;
Nylas Agenda 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 Agenda
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 dateChange event with the following code:
document
.querySelector("nylas-agenda")
.addEventListener("dateChange", (event) => {
let { detail } = event;
console.log("date changed", detail);
});
A list of emitted events is available on our Documentation for Nylas Agenda
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 Agenda (`<nylas-agenda>`) is part of the Nylas Components library that lets you build user-facing calendar applications in minutes. Use Nylas Agenda with your Nylas account or by passing in your own JSON data.
The npm package @nylas/components-agenda receives a total of 131 weekly downloads. As such, @nylas/components-agenda popularity was classified as not popular.
We found that @nylas/components-agenda 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
The Socket Research Team has discovered six new malicious npm packages linked to North Korea’s Lazarus Group, designed to steal credentials and deploy backdoors.
Security News
Socket CEO Feross Aboukhadijeh discusses the open web, open source security, and how Socket tackles software supply chain attacks on The Pair Program podcast.
Security News
Opengrep continues building momentum with the alpha release of its Playground tool, demonstrating the project's rapid evolution just two months after its initial launch.