Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fourlabsldn/fl-booking-js
https://github.com/fourlabsldn/fl-booking-js
Last synced: 5 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/fourlabsldn/fl-booking-js
- Owner: fourlabsldn
- Created: 2016-03-03T14:43:16.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2016-12-04T00:54:51.000Z (almost 8 years ago)
- Last Synced: 2024-10-10T15:02:55.302Z (about 1 month ago)
- Language: JavaScript
- Homepage: http://fourlabsldn.github.io/fl-booking-js/
- Size: 2.75 MB
- Stars: 8
- Watchers: 3
- Forks: 3
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# fl-booking-js
A simple and beautiful appointment widget. An adaptation of [booking-js](https://github.com/timekit-io/booking-js).
Check the [demo](http://fourlabsldn.github.io/fl-booking-js/examples/bookings.html) out.
## How to use it
Just call it like this:
``` javascript
flBooking({
targetEl: document.querySelector('.booking-target'),
autofillUser: 'James',
autofillEmail: '[email protected]',
timezone: {
timezone: 'Europe/London',
utc_offset: 0,
},
createBooking: data => { console.log(data); return Promise.resolve(data) }, // must return a promise
getEvents: data => ({
"data": [
{
"start": "2016-11-02T12:00:00.000Z",
"end": "2016-11-02T13:00:00.000Z"
}
]
}),
});
```
The events object must follow this type:
``` json
{
"data" : [{
"start": "2016-11-01T18:00:00.000Z",
"end": "2016-11-01T19:00:00.000Z"
}, {
"start": "2016-11-01T19:00:00.000Z",
"end": "2016-11-01T20:00:00.000Z"
}, {
"start": "2016-11-01T20:00:00.000Z",
"end": "2016-11-01T21:00:00.000Z"
}, {
"start": "2016-11-01T21:00:00.000Z",
"end": "2016-11-01T22:00:00.000Z"
}]
}
```
The `createBooking` must return a `Promise` that should succeed if the booking is made and fail if it isnt.
`createBooking` receives one argument, which is an object looking like this:
``` json
{
"event": {
"start": "2016-11-02T14:00:00+00:00",
"end": "2016-11-02T15:00:00+00:00",
"what": "Interview",
"where": "Online",
"description": "Comment: \n",
"calendar_id": "Interviews",
"participants": [
"[email protected]"
],
"invite": true,
"my_rsvp": "accepted",
"sync_provider": true
},
"customer": {
"name": "James",
"email": "[email protected]",
"timezone": "Europe/London",
"id": "XXXXXXX user id XXXXXXXX"
},
"graph": "confirm_decline",
"action": "create"
}
```
## Configuration
For more configuration options give a look at the [defaultConfig](./src/defaultConfig.js) file.
## Installation
**NPM**
```bash
npm install fl-booking-js --save
```