@squirkle-ui/calendar 0.1.0 → 0.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +22 -3
  2. package/package.json +4 -4
package/README.md CHANGED
@@ -1,15 +1,34 @@
1
1
  # @squirkle-ui/calendar
2
2
 
3
- Event calendar (month / week / day) for Squirkle UI.
3
+ Month / week / day calendar with events for [Squirkle UI](https://www.npmjs.com/package/squirkle-ui). Works with Vue 3 and Vue 2.7.
4
4
 
5
+ ## Install
5
6
  ```bash
6
7
  npm i @squirkle-ui/calendar @squirkle-ui/ui
7
8
  ```
9
+ Or get every component and add-on with [`squirkle-ui`](https://www.npmjs.com/package/squirkle-ui) and import from `squirkle-ui/calendar`.
10
+
11
+ Peer dependencies: `vue`, `@squirkle-ui/ui`. Set up `@squirkle-ui/ui` first (`app.use(createSquirkle())` and `@squirkle-ui/ui/styles.css`).
12
+
13
+ ## Usage
8
14
  ```ts
9
15
  import { SqCalendar } from '@squirkle-ui/calendar' // Vue 3
10
16
  // import { SqCalendar } from '@squirkle-ui/calendar/vue2' // Vue 2.7
11
17
  import '@squirkle-ui/calendar/styles.css'
12
18
  ```
13
- Peer dependencies: `vue`, `@squirkle-ui/ui`.
19
+ ```vue
20
+ <template>
21
+ <SqCalendar v-model="date" view="month" :events="events" editable />
22
+ </template>
23
+ <script setup lang="ts">
24
+ import { ref } from 'vue'
25
+ import { SqCalendar, type CalendarEvent } from '@squirkle-ui/calendar'
26
+ const date = ref(new Date())
27
+ const events: CalendarEvent[] = [{ id: 1, title: 'Launch', start: '2026-11-10T09:00', end: '2026-11-10T10:00' }]
28
+ </script>
29
+ ```
30
+ Key props: `view`, `views`, `events`, `firstDayOfWeek`, `editable`, `snap`, `hourHeight`. Events: `id`, `title`, `start`, `end`, `color`, `allDay`.
31
+
14
32
 
15
- Part of [Squirkle UI](https://github.com/KheangLov/squirkle-ui) · MIT License
33
+ ## License
34
+ MIT © KheangLov · [Source and issues](https://github.com/KheangLov/squirkle-ui)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@squirkle-ui/calendar",
3
- "version": "0.1.0",
3
+ "version": "0.1.2",
4
4
  "description": "Event calendar (month / week / day) for Squirkle UI",
5
5
  "license": "MIT",
6
6
  "repository": {
@@ -46,13 +46,13 @@
46
46
  },
47
47
  "peerDependencies": {
48
48
  "vue": "^2.7.0 || ^3.3.0",
49
- "@squirkle-ui/ui": "^0.1.0"
49
+ "@squirkle-ui/ui": "^0.1.1"
50
50
  },
51
51
  "dependencies": {
52
- "@squirkle-ui/core": "^0.1.0"
52
+ "@squirkle-ui/core": "^0.1.1"
53
53
  },
54
54
  "devDependencies": {
55
- "@squirkle-ui/ui": "^0.1.0"
55
+ "@squirkle-ui/ui": "^0.1.1"
56
56
  },
57
57
  "publishConfig": {
58
58
  "access": "public"