v-calendar-scheduler

Version:

Calendar scheduler component for VueJs

v-calendar.davidpaternina.com

87 lines (83 loc) • 19.1 kB

HTML

<!DOCTYPE html> <html lang="en-US"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width,initial-scale=1"> <title>Vue Calendar | Callbacks</title> <meta name="description" content="Calendar scheduler component for VueJs"> <meta property="og:url" content="https://v-calendar.davidpaternina.com/"> <meta property="og:title" content="Vue Calendar Scheduler"> <meta property="og:description" content="Calendar scheduler component for VueJs"> <meta property="og:image" content="https://v-calendar.davidpaternina.com/assets/img/fb-jumbo.png"> <link rel="preload" href="/assets/css/0.styles.df06e255.css" as="style"><link rel="preload" href="/assets/js/app.233d7366.js" as="script"><link rel="preload" href="/assets/js/7.529a46be.js" as="script"><link rel="prefetch" href="/assets/js/4.1e6fe3d0.js"><link rel="prefetch" href="/assets/js/1.561fc534.js"><link rel="prefetch" href="/assets/js/2.24fa77b3.js"><link rel="prefetch" href="/assets/js/3.d6d810f1.js"><link rel="prefetch" href="/assets/js/5.3ae44317.js"><link rel="prefetch" href="/assets/js/6.c3810d63.js"><link rel="prefetch" href="/assets/js/8.1d03fc94.js"><link rel="prefetch" href="/assets/js/9.b1f1ce6a.js"> <link rel="stylesheet" href="/assets/css/0.styles.df06e255.css"> </head> <body> <div id="app" data-server-rendered="true"><div class="theme-container"><header class="navbar"><div class="sidebar-button"><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" role="img" viewBox="0 0 448 512" class="icon"><path fill="currentColor" d="M436 124H12c-6.627 0-12-5.373-12-12V80c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12z"></path></svg></div><a href="/" class="home-link router-link-active"> Vue Calendar </a><div class="links"><div class="search-box"><input aria-label="Search" autocomplete="off" spellcheck="false" value=""></div><nav class="nav-links can-hide"><div class="nav-item"><a href="/" class="nav-link">Home</a></div><div class="nav-item"><a href="/guide/" class="nav-link router-link-active">Documentation</a></div><div class="nav-item"><a href="https://github.com/dapd007/v-calendar-scheduler/blob/master/CHANGELOG.md" target="_blank" rel="noopener noreferrer" class="nav-link">Changelog</a></div><a href="https://github.com/dapd007/v-calendar-scheduler" target="_blank" rel="noopener noreferrer" class="repo-link"> GitHub <svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></nav></div></header><div class="sidebar-mask"></div><div class="sidebar"><nav class="nav-links"><div class="nav-item"><a href="/" class="nav-link">Home</a></div><div class="nav-item"><a href="/guide/" class="nav-link router-link-active">Documentation</a></div><div class="nav-item"><a href="https://github.com/dapd007/v-calendar-scheduler/blob/master/CHANGELOG.md" target="_blank" rel="noopener noreferrer" class="nav-link">Changelog</a></div><a href="https://github.com/dapd007/v-calendar-scheduler" target="_blank" rel="noopener noreferrer" class="repo-link"> GitHub <svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></nav><ul class="sidebar-links"><li><div class="sidebar-group first">Guide<ul class="sidebar-group-items"><li><a href="/guide/" class="sidebar-link">Introduction</a></li><li><a href="/guide/overview.html" class="sidebar-link">Overview</a></li><li><a href="/guide/getting-started.html" class="sidebar-link">Getting started</a></li><li><a href="/guide/config.html" class="sidebar-link">Config</a></li><li><a href="/guide/events.html" class="sidebar-link">Event model</a></li><li><a href="/guide/callbacks.html" class="active sidebar-link">Callbacks</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/guide/callbacks.html#view-callbacks" class="sidebar-link">View callbacks</a></li><li class="sidebar-sub-header"><a href="/guide/callbacks.html#day-time-callbacks" class="sidebar-link">Day/Time callbacks</a></li><li class="sidebar-sub-header"><a href="/guide/callbacks.html#event-callbacks" class="sidebar-link">Event callbacks</a></li></ul></li><li><a href="/guide/customization.html" class="sidebar-link">Customization</a></li><li><a href="/guide/demos.html" class="sidebar-link">Demos</a></li></ul></div></li></ul></div><div class="page"><div class="content"><h1 id="callbacks"><a href="#callbacks" aria-hidden="true" class="header-anchor">#</a> Callbacks</h1>Each calendar instance has a few callbacks you can hook onto:<pre class="language-vue"><code><template> <vue-scheduler @month-changed="monthChanged" @week-changed="weekChanged" @day-changed="dayChanged" @view-changed="viewChanged" @day-clicked="dayClicked" @time-clicked="timeClicked" @event-clicked="eventClicked" @event-created="eventCreated" > </vue-scheduler> </template> <script> export default { methods: { monthChanged(newDate) { console.log('Month Changed'); console.log(newDate); }, weekChanged(newDate) { console.log('Week Changed'); console.log(newDate); }, dayChanged(newDate) { console.log('Day Changed'); console.log(newDate); }, viewChanged(newView) { console.log('View Changed'); console.log(newView); }, dayClicked(date) { console.log('Day clicked'); console.log(date.getDate()); }, timeClicked(dateWithTime) { console.log('Time clicked'); console.log('Date: ' + dateWithTime.date ); console.log('Time: ' + dateWithTime.time ); }, eventClicked(event) { console.log('Event clicked'); console.log(event); }, eventCreated(event) { console.log('Event created'); console.log(event); }, } } </script> </code></pre><h2 id="view-callbacks"><a href="#view-callbacks" aria-hidden="true" class="header-anchor">#</a> View callbacks</h2><table><thead><tr><th>Callback</th><th>Description</th><th>Payload</th></tr></thead><tbody><tr><td>month-changed</td><td>Emitted when the user goes from one month to another on the <code>month</code> view.</td><td><code>Date</code> object</td></tr><tr><td>week-changed</td><td>Emitted when the user goes from one week to another on the <code>week</code> view.</td><td><code>Date</code> object</td></tr><tr><td>day-changed</td><td>Emitted when the user goes from one day to another on the <code>day</code> view.</td><td><code>Date</code> object</td></tr><tr><td>view-changed</td><td>Emitted when the user switches views.</td><td>View name (<code>month</code>, <code>week</code>, <code>day</code>)</td></tr></tbody></table><h2 id="day-time-callbacks"><a href="#day-time-callbacks" aria-hidden="true" class="header-anchor">#</a> Day/Time callbacks</h2><table><thead><tr><th>Callback</th><th>Description</th><th>Payload</th></tr></thead><tbody><tr><td>day-clicked</td><td>Emitted when the user on a day on the <code>month</code> view.</td><td><code>Date</code> object</td></tr><tr><td>time-clicked</td><td>Emitted when the user on a time on the <code>week</code> and <code>day</code> views.</td><td><code>Object</code> containing <code>date</code> and <code>time</code></td></tr></tbody></table><h2 id="event-callbacks"><a href="#event-callbacks" aria-hidden="true" class="header-anchor">#</a> Event callbacks</h2><table><thead><tr><th>Callback</th><th>Description</th><th>Payload</th></tr></thead><tbody><tr><td>event-clicked</td><td>Emitted when the user clicks on an event on any view.</td><td><code>Event</code> object</td></tr><tr><td>event-created</td><td>Emitted when a new event is created using the Event dialog.</td><td><code>Object</code> containing <code>date</code> and <code>time</code></td></tr></tbody></table><div class="tip custom-block">TIPRemember that any event created using the dialog is automatically pushed to the <code>events</code> array. You don't need to do this yourself, the callback is there in case you need to perform more logic with new event.</div></div><div class="content edit-link"><a href="https://github.com/dapd007/v-calendar-scheduler/edit/master/docs/guide/callbacks.md" target="_blank" rel="noopener noreferrer">Edit this page</a><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></div><div class="content page-nav"> ← <a href="/guide/events.html" class="prev"> Event model </a><a href="/guide/customization.html"> Customization </a> → </div></div></div></div> <script src="/assets/js/7.529a46be.js" defer></script><script src="/assets/js/app.233d7366.js" defer></script> </body> </html>