summaryrefslogtreecommitdiff
path: root/public/js/fullcalendar/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'public/js/fullcalendar/README.md')
-rw-r--r--public/js/fullcalendar/README.md73
1 files changed, 73 insertions, 0 deletions
diff --git a/public/js/fullcalendar/README.md b/public/js/fullcalendar/README.md
new file mode 100644
index 0000000..379e2c3
--- /dev/null
+++ b/public/js/fullcalendar/README.md
@@ -0,0 +1,73 @@
1# FullCalendar
2
3Full-sized drag & drop calendar in JavaScript
4
5- [Project Website](https://fullcalendar.io/)
6- [Documentation](https://fullcalendar.io/docs)
7- [Changelog](CHANGELOG.md)
8- [Support](https://fullcalendar.io/support)
9- [License](LICENSE.md)
10- [Roadmap](https://fullcalendar.io/roadmap)
11
12Connectors:
13
14- [React](https://github.com/fullcalendar/fullcalendar-react)
15- [Angular](https://github.com/fullcalendar/fullcalendar-angular)
16- [Vue 3](https://github.com/fullcalendar/fullcalendar-vue) |
17 [2](https://github.com/fullcalendar/fullcalendar-vue2)
18
19## Bundle
20
21The [FullCalendar Standard Bundle](bundle) is easier to install than individual plugins, though filesize will be larger. It works well with a CDN.
22
23## Installation
24
25Install the FullCalendar core package and any plugins you plan to use:
26
27```sh
28npm install @fullcalendar/core @fullcalendar/interaction @fullcalendar/daygrid
29```
30
31## Usage
32
33Instantiate a Calendar with plugins and options:
34
35```js
36import { Calendar } from '@fullcalendar/core'
37import interactionPlugin from '@fullcalendar/interaction'
38import dayGridPlugin from '@fullcalendar/daygrid'
39
40const calendarEl = document.getElementById('calendar')
41const calendar = new Calendar(calendarEl, {
42 plugins: [
43 interactionPlugin,
44 dayGridPlugin
45 ],
46 initialView: 'timeGridWeek',
47 editable: true,
48 events: [
49 { title: 'Meeting', start: new Date() }
50 ]
51})
52
53calendar.render()
54```
55
56## Development
57
58You must install this repo with [PNPM](https://pnpm.io/):
59
60```
61pnpm install
62```
63
64Available scripts (via `pnpm run <script>`):
65
66- `build` - build production-ready dist files
67- `dev` - build & watch development dist files
68- `test` - test headlessly
69- `test:dev` - test interactively
70- `lint`
71- `clean`
72
73[Info about contributing code &raquo;](CONTRIBUTING.md)